List external accounts
Lists your external accounts, newest first, in every status including deleted. There is no status filter. Filters match exactly and are case-sensitive, so send currencies in upper case. total_items is an estimate. Stop when a page has fewer items than items_per_page.
Query Parameters
The full customer ID
How the account is paid. bank_account and mobile_money are active at once. swift, sepa, ach_wire and fps need a setup step and start as pending.
Possible values: bank_account, mobile_money, swift, sepa, ach_wire, fps
Matches part of the holder name, account number or phone number
Your account that pays the external accounts
Responses
| Status | Description |
|---|---|
200 |
A page of external accounts |
400 |
Invalid request, an unknown ID or a failure. Read error. A not-found error is a 400 here, not a 404. |
200 response
Use it as the transfer destination
How the account is paid. bank_account and mobile_money are active at once. swift, sepa, ach_wire and fps need a setup step and start as pending.
Possible values: bank_account, mobile_money, swift, sepa, ach_wire, fps
Possible values: bank, mobile_money, swift, swift_intermediary
In upper case. It may be the name the bank holds.
The account holder's address. Required for swift, sepa, ach_wire and fps, and for some banks and payout corridors.
Checked against the country's postal code format
Alpha-2 code
Possible values: individual, business
pending while setup runs, then active (ready for transfers) or setup_failed (read error_message, then correct it with PATCH).
Possible values: pending, active, setup_failed, archived, deleted
Why setup failed
The national ID with only the last 4 characters shown
An estimate, except on the last page
400 response
Null, except for a duplicate, which returns the existing payee_id
What went wrong
Error code such as ERROR_CODE_DUPLICATE_PAYEE, when one is sent
{
"data": null,
"error": "payee 6a2f0c1e-93b4-4d0e-8f57-1c2b3d4e5f60: resource not found",
"code": "ERROR_CODE_NOT_FOUND"
}
Authorization
- ApiKeyAuth