Skip to main content
POST
/
{version}
/
checkouts
/
create
Create Checkout Source
curl --request POST \
  --url https://api.example.com/{version}/checkouts/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "<string>",
  "source_kind": "<string>",
  "party_phone": "<string>",
  "currency": "<string>",
  "items": [
    {
      "name": "<string>",
      "currency": "<string>",
      "amount": 1.01
    }
  ],
  "party_name": "<string>",
  "party_email": "<string>",
  "party_relationship": "<string>",
  "reference_id": "<string>",
  "note": "<string>",
  "due_date": "2023-11-07T05:31:56Z",
  "success_url": "<string>",
  "cancel_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "counterparty_id": 123
}
'
{
  "mode": "<string>",
  "source_type": "<string>",
  "source_id": 123,
  "source_number": "<string>",
  "source_status": "<string>",
  "counterparty_id": 123,
  "party_id": 123,
  "currency": "<string>",
  "total_amount": 123,
  "source_checkout_config_id": 123,
  "url": "<string>",
  "reference_id": "<string>",
  "due_date": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "hosted_path_or_token": "<string>",
  "success_url": "<string>",
  "cancel_url": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

version
string
required
Allowed value: "v1"

Body

application/json
mode
string
required
source_kind
string
required
party_phone
string
required

E.164 digits only, without '+' (e.g. 231771234567)

Required string length: 8 - 15
Pattern: ^[1-9]\d{7,14}$
currency
string
required
items
PaymentSourceItemInput · object[]
required
party_name
string | null
party_email
string | null
party_relationship
string | null
reference_id
string | null
note
string | null
due_date
string<date-time> | null
success_url
string | null
cancel_url
string | null
expires_at
string<date-time> | null
counterparty_id

Response

Successful Response

mode
string
required
source_type
string
required
source_id
integer
required
source_number
string
required
source_status
string
required
counterparty_id
integer
required
party_id
integer
required
currency
string
required

Three-letter ISO-4217 currency code (e.g. USD, LRD, NGN)

Required string length: 3
total_amount
required

Amount

source_checkout_config_id
integer
required
url
string
required
reference_id
string | null
due_date
string<date-time> | null
expires_at
string<date-time> | null
hosted_path_or_token
string | null
success_url
string | null
cancel_url
string | null
Last modified on June 23, 2026