Initiate Payout
https://sandboxapi.onbrails.com/api/v1/wallets/payout/initialize (opens in a new tab)
Initiate payout to an already indexed beneficiary
Body Parameters
| Parameter | type | Required |
|---|---|---|
| amount | int32 | ✅ |
| country | string | ✅ |
| reference | string | ✅ |
| customerEmail | string | ✅ |
| description | string | ✅ |
| beneficiaryId | string | ✅ |
| sourceWalletCurrency (Defaults to USD) Wallet from which payout is to be initiated | string | ✅ |
| callbackUrl | string | ✅ |
Request
Beneficiaries/Initiate Payout [POST]
curl --request POST \
--url https://sandboxapi.onbrails.com/api/v1/wallets/payout/initialize \
--header 'Authorization: Bearer YOUR_SECRET_KEY' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"amount": 0,
"country": "string",
"reference": "string",
"customerEmail": "string",
"description": "string",
"beneficiaryId": "string",
"sourceWalletCurrency": "USD",
"callbackUrl": "string"
}
'Responses
🟢 200 - Result example
{
"status": true,
"message": "Payout Initialized Successfully",
"data": {
"id": "e6d06d21-73c8-471b-9e5b-9171920ab4ea",
"createdAt": "2023-08-17T16:13:30.635Z",
"updatedAt": "2023-08-17T16:13:30.635Z",
"companyId": "65f8ecbc-f7dd-4753-9cd4-dda9a3e396cb",
"customerId": "4bf15cb3-97a6-4072-9683-aa3c6d7233df",
"centFees": 0,
"type": "debit",
"reference": "HjdYJWumFMnNyUp",
"channel": "payout",
"description": "test payout",
"status": "initiated",
"action": "ngn_account_payout",
"fees": 0,
"amount": 1.13,
"centAmount": 113,
"spotPrice": 879
}
}