Payments API ReferenceOrders

Get a list of orders

Retrieves a paginated list of orders for the specified merchant with optional filtering by status, type, date range, and currency.

Path parameters

merchantIdstringRequired
Merchant ID
organizationIdstringRequired
Organization ID

Headers

AuthorizationstringRequired

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

Query parameters

statusenumOptional
Filter by order status
Allowed values:
typeenumOptional
Filter by order type
startDatestringOptionalformat: "date-time"

Filter orders created on or after this date (ISO 8601 format)

endDatestringOptionalformat: "date-time"

Filter orders created on or before this date (ISO 8601 format)

currencyIdstringOptional
Filter by currency ID
pageSizedoubleOptionalDefaults to 10
Number of items per page
pageNumberdoubleOptionalDefaults to 1
Page number to retrieve
sortstringOptional

Sort order (e.g., “createdAt:desc”)

originAccountIdstringOptional
Filter orders by origin account ID. Cannot be combined with accountId parameter.
destinationAccountIdstringOptional
Filter orders by destination account ID. Cannot be combined with accountId parameter.
accountIdstringOptional
Filter orders where the account ID matches either the origin or destination account. This parameter is mutually exclusive with originAccountId and destinationAccountId.

Response

Orders retrieved successfully
paginationobject
orderslist of objects

Errors