List customers

Active customers for this merchant, oldest first, paged. Needs the read Beneficiary permission (shown as Customer). A scoped credential sees the customers its rules allow, without the fields they withhold (iban, accountNumber, routingNumber, swiftCode, bankName, customerReference); a withheld field is absent, not null.
A customer reads customerReference exactly as stored (null or LEGACY_UNSET mean it is unbound), source, createdVia, payable and missingFields. A deposit declaration or an incoming payment from an IBAN with no customer of yours adds one, which reads payable: false until completed. A swift customer with no SWIFT code is not payable either: missingFields names swiftCode, and adding one with PATCH completes it.
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
string

Exactly this customer reference. Refused with 403 FIELD_EXCLUDED when the credential has customerReference withheld.

string

Customers held in this currency, in any letter case

string
enum
Allowed:
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
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