1. Sandbox Simulator
KuvarPay API
  • Overview
  • SDK Integration Guide
  • Webhooks Integration Guide
  • Subscriptions Guide
  • Split Payment Guide
  • Transactions
    • Calculate Payment Amount
      POST
    • Create Transaction
      POST
    • Get Transactions Details
      GET
    • Get Transactions
      GET
    • Update Status
      PATCH
    • Get Transaction Status by Reference
      GET
    • Simulate payment for sandbox transactions
      POST
    • Get detailed payment status for a transaction
      GET
    • Manually trigger refund for excess payment
      POST
    • Get list of expired transactions
      GET
  • Checkout Sessions
    • Arm Checkout Session
      PATCH
    • Payment Status Webhook
      POST
    • Cleanup Expired Sessions
      POST
    • Create Checkout Session
      POST
    • Get Checkout Session
      GET
    • Update Checkout Session
      PATCH
  • Transfer Fees
    • Get Optimal Transfer Fee
    • Get Transfer Fee
    • Get all stored transfer fees from database
    • Update Transfer Fees
    • Get currencies supported for transfers
  • Sandbox Simulator
    • Start the sandbox transaction simulator
      POST
    • Stop the sandbox transaction simulator
      POST
    • Get Simulator Status
      GET
    • Force Simulator Scenario
      POST
    • Update simulator configuration
      PUT
    • Force Transaction Status
      POST
    • Get Pending Transactions
      GET
    • Reset Sandbox Transactions
      POST
  • Invoices
    • Create a new invoice
    • Send invoice email to customer
  • Payment Links
    • Create a new payment link
  • Server-Sent Events (SSE)
    • Get Transaction Details
    • Get Session Details
    • Get Health
  • Subscriptions
    • Create Plans
    • Get Plans
    • Get Plans Details
    • Update Plans Details
    • Create Prices
    • Get Prices
    • Update Prices Details
    • Create Checkout Sessions
    • Get Checkout Sessions Details
    • Confirm Subscription Checkout
    • Create Subscriptions
    • Get Subscriptions
    • Get Subscriptions Details
    • Update Subscriptions Details
    • Delete Subscriptions Details
    • Confirm Subscription Cancellation
    • Renew Subscription
    • Upgrade Subscription
    • Downgrade Subscription
    • Renew Subscription Authorization
    • Create Subscription Invoices
    • Get Subscription Invoices
    • Create Metered Invoices
    • Get Subscription Invoices Details
    • Charge Subscription Invoice
    • Get Charge Attempts
    • Create Authorizations
    • Revoke Relay Authorization
    • Get Relay Authorization Status
  • Currencies
    • Get Subscription Currencies
    • Get networks supported for subscription payments
    • Get Currencies
    • Get all supported networks
    • Get Item Details
    • Manually fetch currencies from ChangeNOW API
    • Get currency statistics
    • Get Supported Currencies
  • Subaccounts
    • Create Subaccount
    • List Subaccounts
    • Get Subaccount Details
    • Update Subaccount
    • Delete Subaccount
  • Split Group
  • Banks
    • List supported banks
    • Resolve bank account
    • List banks by currency
    • Verify account (Legacy)
  • Requirements
    • Create Verify Balance
  • Payment Fiat Rates
    • Get Item Details
    • Create Batch
    • Get Item Details
    • Get Currencies
    • Get Item Details
    • Get Fiat Rate Details
    • Get Fiat Rates
    • Create Update Ngn
    • Create Update All
    • Get Item Details
  • Split Payments
    • Create Split Group
    • List Split Groups
    • Get Split Group Details
    • Update Split Group
    • Delete Split Group
  • Schemas
    • ErrorResponse
    • CreateInvoiceRequest
    • CreatePaymentLinkRequest
    • InvoiceResponse
    • PaymentLinkResponse
    • CreateInvoiceResponse
    • CreatePaymentLinkResponse
    • SendInvoiceEmailRequest
    • SendInvoiceEmailResponse
    • SubscriptionInvoice
Home
Home
  1. Sandbox Simulator

Start the sandbox transaction simulator

POST
/api/v1/sandbox-simulator/start
Sandbox Simulator
Start the sandbox transaction simulator

Request

Authorization
API Key
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
API Key
Add parameter in header
X-Business-ID
Example:
X-Business-ID: ********************
or
Body Params application/json

Examples

Responses

🟢200
application/json
Default Response
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/sandbox-simulator/start' \
--header 'X-API-Key: <api-key>' \
--header 'X-Business-ID: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "config": {
        "checkInterval": 10,
        "minProgressTime": 1,
        "maxProgressTime": 5,
        "scenarios": {
            "NORMAL_SUCCESS": 0,
            "PARTIAL_PAYMENT": 0,
            "EXCESS_PAYMENT": 0,
            "FAILED_PAYMENT": 0,
            "NETWORK_DELAY": 0,
            "COMPLIANCE_HOLD": 0
        }
    }
}'
Response Response Example
{
    "success": true,
    "message": "string",
    "status": {}
}
Modified at 2026-04-14 01:46:40
Previous
Get currencies supported for transfers
Next
Stop the sandbox transaction simulator
Built with