List institutions
Lists the banks and mobile money operators an external account can name in institution_id. SWIFT banks appear only when you send institution_type=swift, swift_code or search. Filters match exactly, so send codes in upper case.
Query Parameters
Alpha-2 country code
Defaults to every type except swift_intermediary
Possible values: bank, mobile_money, swift, swift_intermediary
Possible values: bank_account_number, iban, phone_number, clabe
Find a SWIFT bank by its 8- or 11-character BIC
Find SWIFT banks by name or BIC, at least 3 characters
Responses
| Status | Description |
|---|---|
200 |
A page of institutions |
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 institution_id
For reference only, in major units. It is not enforced.
For reference only, in major units. It is not enforced.
Possible values: bank_account_number, iban, phone_number, clabe
SWIFT banks only
The bank's address. SWIFT banks only.
Bank fields to copy into a swift external account, such as bank_address_line_1 and bank_city. SWIFT banks only.
{
"data": {
"page": 1,
"items_per_page": 10,
"total_pages": 1,
"items": [
{
"id": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",
"name": "Example Mobile Money",
"country_iso_code": "KE",
"currency": "KES",
"min_amount": 1,
"max_amount": 10000,
"account_number_type": "phone_number"
}
],
"total_items": 1
},
"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