Skip to main content
GET
/
{version}
/
orders
/
retrieve
/
number
/
{order_number}
Retrieve Order By Number
curl --request GET \
  --url https://api.example.com/{version}/orders/retrieve/number/{order_number} \
  --header 'Authorization: Bearer <token>'
{
  "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",
  "order_items": [
    {
      "id": 123,
      "name": "<string>",
      "currency": "<string>",
      "qty": 123,
      "amount": 1.01,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "counterparty": {
    "id": 123,
    "owner_party_type": "<string>",
    "owner_party_id": 123,
    "relationship_type": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "party": {
      "id": 123,
      "fullname": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "phone": "<string>",
      "country_code": "<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"
order_number
string
required

Response

Successful Response

OrderDetailResponse

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
order_items
OrderItemResponse · object[] | null
counterparty
CounterPartyWithPartyResponse · object

CounterPartyWithPartyResponse

Last modified on June 23, 2026