Initiate Fiat Withdrawal
This API is used to initiate and execute a withdrawal from the customer's yield profile as well as send withdrawn funds immediately to the bank account details indicated by the Fintech partner in the API. Kindly note that beneficiary details would be
Given that a customer can be assigned to more than one yield offering profile, you should always pass the offering ID of the yield profile funds are to be withdrawn from.
HTTP Method : POST
API Endpoint : {{baseurl}}/api/v1/withdrawal/fiat
Sample cURL Request
curl --location --request POST 'https://api.ovalfi-app.com/api/v1/withdrawal/fiat' \
--header 'Signature: 9b22497f8096b26ff60c32d1059b6f6fdb037c8ff4cd9280d2c4a8252f09a3c2' \
--data-raw '{
"customer_id":"9f40fb69-64e3-4d23-853a-0243af155427",
"reference": "ref5679",
"amount": 9.0,
"yield_offering_id": "42ee80d8-2a95-419c-aad1-5643d306948e",
"payout_currency": "NGN",
"bank_detail": {
"bank_code": "057",
"account_number": "2209276822"
}
}'
Sample JSON Request
{
"customer_id":"9f40fb69-64e3-4d23-853a-0243af155427",
"reference": "ref5679",
"amount": 9.0,
"yield_offering_id": "42ee80d8-2a95-419c-aad1-5643d306948e",
"payout_currency": "NGN",
"bank_detail": {
"bank_code": "057",
"account_number": "2209276822"
}
}
Response Parameters
{
"status": 200,
"data": {
"id": "5b74a80c-feaa-48bf-91de-76a227fa46da",
"customer_id": "9f40fb69-64e3-4d23-853a-0243af155427",
"reference": "ref5679",
"amount": 9,
"channel": "",
"currency": "USD",
"created_at": "2022-11-08T12:12:45.792726846Z",
"completed_at": null,
"updated_at": "2022-11-08T12:12:45.792726846Z",
"batch_date": "2022-11-08T12:12:45.787885013Z",
"status": "processing",
"withdrawal_amount": 6743.93,
"withdrawal_currency": "NGN",
"payout_detail": {
"bank_code": "057",
"account_number": "2209276822"
},
"cancel_reason": null,
"yield_offering_id": "42ee80d8-2a95-419c-aad1-5643d306948e"
},
"message": "successfully initiate withdrawal",
"error": null
}
Updated about 2 years ago