Skip to main content
GET
List payments

Authorizations

x-api-key
string
header
required

API key for service-to-service or merchant authentication.

Headers

x-correlation-id
string<uuid>

Unique identifier for request tracing. Generated by the client or server if not provided.

Example:

"550e8400-e29b-41d4-a716-446655440000"

x-business-account-id
string<uuid>

The business account to act on, for platform use cases. When sent, that account is the merchant for the request: resources are created under it, reads and 404 checks are scoped to it, and per-merchant uniqueness (such as merchant_reference_id) applies within it. The API key's own account is recorded as the account acting on its behalf. Omit it to act on the API key's own account.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Query Parameters

page
integer
default:1

Page number

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

Number of items per page

Required range: 1 <= x <= 100
include
enum<string>[]

Comma-separated list of related resources to include

Available options:
instrument,
operations
status

Filter by payment status Payment has been created and queued for processing

Allowed value: "CREATED"
from_date
string<date-time>

Start date filter (ISO 8601)

to_date
string<date-time>

End date filter (ISO 8601)

payment_method

Filter by payment method Credit or debit card payment

Allowed value: "CARD"

Response

Paginated list of payments.

data
object[]
required

List of payments

pagination_data
object
required