Skip to main content
GET
List all payment orders

Authorizations

x-api-key
string
header
required

API key for authentication (required)

x-merchant-id
string
header
required

Merchant ID for identifying the merchant (required)

Query Parameters

customerId
string

Customer ID to filter payment orders (optional)

When true and customerId is provided, also includes orders from related customers linked via the sourceId chain. Defaults to false.

Available options:
true,
false
excludeOverdue
enum<string>

When true, only returns orders that are not overdue: due date unset or still in the future. Defaults to false (no due-date restriction).

Available options:
true,
false
status
string

Payment order status to filter by (optional)

dateFrom
string<date-time>

Start date for filtering payment orders by creation date (ISO 8601 format, optional)

dateTo
string<date-time>

End date for filtering payment orders by creation date (ISO 8601 format, optional)

Search term to filter payment orders by customer email, order number, invoice number, or merchant reference (case-insensitive, optional)

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Number of orders to return per page (max 100)

Required range: 1 <= x <= 100
sortField
enum<string>
default:createdAt

Sort field (e.g., createdAt)

Available options:
createdAt
sortOrder
enum<string>
default:desc

Sort order (ascending or descending)

Available options:
asc,
desc

Response

Payment orders retrieved successfully

data
object[]
required
pagination
object
required