Get an external account
Returns one external account. After a 202, poll every 30 to 60 seconds until status is active (ready for transfers) or setup_failed (read error_message, then correct the account with PATCH). Not-found is a 400.
Path Parameters
ID of the external account
Responses
| Status | Description |
|---|---|
200 |
The external account |
400 |
Invalid request, an unknown ID or a failure. Read error. A not-found error is a 400 here, not a 404. |
200 response
An external account. Empty fields are left out.
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
{
"data": {
"id": "6a2f0c1e-93b4-4d0e-8f57-1c2b3d4e5f60",
"payee_type": "swift",
"account_number": "12345678",
"institution_id": "1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b",
"institution_type": "swift",
"institution_name": "Example Bank",
"account_name": "ACME TRADING LTD",
"bic": "MIDLGB22",
"customer_id": "3130ca8b-8b32-4843-8623-bf83e766b86a",
"currency": "USD",
"institution_country_iso_code": "GB",
"account_owner_type": "business",
"status": "setup_failed",
"date_created": "2026-10-12T09:15:22.481Z",
"error_message": "these account details could not be accepted"
},
"error": null
}
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