Get a checkout session

GET

/api/v1/checkout-sessions/{sessionId}

Checkout Sessions

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Header Params

Responses

🟢200OK

application/json

Session returned

Body

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v1/checkout-sessions/' \
--header 'x-business-id;' \
--header 'x-api-key: <api-key>'

Response Example

200 - sample

{
    "success": true,
    "data": {
        "sessionId": "sess_123",
        "amount": 500000,
        "currency": "NGN",
        "description": "Invoice #12345",
        "status": "PENDING",
        "paymentTolerance": 2,
        "fromCurrency": "USDT",
        "fromNetwork": "TRON",
        "refundAddress": "TXXXX...",
        "depositAddress": "TYYYY...",
        "expiresAt": "2025-01-01T12:30:00Z",
        "createdAt": "2025-01-01T12:00:00Z",
        "updatedAt": "2025-01-01T12:05:00Z",
        "transactions": [
            {
                "id": "trxn_123",
                "businessId": "biz_001",
                "customerName": "Jane Doe",
                "customerEmail": "jane@example.com",
                "walletAddress": "TYYYY...",
                "amount": 500000,
                "cryptoAmount": 750.12,
                "currency": "NGN",
                "cryptoCurrency": "USDT",
                "status": "PENDING",
                "payoutStatus": "PENDING",
                "transactionHash": null,
                "blockConfirmations": 0,
                "fees": 5000,
                "exchangeRate": 666.6,
                "invoiceId": "inv_001",
                "paymentLinkId": "pl_001",
                "createdAt": "2025-01-01T12:00:00Z",
                "updatedAt": "2025-01-01T12:05:00Z",
                "accountName": "KuvarPay LTD",
                "accountNumber": "0123456789",
                "actualAmount": 0,
                "addressSource": "generated",
                "bankCode": "999999",
                "callbackUrl": "https://merchant.test/webhook",
                "depositAddress": "TYYYY...",
                "description": "Payment for Order 12345",
                "estimatedUsdtAmount": 750.12,
                "expectedAmount": 750.12,
                "expiresAt": "2025-01-01T12:30:00Z",
                "externalId": "ext_001",
                "fromAmount": 750.12,
                "fromCurrency": "USDT",
                "fromNetwork": "TRON",
                "isMobileMoney": false,
                "notes": "",
                "paymentTolerance": 2,
                "redirectUrl": "https://merchant.test/thank-you",
                "reference": "RS-20250101-ABC123",
                "refundAddress": "TXXXX...",
                "refundAmount": 0,
                "refundTxHash": null,
                "toAmount": 500000,
                "toCurrency": "NGN",
                "toNetwork": null,
                "txHash": null,
                "type": "CHECKOUT",
                "walletReferenceId": "wref_001",
                "checkoutSessionId": "sess_123",
                "gateioOrderId": null,
                "usdValue": 750.12,
                "usdtAmount": 750.12,
                "riskFlags": [],
                "riskLevel": "LOW",
                "riskScore": 5,
                "depositTxHash": null,
                "settlementId": null
            }
        ]
    }
}

Modified at 2025-09-15 21:23:04

Create a checkout session (returns authToken for SSE)

Receive payment status webhook for session