List fiat payment methods

Lists the bank and mobile-money methods available for a corridor. Public — no API key
required, though an authenticated call refines the result (see audience and
sandbox mode below).

Returns opaque methodId values, which are the ids to pass to
/api/v1/transactions/create (fiat collections) and to /api/v1/fiat/sends and
/api/v1/fiat/resolve-recipient (payouts). Provider names are never exposed and a
methodId is not portable between live and sandbox.

SDK: this is sdk.getBanks({ country | currency, type, direction }). Note the SDK
defaults direction to inbound (the checkout "pay with" picker). If you are
listing payout destinations you must pass direction: 'outbound' explicitly, or you
will get collection methods back.

Pair this endpoint with resolveRecipient, not resolveBankAccount. The
methodId returned here is accepted by sdk.resolveRecipient /
POST /api/v1/fiat/resolve-recipient. It is not a bank_code, so the SDK's
deprecated resolveBankAccount will not resolve it.

Identify the corridor with either country (ISO-3166 alpha-2) or currency
(ISO-4217) — at least one is required. A currency is resolved to its corridor country
server-side; when both are given, currency additionally filters the result.

direction matters. It defaults to outbound. Use direction=outbound to list
payout destinations and direction=inbound to list funding methods; the two lists
differ per corridor. On inbound, only the rail that corridor actually collects on is
returned (for example NG/GH/ZA collect on bank, KE/RW/UG on mobile money), so asking
for a type that corridor cannot collect on returns an empty list rather than a
method that would dead-end.

Live vs sandbox — set this explicitly. Sandbox methods are returned only when
?sandbox=true is set or the x-sandbox: true header is sent. This endpoint is
public and does not authenticate, so it cannot infer sandbox mode from your API
key — omitting the flag always returns the LIVE list.

The two are separate methodId spaces (the same bank has a different id in each, and
the sandbox list is much smaller). Downstream calls do take the mode from your key,
so a sandbox key that was handed a live methodId fails at
/api/v1/fiat/resolve-recipient and /api/v1/fiat/sends with
reason: METHOD_MODE_MISMATCH. Always fetch the list in the same mode your key
operates in.

Methods are filtered to the provider that will actually route the corridor, and
de-duplicated by name — so the same bank is listed once.

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

API Key

Add parameter in header

X-Business-ID

Example:

X-Business-ID: ********************

curl --location '/api/v1/fiat/banks?country=undefined&currency=undefined&type=undefined&direction=undefined&audience=undefined&sandbox=undefined' \ --header 'X-API-Key: <api-key>' \ --header 'X-Business-ID: <api-key>'

{ "methods": [ { "methodId": "string", "name": "string", "currency": "string", "type": "bank", "manualInput": true, "minAmount": 0, "maxAmount": 0 } ] }

List fiat payment methods

Request

Responses