Skip to main content
SolvaPay Documentation home page
Docs
SDKs
API reference
Support
Get started
Get started
Search...
Navigation
Provider OAuth Clients
List OAuth clients for provider
Search...
⌘K
Health
GET
Basic health check
GET
Build info
GET
Detailed health check
File Downloads
GET
Download file
GET
Download MCP server avatar
GET
Download public hosted branding asset
Analytics
POST
Track analytics event
Notifications
GET
Get user notifications
POST
Post v1uinotifications
GET
Get notification statistics
GET
Get unread notification count
PUT
Put v1uinotificationsbulk
POST
Post v1uinotificationsbulk
POST
Post v1uinotificationsbroadcast
PUT
Put v1uinotifications
PUT
Put v1uinotifications archive
DEL
Delete v1uinotificationscleanup
Metrics
GET
Get Prometheus metrics
GET
Get metrics as JSON
Reference Data
GET
Get list of business activities
FX
GET
Get list of supported currencies
Provider
GET
Get provider information
PUT
Update provider settings
GET
Check whether Stripe can be disconnected
POST
Start onboarding and provision Stripe account
POST
Save provider data and start async verification
DEL
Delete a person from provider and sync to Stripe
PUT
Switch provider environment
DEL
Disconnect Stripe account
GET
Get the go-live checklist for this provider
POST
Switch provider to live mode (validates checklist)
POST
Reset provider onboarding state (development only)
GET
Get provider documents
POST
Post v1uiprovidersdocuments
POST
Post v1uiprovidersdocumentsanalyze
DEL
Delete a document
GET
List provider invitations
POST
Create user invitations
DEL
Revoke an invitation
PUT
Transfer provider ownership
PUT
Remove user from provider
PUT
Update user role
Admin - Providers
GET
Get all providers (Admin only)
POST
Create new provider (Admin only)
GET
Get provider by reference (Admin only)
PUT
Update provider (Admin only)
DEL
Delete provider (Admin only)
PUT
Update provider status (Admin only)
GET
Get provider users (Admin only)
GET
Get provider transactions (Admin only)
Secret Keys
GET
Get all secret keys
POST
Create secret key
GET
Check live eligibility
GET
Get secret key statistics
DEL
Delete secret key
GET
Reveal secret key
POST
Regenerate secret key
Admin - Users
GET
Get all users (Admin only)
POST
Create new user (Admin only)
GET
Get user statistics (Admin only)
GET
Get user by ID (Admin only)
PUT
Update user (Admin only)
DEL
Delete user (Admin only)
PUT
Update user status (Admin only)
GET
Get user provider (Admin only)
GET
Get user transactions (Admin only)
User Management
GET
Get current user profile
DEL
Delete user account
PUT
Update user
PUT
Update user preferences
POST
Request email change
POST
Verify email change with code
Payments
POST
Create a payment intent
GET
Get a payment intent by id
GET
Get a checkout session by sessionId (public)
GET
Get available plans for a checkout session (public)
POST
Select a plan for a checkout session and create payment intent (public)
POST
Select a topup amount for a checkout session and create payment intent (public)
POST
Reset selected plan for checkout session and cancel payment intent (public)
GET
Get a payment session by id or sessionId
POST
Create a checkout session for a customer
POST
Switch selected product for a customer session (public)
Customer Sessions
GET
Get customer session
POST
Create an upgrade checkout session
POST
Create a credit top-up checkout session
GET
Get eligible plans for selected product in customer session
POST
Create checkout session from selected customer-session plan
POST
Cancel renewal of a purchase
POST
Reactivate a cancelled purchase
Payment Intents
GET
List payment intents for the provider
POST
Create a payment intent
GET
Get a specific payment intent
POST
Process payment intent after client-side confirmation
Stripe
GET
Get account requirements for a provider
PUT
Update payout schedule for the authenticated provider
PUT
Update a connected Stripe account
GET
Get the connected account for the authenticated user
GET
Get account status for the authenticated user
POST
Create a payment intent for the authenticated provider
GET
Get payout settings for the authenticated provider
POST
Create a manual payout for the authenticated provider
GET
Get payout history for the authenticated provider
GET
Get payout history for a provider (admin)
POST
Create a Stripe account onboarding link
GET
Get account status for a provider
Stripe OAuth
POST
Create OAuth authorization URL
POST
Exchange authorization code
Checkout Sessions
POST
Create a checkout session
Provider Auth
POST
Sign up a new user
POST
Request a login code sent to email
POST
Verify a login code and receive JWT tokens
POST
Resend a login code (rate-limited)
POST
Initiate optional 2FA setup (requires JWT)
POST
Verify TOTP token to complete 2FA setup
POST
Logout user
POST
Verify email
POST
Resend verification code
GET
Get invitation details by token
POST
Accept user invitation
GET
Initiate Google OAuth login
GET
Google OAuth callback
POST
Create session from Google OAuth
GET
Initiate GitHub OAuth login
GET
GitHub OAuth callback
POST
Create session from GitHub OAuth
Provider MCP Auth
GET
MCP Google OAuth initiation
GET
MCP Google OAuth callback
POST
Create MCP session from Google OAuth
GET
MCP GitHub OAuth initiation
GET
MCP GitHub OAuth callback
POST
Create MCP session from GitHub OAuth
Customer OAuth Server
GET
Get public client info for branding
GET
OAuth 2.0 authorization endpoint
POST
OAuth 2.0 Dynamic Client Registration
POST
OAuth 2.0 token endpoint
GET
OpenID Connect userinfo endpoint
POST
Token revocation endpoint
Customer Auth
GET
OAuth login page (Redirects to Frontend)
POST
Handle OAuth login
GET
Initiate Google OAuth flow for Customers
GET
Google OAuth callback for backend-mediated flow
POST
Exchange Google code for session
GET
Initiate GitHub OAuth flow for Customers
GET
GitHub OAuth callback for backend-mediated flow
POST
Exchange GitHub code for session
POST
Request password reset
POST
Reset password with token
Operations Auth
GET
Operations Google OAuth initiation
GET
Operations Google OAuth callback
POST
Create operations session from Google OAuth
POST
Verify MFA for operations login
Provider OAuth Clients
GET
List OAuth clients for provider
POST
Create OAuth client
GET
Get OAuth client by reference
PUT
Update OAuth client
DEL
Delete OAuth client
GET
Reveal OAuth client secret
POST
Regenerate OAuth client secret
Provider MCP OAuth
GET
OAuth 2.0 Authorization Server Metadata (RFC 8414) for Provider MCP
POST
Dynamic Client Registration for Provider MCP (dashboard OAuth)
GET
Start Provider MCP OAuth authorization
POST
Bind authenticated provider user to Provider MCP OAuth session (after IdP login)
POST
Approve or deny MCP client access
GET
Hints for consent UI (client name, scopes)
POST
OAuth 2.0 token endpoint (access_token is the dashboard JWT)
CLI Init Auth
POST
Create SolvaPay CLI init session
POST
Complete SolvaPay CLI init session after browser auth
POST
Exchange completed init session for SolvaPay key
GET
Get init session status
Plans
GET
List plans for a product
POST
Create a plan for a product
GET
Get a plan for a product
PUT
Update a plan for a product
DEL
Delete a plan from a product
Products
GET
List products
POST
Create a product
GET
Get a product by reference
PUT
Update a product
DEL
Delete a product
POST
Bootstrap MCP product integration
PUT
Configure MCP plans on an MCP product
POST
Clone a product
GET
List products for dashboard
POST
Create a product
POST
Check product name availability
POST
Preview MCP bootstrap
POST
Bootstrap MCP product integration for UI
PUT
Configure MCP plans on an MCP product
GET
Get a product
PUT
Update a product
DEL
Delete a product
POST
Clone a product
GET
List plans for a product
POST
Create a plan within a product
PUT
Update a plan within a product
DEL
Delete a plan from a product
Usage Analytics
GET
List product usage events
GET
Get product usage stats
GET
Get usage summary for a purchase
GET
Get customer usage summaries
GET
Get product usage summaries
GET
Get provider usage statistics
Usage
POST
Record a usage event
POST
Record bulk usage events
Meters
GET
List all meters for the authenticated provider
GET
Get aggregated usage for a meter
Meter Events
POST
Record a meter event
POST
Record meter events in bulk
Transactions
GET
Get transaction history for Provider
GET
Get transaction statistics for Provider
POST
Refund a transaction
POST
Cancel a transaction
GET
Get specific transaction by ID
GET
Get all events for a specific transaction
Admin Transactions
GET
Get all transactions (admin only)
GET
Get system-wide transaction statistics (admin only)
GET
Get specific transaction by ID (admin only)
GET
Get balance for specific provider (admin only)
GET
Get balance history for specific provider (admin only)
GET
Get system-wide balance summary (admin only)
MCP Servers
GET
List MCP servers
POST
Create a new MCP server
GET
Get MCP server by ID
PUT
Update MCP server
DEL
Delete MCP server
POST
Check MCP domain availability
POST
Resolve bootstrap subdomain and availability
POST
Discover tools from MCP server
MCP Discovery
GET
OAuth Authorization Server Metadata
GET
OpenID Connect Discovery
GET
Non-hosted MCP discovery helper
GET
OAuth Protected Resource Metadata
MCP - Routing
GET
MCP request routing
UI - Purchases
GET
Get all purchases for provider
GET
Get a single purchase by ID or reference
POST
Cancel a purchase
POST
Reactivate a cancelled purchase
Purchases
GET
List purchases for provider
GET
Get purchases for a customer
GET
Get purchases for a product
GET
Get a purchase by reference
POST
Cancel a purchase
POST
Reactivate a cancelled purchase
Limits
POST
Check usage limits for a customer and product
Activation
POST
Post v1sdkactivate
Customers
GET
List customers
POST
Create a new customer
GET
Get customer statistics
GET
Get customer by ID
PUT
Update customer
DEL
Delete customer
GET
Get payment link details by reference (public endpoint)
POST
Process payment for a payment link (public endpoint)
GET
Get a customer session by sessionId
POST
Create a customer session for a customer
GET
Get customer by reference, externalRef, or email
POST
Create a new customer
GET
Get customer credit balance
GET
Get customer by reference
POST
Create a customer session
GET
Get customer session by sessionId
GET
Get current customer profile
User Info
POST
Get user info and purchase status
Admin Analytics
POST
Get list of available analytics queries
POST
Get parameter schema for a specific query
POST
Execute a single analytics query
POST
Execute multiple analytics queries in parallel
POST
Get system overview analytics data
POST
Validate parameters for a specific query
Provider Analytics
POST
Get list of available provider analytics queries
POST
Get parameter schema for a specific provider query
POST
Execute a single provider analytics query
POST
Execute multiple provider analytics queries in parallel
POST
Get provider analytics overview
POST
Validate parameters for a specific provider query
Credits
GET
Get customer credit balance
GET
Get all customer credit balances
GET
List credit ledger entries
GET
List credit ledger entries for a customer
ui:webhooks
GET
List webhook endpoints
POST
Create a webhook endpoint
PUT
Update a webhook endpoint
DEL
Delete a webhook endpoint
PATCH
Set webhook endpoint status (active/disabled)
POST
Send a test event to a webhook endpoint
GET
Reveal the signing secret for a webhook endpoint
GET
List recent webhook deliveries for debugging (owner/admin only, production-gated)
webhook_endpoints
GET
List webhook endpoints (API Key)
POST
Create a webhook endpoint (API Key)
PUT
Update webhook endpoint (API Key)
DEL
Delete webhook endpoint (API Key)
customer_webhooks
GET
List webhook endpoints (Customer)
POST
Create a webhook endpoint (Customer)
PUT
Update webhook endpoint (Customer)
DEL
Delete webhook endpoint (Customer)
Wallet
GET
Get wallet information for the authenticated user
GET
Get wallet statistics for the authenticated user
Accounts
GET
List accounts
GET
Get account by entity ID
GET
Get account statistics
UI Management
GET
Get current user theme mode
PUT
Update current user theme mode
GET
Get shared brand theme for all hosted pages
PUT
Update shared brand theme for all hosted pages
POST
Upload hosted-page logo
Form Configs
GET
Get form configuration
GET
Get wizard step sequence
Preregistrations
POST
Submit a preregistration from the get-started form
Financials
GET
Get revenue summary data
GET
Get balance & reconciliation data
GET
Get revenue by product
GET
Get general ledger entries
Super Admin
GET
Key business metrics (provider/customer/purchase counts, GMV, success rate)
GET
Items requiring operator attention
GET
Daily transaction volume and payment health (last 30 days)
GET
Platform growth charts (provider/customer growth, status breakdown)
GET
Recent audit log entries
GET
Search user and provider accounts
GET
Get full account details
PATCH
Update account status (suspend/reactivate)
POST
Generate a deletion confirmation token
POST
Soft-delete an account
POST
Hard-delete an account (requires confirmation token)
POST
Start an impersonation session for a user
POST
End an impersonation session
GET
View audit log
GET
Get Prometheus metrics as JSON
Super Admin - Preregistrations
GET
List preregistrations
PATCH
Update preregistration status
POST
Convert a preregistration to a provider account
Super Admin - Providers
GET
List all providers
GET
Get provider detail
GET
Get products for a provider
GET
Get customers for a provider
GET
Get purchases for a provider
GET
Get transactions for a provider
GET
Get users linked to a provider
GET
Get meters for a provider
GET
Get usage data grouped by meter for a provider
List OAuth clients for provider
cURL
curl
--request
GET
\
--url
https://api.example.com/v1/ui/oauth/clients
Provider OAuth Clients
List OAuth clients for provider
Copy page
Copy page
GET
/
v1
/
ui
/
oauth
/
clients
Try it
List OAuth clients for provider
cURL
curl
--request
GET
\
--url
https://api.example.com/v1/ui/oauth/clients
Response
200
List of OAuth clients
Verify MFA for operations login
Previous
Create OAuth client
Next
⌘I
Assistant
Responses are generated using AI and may contain mistakes.