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 presentDecimal places of currency. Not always 2: UGX, RWF and XOF have none.
min_amount
string · optionalSmallest payout, in the corridor currency. Omitted when there is none.
min_amount_minor
string · optional—
max_amount
string · optionalLargest payout. Larger payouts are refused, not split. Omitted when there is none.
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": []
}