Skip to main content
GET
List payment orders
Returns a page of payment orders for the given wallet. Supports filtering, ordering, and cursor-based pagination — see Pagination and Filtering. Filterable fields: id (string), direction (enum), status (enum), network (enum), createdAt (timestamp). Orderable fields: createdAt.

Common queries

For daily reconciliation, use order_by=createdAt%20desc and iterate until nextPageToken is null. See the Pagination concepts page for the “iterate until null” pattern.

Authorizations

X-Access-Key
string
header
required

Opaque credential identifier provisioned during onboarding. See the Integration Guide for the request-signing protocol.

X-Access-Timestamp
string
header
required

Unix epoch timestamp in UTC milliseconds. See the Integration Guide for skew tolerance.

X-Access-Request-Id
string
header
required

Unique identifier per request (UUID v4 recommended). The (accessKey, requestId) tuple must be unique within the replay window defined by the Integration Guide.

X-Access-Signature
string
header
required

Base64-encoded ECDSA signature of the canonical request, computed with the private key paired to X-Access-Key. See the Integration Guide for canonicalization rules and reference implementations.

Path Parameters

wallet
string
required

Wallet name (RFC 1035 DNS label).

Required string length: 1 - 63
Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Query Parameters

filter
string

SFS-1 filter expression. See the SFS-1 specification for syntax. Allowed fields are listed per endpoint.

Maximum string length: 1024
order_by
string

Result ordering. See List Query Parameters for syntax. Allowed fields are listed per endpoint.

page_size
integer
default:100

Maximum items per page. Values above 1000 are silently truncated to 1000; negative or non-integer values return INVALID_PAGE_SIZE.

Required range: 1 <= x <= 1000
page_token
string

Opaque pagination token returned as nextPageToken by a previous list response. Tokens are bound to the original query context and may expire; treat as opaque.

Response

A page of payment orders.

A single page of payment orders with an opaque continuation token.

items
object[]
required

The payment orders in this page, in the requested order.

nextPageToken
string | null
required

Opaque token for the next page; null when the result set is exhausted. Pass back as page_token to retrieve the next page.

Example:

"spct1.eyJ2IjoxLCJleHAiOjE3MzY1NTM2MDB9.aBcDeFgHiJkLmNoPqRsTuVwXyZ"