Validate a recipient
Validate beneficiary details
This endpoint allows you to validate recipient details before initiating a payout. Using this API will reduce the likelihood of your payout failing because of a validation issue. The request payload requirements vary based on the payout type when using the validate endpoint.
Mobile money
{
"rateId": "63622185d62f256c752cc6a0",
"type": "MOBILE_MONEY",
"recipient": {
"msisdn": "233241603403",
"firstName": "Nancy",
"lastName": "Mends"
},
"senderDetails": {
"firstName": "Daniella",
"lastName": "Timothy",
"state": "LA",
"city": "Iyano",
"country": "NG",
"msisdn": "2349079935431",
"postalCode": "98I987",
"address": "2 Underwood",
"dob": "1999-03-12",
"idType": "NATIONAL_ID",
"idNumber": "85974939420"
}
}Bank transfer
{
"rateId": "637367c165ff2379041a1517",
"purpose": "test compulsory",
"type": "BANK_TRANSFER",
"recipient": {
"bankCode": "530",
"accountNumber": "01608268231",
"firstName": "Nancy",
"lastName": "Dan",
},
"senderDetails": {
"firstName": "Daniella",
"lastName": "Timothy",
"state": "LA",
"city": "Iyano",
"country": "NG",
"msisdn": "2349079935431",
"postalCode": "98I987",
"address": "2 Underwood",
"dob": "1999-03-12",
"idType": "NATIONAL_ID",
"idNumber": "85974939420"
}
}Wire transfer
{
"rateId": "63622d00d69f256c752cc6a5",
"type": "WIRE",
"recipient": {
"wireType": "ABA",
"routingNumber": "084196768",
"accountNumber": "9908004393",
"bankCountry": "US"
},
"senderDetails": {
"address": "2 Underwood",
"city": "Dallas",
"state": "TX",
"country": "US",
"firstName": "Wakanda",
"lastName": "Toga",
"postalCode": "75015"
}
}Validate a recipient
GET https://sandbox.moneymie.com/api/v1/payout/recipients/validate
Request Body
Name
Type
Description
rateId*
Number
The rate id generated (e.g. 634ecbf6a1bb914e92d24ff9)
recipient*
Object
The details of the recipient
type*
String***
The payout type
Last updated