Get Country Requirement
You can get the details required for creating a beneficiary for the country you want to make a payout to. These required details are used to populate the destination object in the add beneficiary API
Path Parameters
| Parameter | type | Required |
|---|---|---|
| country_code | string | ✅ |
Request
Beneficiaries/Get Country Requirement [GET]
curl --request GET \
--url https://sandboxapi.onbrails.com/api/v1/wallets/payout/supported-countries/country_code \
--header 'Authorization: Bearer YOUR_SECRET_KEY' \
--header 'accept: application/json'
Responses
🟢 200 - Result example
{
"status": true,
"message": "supported country successfully retrieved",
"data": {
"code": "KE",
"name": "Kenya",
"flag": "🇰🇪",
"dialCode": "254",
"destination": {
"MOBILEMONEY": [
{
"name": "type",
"type": "string",
"required": true,
"const": "MOBILEMONEY"
},
{
"name": "network",
"type": "string",
"required": true,
"enum": [
"MPESA"
]
},
{
"name": "accountNumber",
"type": "string",
"required": true,
"pattern": "^2547[\\d]{8}$"
}
]
}
}
}