List outbound payments

Retrieves a paginated list of outbound payments owned by every member of the caller's auth group. Draft payments, deleted payments and internal (Ibanq-to-Ibanq) transfers are not part of this resource and never appear. status is the API-facing vocabulary (Processing, Scheduled, AwaitingFunds, Sent, Rejected, Cancelled, Returned) — every in-house checking or holding state surfaces as Processing. status is Sent once the bank has confirmed the payment — for some providers on their own message, before the end-of-day reconciliation; until then an executed payment is Processing. amount carries amountInMinorUnits alongside the same figure as a decimal value, in the payment currency; the amountFrom/amountTo filters are minor-unit integers. createdFrom/createdTo are UK (Europe/London) business dates. Each row carries its owning client, and clientId narrows the list to one of them.

Query Params
string | null
enum

Filter to payments with this status: Processing, Scheduled, AwaitingFunds, Sent, Rejected, Cancelled, Returned

Allowed:
string | null

Optional; when present must name a member of the caller's group and scopes the results to that member alone

string | null

Filter to payments to this payee id

string | null

Filter to payments from this account id

string | null

Filter to payments in this currency

date | null

Filter to payments with a value date on or after this date

date | null

Filter to payments with a value date on or before this date

date | null

Filter to payments created on or after this date (UK business date)

date | null

Filter to payments created on or before this date (UK business date)

int64 | null

Filter to payments with an amount (in minor units) greater than or equal to this value

int64 | null

Filter to payments with an amount (in minor units) less than or equal to this value

int32

1-based page number (default 1, max 100000)

int32

Page size, 1-200 (default 50)

string
enum

Sort key: createdAt, valueDate, amount, currency (default createdAt)

Allowed:
string
enum

Sort direction: asc, desc (default desc)

Allowed:
Headers
string
required

Fresh RFC 9449 proof JWT (ES256) signed with the client's DPoP key, binding this request's method and URL to the access token; generate a new proof per request

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json