Volumedocs
Test helpers

Pay a test checkout by simulation

POST
/v1/test_helpers/checkout_sessions/{checkout_session_id}/pay

Test keys only. Once the payer has chosen a coin and network, a simulated payment arrives at the checkout's address at once and is accepted about ten seconds later, through the same path as a real one: the checkout's status, payment.confirmed, invoice.paid (with invoice.overpaid when over, or invoice.underpaid instead when short) and the merchant's balance all follow as they would live. exact sends what is still due, short a tenth less and over a tenth more, both past the tolerance (up to 1% or $0.50 short, whichever is smaller, still counts as paid). A Lightning invoice is paid exactly only. No money moves. A live key is refused with 403 test_mode_only.

Authorization

ApiKey
AuthorizationBearer <token>

A merchant API key, sent as Authorization: Bearer vk_live_…. The prefix selects the mode: vk_test_ for testnets, vk_live_ for real money.

In: header

Path Parameters

checkout_session_id*string

Header Parameters

Idempotency-Key*string

Makes the request safe to retry: the same key replays the first response instead of repeating the effect. At most 255 characters.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/test_helpers/checkout_sessions/string/pay" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "object": "checkout_session",  "id": "string",  "livemode": true,  "url": "http://example.com",  "status": "open",  "invoice": "string",  "customer": "string",  "customer_email": "string",  "amount": "string",  "currency": "usd",  "description": "string",  "payment": {    "source": "string",    "asset": "USDT",    "network": "tron",    "amount_due": "string",    "withdraw_amount": "string",    "rate": "string",    "expires_at": "2019-08-24T14:15:22Z"  },  "amount_received": "string",  "payments": [    {      "object": "payment",      "id": "string",      "checkout_session": "string",      "asset": "USDT",      "network": "tron",      "amount": "string",      "status": "detected",      "tx_hash": "string",      "detected_at": "2019-08-24T14:15:22Z",      "confirmed_at": "2019-08-24T14:15:22Z"    }  ],  "success_url": "string",  "cancel_url": "string",  "expires_at": "2019-08-24T14:15:22Z",  "paid_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}

Test helpers

Test mode only.