List merchant orders with filtering

get

https://sandbox.gateway.orbipayments.com/v1/orders

Retrieve a paginated list of orders with optional filtering by status, currency, date range, and external reference ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

number

Defaults to 1

Page number for pagination (1-based indexing).

Determines which page of results to retrieve. Must be a positive
integer between 1 and 1000 to prevent excessive pagination.

limit

number

Defaults to 10

Number of items per page.

Controls how many order records are returned in a single response.
Limited to a maximum of 100 items to ensure reasonable response sizes
and optimal API performance.

sort

string

enum

Defaults to desc

Sort order for the returned order list.

Determines whether orders are sorted by creation date in ascending
or descending order. Defaults to descending (newest first).

Allowed:

from_date

string

Start date for filtering orders by creation time.

Only orders created on or after this date will be included
in the results. Must be in ISO 8601 format with timezone information.

to_date

string

End date for filtering orders by creation time.

Only orders created before or on this date will be included
in the results. Must be in ISO 8601 format with timezone information.

status

string

enum

Filter orders by their current processing status.

Allows filtering orders based on payment and processing state,
such as pending payment, paid, expired, or canceled orders.

external_reference_id

string

Filter by merchant's external reference identifier.

Searches for orders using the merchant's own reference ID system,
enabling integration with external order management systems.

currency

string

enum

Filter orders by payment currency.

Restricts results to orders that accept payments in a specific
currency. Useful for currency-specific reporting and management.

Allowed:

Response

200

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here!