List payment orders

limit

integer

0 to 100

Defaults to 25

starting_after

uuid

The ID of the object from which your list request will start. It is not included in the result.

sort_order

string

enum

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

Allowed:

start_date

date

The creation date of the payment order.

end_date

date

The creation date of the payment order.

connected_account_id

uuid

The ID of the connected account used to trigger the payment order.

type

string

enum

The type of the payment order.

direction

string

enum

The direction of the payment order.

Allowed:

status

string

enum

The status of the payment order.

start_value_date

date

The value date of the payment order.

end_value_date

date

The value date of the payment order.

amount_from

integer

≥ 0

The amount of the payment order.

amount_to

integer

≥ 0

The amount of the payment order.

currency

string

The ISO 4217 currency code of the payment order.

mandate_reference

string

length ≤ 35

The reference of the direct debit mandate.

reconciliation_status

string

enum

The reconciliation status of the payment order.

Allowed:

file_id

uuid

The ID of the file including the payment order.

idempotency_key

string

The idempotency key of the payment order.

auto_approval

boolean

If true, only payment orders which were automatically approved will be fetched.

counterparty_id

uuid

deprecated

The ID of the counterparty of the payment order.

counterparty_account_id

uuid

deprecated

The ID of the counterparty account receiving the payment order.

account_holder_id

uuid

The ID of the account holder receiving the payment order.

external_account_id

uuid

The ID of the external account receiving the payment order.

aggregation_reference

string

length ≤ 140

The aggregation reference of the payment order.

direct_debit_mandate_id

uuid

The ID of the payment order's direct debit mandate.

retry_details.original_payment_id

uuid

The ID of the original payment order that led to the current object through a chain of retries.

uetr

uuid

Unique End-to-end Transaction Reference (UETR). Can be used to track payments with Swift GPI.

custom_fields.key

string

The key of a custom field's value. You can pass multiple keys and multiple values, for instance custom_fields.k1=a&custom_fields.k1=b&custom_fields.k2=c.

cbs_data.transaction_id

string

The ID of the transaction (transaction_id) in CBS Data (cbs_data).

validation.type

string

enum

The type of payment validation.

Allowed:

validation.status

string

enum

The status of payment validation.

Allowed:

200200

400Validation error.