Initiate Withdrawal

This API is used to initiate and execute a withdrawal from the customer's yield profile on their behalf.

The request is batched with every other batch withdrawal request on the yield offering profiled and processed at the end of the day as a lump sum value. Following a successful withdrawal, the funds are deposited into the Fintech partners' profiled withdrawal method.

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

Sample cURL Request

curl --location --request POST 'https://api.ovalfi-app.com/api/v1/withdrawal' \
--header 'Authorization: Bearer eyJidXNpbmVzc0lEIjoiZTY2NWJkYWUtNWE0ZC00ODNiLTk2NTQtZTk0NzViMzRjY2ViIiwidXNlcklEIjoiYTY4NjE1ZGMtMjY5MS00ZmI1LTkyZmMtNTQ1NmRlN2M3YjllIiwia2V5Ijoia3JwIn0=' \
--header 'Signature: 375a95d71b7b755ae2722a7a034f017c866c7e1cde39cb1da4e7acc6faedc731' \
--data-raw '{

    "customer_id":"6c19686b-9617-4a6c-bbca-f37a522e0c9b",
    "reference":"ref567",
    "amount": 150.00,
    "yield_offering_id":"42ee80d8-2a95-419c-aad1-5643d306948e"
}'

Sample JSON Request

{
    "customer_id":"6c19686b-9617-4a6c-bbca-f37a522e0c9b",
    "reference":"ref567",
    "amount": 150.00,
    "yield_offering_id":"42ee80d8-2a95-419c-aad1-5643d306948e"
}

Response

{
    "status": 200,
    "data": {
        "id": "b22b4237-96fc-4d87-ac00-3f195b4739a7",
        "customerID": "c56f266e-9382-4f17-8378-20a935b342f0",
        "reference": "ref875797",
        "amount": 12,
        "channel": "api",
        "createdAt": "2022-08-11T12:10:51.865146323+01:00",
        "status": "pending",
        "yieldOfferingID": "42ee80d8-2a95-419c-aad1-5643d306948e"
    },
    "message": "successfully initiate withdrawal",
    "error": null
}