KuvarPay API
Home
Home
Go to Dashboard
Schemas
Copy Page
Overview
SDK Integration Guide
Webhooks Integration Guide
Subscriptions Guide
Transactions
Calculate required crypto amount for a fiat target
Create a new fiat transaction
Get transaction by ID
List transactions
Public transaction status by reference
Demo pay (sandbox/testing)
Checkout Sessions
Create a checkout session (returns authToken for SSE)
Get a checkout session
Receive payment status webhook for session
SSE
Subscribe to transaction updates (SSE)
Subscribe to session updates (SSE)
Currencies
List supported currencies
Sandbox
Simulate sandbox error scenarios for a transaction
Deliver a test webhook to a URL
List available sandbox error scenarios
Get sandbox environment info
Reset all sandbox data for your business (destructive)
Sandbox Simulator
Start the sandbox transaction simulator
Stop the sandbox transaction simulator
Get current status of the sandbox transaction simulator
Update simulator configuration
Force execute a specific scenario for a transaction (testing only)
Force execute a specific scenario for a transaction (URL param)
List pending sandbox transactions available for simulation
Reset sandbox transactions to PENDING for testing
Invoices
Create a new invoice
Send invoice email to customer
Payment Links
Create a new payment link
Subscriptions
Create subscription checkout session
Get a subscription checkout session by UID
Confirm subscription checkout session
Get stablecoin currencies supported for subscriptions
Submit relay authorization for subscription
Create a new subscription
Get a subscription by UID
Get relay authorization status for a subscription
Update a subscription
Cancel a subscription
Create a new subscription plan
List subscription plans
Get a subscription plan by UID
Update a subscription plan
Create a price for a subscription plan
Get prices for a subscription plan
Update a subscription price
Create a subscription invoice
List subscription invoices
Create a metered subscription invoice
Get a subscription invoice by UID
Charge a subscription invoice
Get charge attempts for an invoice
Payment Fiat Rates
Get fiat rate for a specific currency
Get multiple fiat rates
Update NGN rate from CryptoCompare
Update all supported fiat rates
Get Flutterwave transfer rates (debug/testing)
List supported bank transfer and mobile money currencies
Clear the fiat rates cache
Get cache statistics
Transfer Fees
Get transfer fee for a specific amount and currency
Get optimal transfer fee (bank vs mobile money)
Get all stored transfer fees
Manually update transfer fees from Flutterwave
Get currencies supported for transfers
Schemas
Schemas
CalculatePaymentRequest
CalculatePaymentResponse
CreateTransactionRequest
Transaction
CreateTransactionResponse
CheckoutSessionCreateRequest
CheckoutSession
CheckoutSessionDetails
CheckoutSessionGetResponse
PaymentStatusWebhookPayload
SimpleAck
ErrorResponse
CurrenciesResponse
SandboxDeliveryResult
SandboxSimulateErrorRequest
SandboxSimulateErrorResponse
SandboxTestWebhookRequest
SandboxTestWebhookResponse
SandboxErrorScenariosResponse
SandboxInfoResponse
SandboxResetRequest
SandboxResetResponse
CreateInvoiceRequest
CreateSubscriptionCheckoutSessionRequest
InvoiceResponse
CreateSubscriptionCheckoutSessionResponse
CreateInvoiceResponse
ConfirmSubscriptionCheckoutSessionRequest
SendInvoiceEmailRequest
ConfirmSubscriptionCheckoutSessionResponse
SendInvoiceEmailResponse
SubscriptionCurrency
CreatePaymentLinkRequest
SubscriptionCurrenciesResponse
PaymentLinkResponse
CreatePaymentLinkResponse
CreateSubscriptionRequest
Subscription
UpdateSubscriptionRequest
SubscriptionResponse
CreatePlanRequest
UpdatePlanRequest
SubscriptionPlan
CreatePriceRequest
UpdatePriceRequest
SubscriptionPrice
PlanResponse
PlansListResponse
PriceResponse
PricesListResponse
SubscriptionInvoice
ChargeInvoiceRequest
ChargeAttempt
InvoicesListResponse
ChargeResponse
ChargeAttemptsListResponse
SubscriptionCheckoutSession
SubscriptionCheckoutSessionResponse
Schemas
Copy Page
SandboxSimulateErrorRequest
{
"transactionId"
:
"string"
,
"scenarioType"
:
"PAYMENT_FAILED"
,
"businessId"
:
"string"
}