For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get orders

[GET] /api/v2/orders

Lists your orders with cursor pagination and optional filters.

Request query params type:

How the filters behave:

  • limit is the only required param, and must be between 1 and 100.

  • status, depositPaymentChannel, depositCurrencyType, payoutPaymentChannel and payoutCurrencyType each accept one value or several. Repeat the param to pass a list: ?status=payout_successful&status=payout_failed.

  • fromDate and toDate are unix timestamps in milliseconds. fromDate must not be later than toDate.

  • Phone numbers are normalised before matching, so any format that resolves to the same number works.

  • Every filter is scoped to your own orders — there is no way to read another merchant's.

Request URL example:

Response

Each entry of list is the same Order object Get order returns, field for field — that page has the full type and a complete example.

Polling this endpoint is not the way to track a live order. Use the webhook for status changes, and keep this for reconciliation and back-office views.

Response example, trimmed to show the envelope and the fields that differ between two sandbox orders:

The second entry is abbreviated to the fields that differ — a real response repeats the whole object for every order.

Last updated