List internal payments

Retrieves a paginated list of internal payments (own-account transfers) owned by every member of the caller's auth group. status reports where the transfer is in its lifecycle (Completed, Created, Failed). channel reports how the transfer was instructed (Portal, Api or Brokered); transfers created before the channel was recorded have no channel. createdBy is returned for Portal and Api transfers only. amount carries amountInMinorUnits alongside the same figure as a decimal value, in the transfer currency; the amountFrom/amountTo filters are minor-unit integers. createdFrom/createdTo are UK (Europe/London) business dates. The list spans every member of the caller's auth group and their active direct sub-accounts; clientId narrows it to the transfers that client instructed or whose debiting or crediting account it owns.

Query Params
string | null

Optional; when present must name a member of the caller's group and scopes the results to the transfers that member instructed or is a side of

string | null

Filter to transfers debiting this account id

string | null

Filter to transfers crediting this account id

string | null

Filter to transfers in this currency

string | null
enum

Filter to transfers with this status: Completed, Created, Failed

Allowed:
string | null
enum

Filter to transfers instructed through this channel: Portal, Api, Brokered

Allowed:
string | null

Filter to transfers with exactly this internal reference

date | null

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

date | null

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

int64 | null

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

int64 | null

Filter to transfers 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, 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