Skip to main content
POST
/
{version}
/
orders
/
create
Create Order
curl --request POST \
  --url https://api.example.com/{version}/orders/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "counterparty_id": 123,
  "currency": "<string>",
  "note": "<string>",
  "fee_bearer": "<string>",
  "as_payment_link": true,
  "reference_id": "<string>"
}
'
{
  "id": 123,
  "order_number": "<string>",
  "counterparty_id": 123,
  "currency": "<string>",
  "total_amount": 123,
  "note": "<string>",
  "status": "<string>",
  "fee_bearer": "<string>",
  "as_payment_link": true,
  "owner_id": 123,
  "owner_type": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "reference_id": "<string>",
  "paid_at": "2023-11-07T05:31:56Z"
}

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

CreateOrderPayload

counterparty_id
integer
required
currency
string
required

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

Required string length: 3
note
string
required
fee_bearer
string
required
reference_id
string | null

Response

Successful Response

OrderResponse

id
integer
required
order_number
string
required
counterparty_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

note
string
required
status
string
required
fee_bearer
string
required
owner_id
integer
required
owner_type
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
reference_id
string | null
paid_at
string<date-time> | null
Last modified on June 23, 2026