Create a checkout session (returns authToken for SSE)

POST

/api/v1/checkout-sessions

Checkout Sessions

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Session created

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/checkout-sessions' \
--header 'x-business-id;' \
--header 'Idempotency-Key;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "toCurrency": "NGN",
    "toAmount": 500000,
    "customerEmail": "user@example.com",
    "customerName": "string",
    "metadata": {}
}'

Response Example

{
    "success": true,
    "data": {
        "id": "sess_123",
        "status": "created",
        "authToken": "eyJhbGciOi...",
        "toCurrency": "NGN",
        "toAmount": 500000,
        "createdAt": "2025-01-01T12:00:00Z",
        "updatedAt": "2025-01-01T12:00:00Z"
    }
}

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

Demo pay (sandbox/testing)

Get a checkout session