This API is used to create a payout recipient that can be used for repeat payouts.
First call the Get Payout Methods API to get a list on methods, and when one gets selected, use the code and account number to create a recipient.
The recipient code returned can be used to make repeat payouts to the same account number.
Request And Headers
POST: /api/payouts/recipient
Content-Type: application/json
Authorization: Basic <token>
NB: We will provide you with the Basic Auth credentials.
Request Payload
{
"firstName": "Test",
"lastName": "User",
"email": "[email protected]",
"phone": "234009988888",
"payoutMethodName": "Kuda Bank",
"payoutMethodCode": "123",
"accountNumber": "12345678890",
"type": "BANK_TRANSFER",
"countryCode": "NG",
"currencyCode": "NGN"
}Response
Status: 201, 400
{
"recipientCode": "CPRC_210468877705707",
"firstName": "Test",
"lastName": "User",
"email": "[email protected]",
"phone": "234009988888",
"type": "BANK_TRANSFER",
"countryCode": "NG",
"currencyCode": "NGN"
}