The Corridor object
The shape of a corridor wherever the API returns one.
Every endpoint that returns a corridor returns this shape, wrapped in a data envelope.
Attributes
country
string · always presentISO 3166-1 alpha-2.
name
string · always present—
currency
string · always presentWhat the beneficiary is paid in.
currency_decimals
integer · always presentAlways published, never assumed. It is NOT 2 everywhere: UGX has no subunit, so a client dividing every fiat figure by 100 would show a Ugandan payout as a hundredth of its size. XOF, XAF and RWF are the same trap.
min_amount
string · optionalSmallest payout we will quote, in this corridor's currency. Omitted when we enforce no floor; a corridor may still have one of its own, which surfaces as a rejection.
min_amount_minor
string · optional—
max_amount
string · optionalLargest payout we will quote. Omitted when unenforced. We do NOT split an over-limit payout into several - it is rejected, naming the ceiling.
max_amount_minor
string · optional—
methods
array of object · always presentHow money can reach someone in this corridor.
{
"country": "GH",
"name": "Ghana",
"currency": "GHS",
"currency_decimals": 2,
"min_amount": "1.00",
"min_amount_minor": "<min_amount_minor>",
"max_amount": "<max_amount>",
"max_amount_minor": "<max_amount_minor>",
"methods": []
}