See the metadata for the payload of the bulk payout endpoint
When making a bulk payout API call, you need to specify the destination of the fund disbursements.
The destination field consists of a metadata object. The metadata will hold important information required to make payouts to the destination corridor (country and gateway).
The following table describes the disbursement metadata across the corridors covered by BaseOne.
| Destination | Metadata | Description |
|---|---|---|
| Nigeria | NIL | Payouts to Nigeria do not need the metadata |
| Africa | Africa: Payout Metadata Parameter Definition | Payouts to other African counties other than Nigeria |
| Europe | Coming soon... | Coming soon... |
Africa: Payout Metadata Parameter Definition
| Parameter | Definition | Example | Required |
|---|---|---|---|
| ServiceType | The type of service of payment (Wallet or Bank) | Wallet | Yes |
| BeneficiaryMobileOperator | The beneficiary phone service provider | SAFARICOM | Only for mobile money |
| SendingCurrencyCode | The sender's currency code | NGN | Yes |
| SenderFirstname | The sender's first name | John | Yes |
| SenderLastname | The sender's last name | Onifade | Yes |
| SenderCountry | The sender's country | NGA | Yes |
| SenderCity | The sender's city | Lagos | Yes |
| SenderAddress | The sender's address | 48, IV Place, Ikeja | Yes |
| SenderPhoneNumber | The sender's phone number | 2348166666666 | Yes |
| SenderEmail | The sender's email address | [email protected] | Yes |
| BeneficiaryFirstname | The beneficiary's first name | Maame | Yes |
| BeneficiaryLastname | The beneficiary's last name | Safao | Yes |
| BeneficiaryCountry | The beneficiary's country | KEN | Yes |
| BeneficiaryCity | The beneficiary's city | Nairobi | Yes |
| BeneficiaryAddress | The beneficiary's address | 99, V Place, Nairobi | Yes |
| BeneficiaryPhoneNumber | The beneficiary's phone number | 254555555555 | Yes |
| BeneficiaryEmail | The beneficiary's email address | [email protected] | Yes |
Sample Request Body
The following code is an example of how the metadata can be used in the body of a single payout request. The example is for a mobile money disbursement from Nigeria to Kenya via the SAFARICOM mobile service provider.
{
"debitWallet": "USD",
"country": "KEN",
"metaData": {
"ServiceType": "Wallet",
"BeneficiaryMobileOperator": "SAFARICOM",
"SendingCurrencyCode": "NGN"
"SenderFirstname": "John",
"SenderLastname": "Onifade",
"SenderCountry": "NGA",
"SenderCity": "Lagos",
"SenderAddress": "48, IV Place, Ikeja",
"SenderPhoneNumber": "2348166666666",
"SenderEmail": "[email protected]",
"BeneficiaryFirstname": "Maame",
"BeneficiaryLastname": "Safao",
"BeneficiaryCountry": "KEN",
"BeneficiaryCity": "Nairobi",
"BeneficiaryAddress": "99, V Place, Nairobi",
"BeneficiaryPhoneNumber": "254555555555",
"BeneficiaryEmail": "[email protected]",
},
"destinationAmount": 12,
"institutionCode": "SWERVE",
"destinationAccount": "254555555555",
"narration": "Transfer to Maame Safao account",
"channel": 1
}
Learn more about Payouts here.