Skip to main content
GET
Search payments

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer<int32>

Maximum number of payments returned per page. The default is 10 and the maximum is 100.

Required range: 1 <= x <= 100
nextPageToken
string

Cursor token for fetching the next page. Do not send it together with previousPageToken, and keep all filters identical to the request that returned the token.

previousPageToken
string

Cursor token for fetching the previous page. Do not send it together with nextPageToken, and keep all filters identical to the request that returned the token.

id
integer<int64>

Filter by payment identifier.

Example:

10300007

debtorBankCode
string

Filter by debtor agent BIC.

Example:

"LUNALT22XXX"

creditorBankCode
string

Filter by creditor agent BIC.

Example:

"NOVALT22XXX"

datetimeFrom
string<date-time>

Filter payments created at or after this UTC timestamp.

Example:

"2026-01-01T00:00:00Z"

datetimeTo
string<date-time>

Filter payments created at or before this UTC timestamp.

Example:

"2026-01-31T23:59:59Z"

settlementDateFrom
string<date>

Filter payments with a settlement date on or after this date.

Example:

"2026-01-01"

settlementDateTo
string<date>

Filter payments with a settlement date on or before this date.

Example:

"2026-01-31"

endToEndId
string

Filter by the end-to-end identifier assigned by the originator.

uetr
string<uuid>

Filter by exact UETR, independently of endToEndId.

metadata
string

Filter by an exact client-defined metadata value.

scheme
enum<string>[]

Filter by one or more payment schemes using the same values returned in the response scheme field.

Available options:
SEPA_CT,
SEPA_INST,
SEPA_DD,
SWIFT,
T2
direction
enum<string>

Filter by payment direction.

Available options:
OUTBOUND,
INBOUND
parentPaymentId
integer<int64>

Filter by parent payment identifier.

idOrParentPaymentId
integer<int64>

Filter by a payment identifier or its parent payment identifier.

type
enum<string>
deprecated

Filter by payment type using the same value returned in the response type field. Deprecated, use types instead.

Available options:
PAYMENT,
PAYMENT_CANCELLATION,
PAYMENT_RETURN,
REVERSE_PAYMENT,
CSM_FEES,
ADJUSTMENT
types
enum<string>[]

Filter by one or more payment types using repeated query parameters, for example types=PAYMENT&types=PAYMENT_RETURN. Values match the response type field. Combined with type when both are sent.

Available options:
PAYMENT,
PAYMENT_CANCELLATION,
PAYMENT_RETURN,
REVERSE_PAYMENT,
CSM_FEES,
ADJUSTMENT
statuses
enum<string>[]

Filter by one or more payment statuses using repeated query parameters, for example statuses=TO_SIGN&statuses=SIGNED. Values match the response status field.

Available options:
CREATED,
TO_SIGN,
SIGNED,
SENT_TO_CLEAR,
COMPLETED,
CANCELLED,
REJECTED,
ACCEPTED,
SOME_PROBLEMS,
PENDING_CONFIRMATION
currency
string

ISO 4217 currency used both as a filter and for interpreting all amount range parameters. Defaults to EUR when any amount range parameter is supplied.

Pattern: ^[A-Z]{3}$
Example:

"EUR"

amountFrom
integer

Minimum payment amount in minor units of currency, inclusive.

Example:

100

amountTo
integer

Maximum payment amount in minor units of currency, inclusive.

Example:

10000

unaccountedTaxAmountFrom
integer

Minimum unaccounted tax amount in minor units of currency, inclusive. The matching value is available as chargesAndAdjustments.unaccountedTax from GET /v3/payments/{id}.

unaccountedTaxAmountTo
integer

Maximum unaccounted tax amount in minor units of currency, inclusive. The matching value is available as chargesAndAdjustments.unaccountedTax from GET /v3/payments/{id}.

compensationAmountFrom
integer

Minimum compensation amount in minor units of currency, inclusive. The matching value is available as chargesAndAdjustments.compensation from GET /v3/payments/{id}.

compensationAmountTo
integer

Maximum compensation amount in minor units of currency, inclusive. The matching value is available as chargesAndAdjustments.compensation from GET /v3/payments/{id}.

debtorAccount
string

Filter by debtor account identifier.

creditorAccount
string

Filter by creditor account identifier.

excludePaymentReturns
boolean

Exclude payments that have an existing non-rejected payment return.

Response

Payments returned successfully

data
object[]
required

Payment list items matching the supplied filters, ordered by payment identifier descending.

meta
object
required

Cursor pagination metadata for navigating the result set.

Last modified on August 19, 2026