'/%3e%3cdefs%3e%3cpattern%20id='pattern0_2104_4598'%20patternContentUnits='objectBoundingBox'%20width='1'%20height='1'%3e%3cuse%20xlink:href='%23image0_2104_4598'%20transform='matrix(0.00376176%200%200%200.0172414%20-0.00219436%200)'/%3e%3c/pattern%3e%3cimage%20id='image0_2104_4598'%20width='267'%20height='58'%20preserveAspectRatio='none'%20xlink:href='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQsAAAA6CAMAAACQ2ozcAAAAM1BMVEVMaXH////////////////////////////////////////////////////////////////x7/yuAAAAEHRSTlMAoDDgEPBgwIBAINCwkHBQDIOTDwAAAAlwSFlzAAFxGAABcRgB7MGwCAAABm1JREFUaIHlW+uWsyoMLSIIeH3/pz0CKrmgQuusdn0nf2YaMW42kISgr1cQK+SySj+61/9cmm45RLTfRvNV0WoBIptv4/mi6AWLuiVDd0lKmLPGGPsA0nelGG8TZoXU69poTPi/v1smBjB338dZxvk218B/VIrxBl8hth9t73+Zp2x7SdNuLMX+tJTitZCKjQx1MzFquLBVc+hvpBSv8NMX/Hb+Bv2MbS8DaNsVYn9aSvFK2nWB5slHtr0sUL4Ur0vx+usowdL3A1jBhUVcfGmR1HCBFPbvuWhskvuefC4/wkWbWyMgzV2ub39GarhA+cf0KBevHrTdffSvcuGxonzCA73JBGq4gFnt7qN/lYtxwflEWOA3KWJVriWOpkd0+lUuQj6Rsu6QkcuL9jW2o4xbyzTZfpWLOG79FlatgnP5Y9tRnFn3RAYE7p/loo1bJ6GtnSLIYbuwRrz8rq6SCyY/y8W2UU0SFkw7xQCghszN/y4Xr0ZCKjpPxQz46Vjdj9pupiHUBsxclmRXcOG0CKZHfVV9dHqM1QmRrZNU4IVN15kwQ98fNHSlYNsaUsmmEUw899gNuQCck2ur17KwZXcypM6gsVSCtSN4YcozzLmWqtvbNCPRUDKgbU07RiC/z8XgmOnMtHNiYUJZu8Tbg8YW3B6HOK6PwRPQRo1sT21nBGVq73OxKNaElx8n3iiAR4CL8YbOHlH0YHnXtAL2osg2Gr8PuMgIIaPNTIooqIJdijfkyFO6b6u9gBTDo1M1PKOK6bNcYCBtf9Gwqcc7LHgr1qqFaHil69Y2KAY9zMWe/Ny3BWSU4vVdZ3UtvCHxGuQD7m2nmfY0FyBBGK8bJidXitf/gxbA7DVQwStdBbbVng48zsUxMexdy7EWr/8H9dw/QjJNLRfHKnmci2Pk5G1LW4nX/2U9x5p5eYOLvYj6PBfb+qXHfacWy/H6P6yuhavBfl1Cl0VtK7MaaGcS30wZF6ny2WS4kD71ttjyZgXHEDk5j4Ew2dTh9SbREYCEqA/NBBXY9pHX4E2eLOPiRQT1RsDAv0sc7QZhOHowIwxjHd4wDcDEmCJ1jmjQREG2werBxt3HXKRIwE+cEAYwmMijygze/hxvrq6FNJp0mNp2Zxf0x1ykWD8zLmA7lIChqe+u8U4Eb2goLbjYSaCJdnDqC20jR4JOAMzHXADYjAs4pCj5QYvH3uCFVjy66IR6Y8zoSfDlPr1rhEKdyHCB64GwJ8PHXAA144L3eBcYaw3DixwfW3skqw+GcUpHj1fP60TwSveXXKDRP7fAubjBi2bKwnrAT5p/gAsEEFuA41jNBQ60YZEip8Lq4r/NBexOLRfbvX0XfGZY5i5uVjcNOzs6tz0S23/GhYNctKcWKrmI4Sq+2BlebpRm9FSY8IRYcVTndS3si6DrEX/JBfKdeKjgitcMLw4DxNf7oVcHW/viSLt/kfqV46KHF9BofR5Tr7iA0QKhg6lIJqZe4Q3hExAroJEgIe6c17XgpEOeZy7ighatS7mA0RDlTyiJr8Obr2sJqjmva4H1g7eObREXNEiVcoGeBWqKuXy7FG9kBEhwfyjPZG9wkQOVfJlgS/Bu9+wbyy5z7YoLNL2XfgNMisFTBd6+qH5xW9fqjbV6JLUVfc4FzuS6yVoz3Lyzw7jAi2SlfrWiBTkhaOvwZrnomaa6lrNPxRwX2ft1JRe3Jb40mUvxkmc+Vtcy0NyFjgIv5oJOjEz39nVXitf/Rb6c+4txufQXWTkqpjkuXrnDLlnLhcsfmSU5Up9SvP7ZvK7F4shFXSsrB5lZLrLHXbzGd80FziS4pN15Kd6QXIGJYUhftolyXtfKSgrBWS5c7p6plguyayJyFmcv8IZRT1nmHnKJ5jzvzAoormS5yFoYqrm4AgI//LjFu3cvkKvioLQp2qlIlQseSuEXQYDt7JqFiVmei+wqqeeCfBIFewcT5XK80R+rwZgNx/F60qEhm3Zgu+HHuxK54hMucmTYei5e7B2NCD37hknAy9tDvPS0WjDNef1iTUQMploZvKc942L/3Aj0sXmDi9UOGw0KoQovzAPD2miRhr35mr7fCo3BO0K9pq/ONOBbL03NpIfIcXNQI2gP2gIteym5gSmkGvgbmRd4J/aqj93zFiUc1VCSc+K0WWWytd+HtHZ678YTQ2Yu+4jSzVePbcNVe6n51+U/wZKesx3N5aEAAAAASUVORK5CYII='/%3e%3c/defs%3e%3c/svg%3e)
Get Supported Countries
Returns every country you can send payouts to, along with each country's supported currencies and payout rails (destination_types). Use this to populate country pickers in your UI or to discover which corridors are open for a given destination.
Each corridor lists destination_types — values include bank, swift, mobile_money, sepa_eur, domestic_gbp, wire, ach, alipay, wechatpay, paybill, paytill. Combine the destination type with GET /api/payouts/supported-countries/:country to get the exact field schema.
Request
List every payout corridor with GET /api/payouts/supported-countries.
Response Fields
Full list of countries payouts are supported in.
ISO 3166-1 alpha-2 country code (e.g. 'GB', 'NG').
Display name of the country.
Country flag emoji for UI rendering.
International dial prefix. Occasionally a comma-separated list when the country has multiple (e.g. DO → '1809,1829,1849').
Supported payout corridors for this country. Each entry pairs a currency with the destination types available for that currency.
ISO 4217 currency code (e.g. 'USD', 'EUR', 'GHS').
Payout rails available for this (country, currency) pair. See the list above for possible values.
The country list you get in sandbox is a subset of the production list. Always call this endpoint against the environment you're integrating with before hard-coding corridor support.
Get Country Details
Returns the full beneficiary field schema for a single country — a machine-readable destination_types object keyed by rail (bank, swift, mobile_money, alipay, wechatpay, etc.). Each entry lists required fields, their type / component / pattern / min_length / max_length validators, plus any enum options and per-rail limits.
This is the source of truth you should consult before constructing an Initialize payload. Use it to drive dynamic forms, client-side validation, or per-country payload builders.
Path Parameters
ISO 3166-1 alpha-2 country code — must appear in Get Supported Countries (e.g. 'CN', 'NG', 'GB').
Response Fields
Country identity block — same shape as entries in Get Supported Countries.
Map keyed by rail name (e.g. 'bank', 'swift', 'alipay', 'wechatpay', 'mobile_money'). Each value is the full field schema for that rail.
Human-readable label for the rail (e.g. 'Bank Transfer', 'International Wire (SWIFT)').
Ordered list of fields required on the beneficiary for this rail. Each field carries key/label/type/required/component plus optional pattern/min_length/max_length/placeholder/options. Fields of type 'group' contain nested fields; type 'variant' is a discriminated union keyed by variant_key.
Populated for rails that require a bank selector (e.g. 'bank'). Same shape as Get Banks.
Per-rail amount limits: min_amount, max_amount, currency.
The response is designed to drive auto-generated forms. Each field's component (text, select, date, country_select, fieldset, variant_fieldset) maps one-to-one to a form control; options_ref points at shared enum lists so you don't re-hardcode them per country.
Get Banks
Returns the bank and mobile-money directory for a country — a flat list of providers with their code and display name. Use the returned code as the bank_code input for Account Lookup and as the beneficiary's bank_code on Initialize.
Path Parameters
Two-letter ISO country code (e.g. 'NG', 'KE', 'GH'). Must be one of the codes returned by Get Supported Countries.
Response Fields
Echo of the ISO country code you requested.
Display name of the country (e.g. 'Nigeria').
Total number of bank / provider entries returned (e.g. Nigeria returns 358).
Banks and mobile-money providers supported in the country. Typically sorted alphabetically by bank_name.
Provider code — pass this as bank_code on Account Lookup and as the beneficiary's bank_code on Initialize.
Display name of the bank or mobile-money provider (e.g. 'Access bank', 'PAYSTACK PAYMENTS LIMITED').
Get Limits
Returns the minimum and maximum payout amount for every supported (country, currency) corridor, with pre-computed USD equivalents so you can validate amounts client-side before creating a quote.
Response Fields
One entry per (country, currency) corridor. Countries that support multiple currencies (e.g. GB supports both EUR and GBP) return one limit per currency.
ISO 3166-1 alpha-2 country code (e.g. 'NG', 'GH', 'GB').
ISO 4217 currency code for this corridor (e.g. 'NGN', 'GHS', 'GBP').
Minimum amount for a single payout, expressed as a decimal string in the local currency.
Maximum amount for a single payout, expressed as a decimal string in the local currency.
min_amount converted to USD using the current exchange rate. Useful for validating USD-denominated amounts client-side without calling a conversion endpoint.
max_amount converted to USD using the current exchange rate.
The USD equivalents are computed at request time against the live FX rate. Cache the response sparingly — stale USD bounds may drift from what the quote endpoint will accept.