List payout requests

Your payout requests, newest first (the ones the credential's scope lets it read), paged. amount is a major-unit string.
Includes providerStatus, providerTransactionId, externalReference and verificationMethod (api_key for this API). The payee is carried by one customer object and by nothing else: a read has no top-level payee fields, beneficiaryId or customerReference.
A field the credential may not read (iban, accountNumber, routingNumber, swiftCode, customerReference, customerId) is absent from customer, and from providerPayloadRaw wherever the banking partner's reply carries it under its own spelling. providerPayloadRaw also has every fee_amount, fee_source, instructed_amount and amount_with_fee key removed at any depth.
Filtering by a withheld customerReference or customerId is 403 FIELD_EXCLUDED.
Unknown query names are refused with 400. Rate limit: 60 / minute nominally, 20 / minute in practice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 100
Defaults to 10

Page size. Default 10, maximum 100. Unknown query names are refused with 400.

integer
≥ 0
Defaults to 0
string
string
string
enum
Allowed:
string
string
string

Only payouts carrying exactly this customer reference. LEGACY_UNSET is a valid value.

string

Only payouts linked to exactly this customer id.

date-time
date-time
Headers
string

Optional; echoed so you can thread your logs with ours.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json