Initiate Crypto 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 crypto wallet address indicated by the Fintech partner in the API.

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/crypto

Sample cURL Request

curl --location --request POST 'https://api.ovalfi-app.com/api/v1/withdrawal/crypto' \
--header 'Signature: d917f24cc72fa4426727ffdb7e6ced9282f92db7e7ea9f258e5e191888bc0b1f' \
--data-raw '{
    "customer_id":"9f40fb69-64e3-4d23-853a-0243af155427",
    "reference": "ref56790",
    "amount": 9.0,
    "yield_offering_id": "42ee80d8-2a95-419c-aad1-5643d306948e",
    "payout_currency": "USDC",
    "wallet_detail": {
        "address": "0x53d11f84f6f767fdC95B11e9b18c92268825414A",
        "network": "TEST",
        "asset": "USDC"
    }
}'

Sample JSON Request

{
    "customer_id":"9f40fb69-64e3-4d23-853a-0243af155427",
    "reference": "ref56790",
    "amount": 9.0,
    "yield_offering_id": "42ee80d8-2a95-419c-aad1-5643d306948e",
    "payout_currency": "USDC",
    "wallet_detail": {
        "address": "0x53d11f84f6f767fdC95B11e9b18c92268825414A",
        "network": "TEST",
        "asset": "USDC"
    }
}

Response Parameters

{
    "status": 200,
    "data": {
        "id": "f9f2ddf9-c069-48f2-b5bb-11f31c0eaa07",
        "customer_id": "9f40fb69-64e3-4d23-853a-0243af155427",
        "reference": "ref56790",
        "amount": 9,
        "channel": "",
        "currency": "",
        "created_at": "2022-10-31T07:33:18.352099589Z",
        "completed_at": null,
        "updated_at": "2022-10-31T07:33:18.352099589Z",
        "batch_date": "2022-10-31T07:33:18.351725339Z",
        "status": "completed",
        "withdrawal_amount": 9,
        "withdrawal_currency": "",
        "payout_detail": {
            "asset": "USDC",
            "network": "TEST",
            "address": "0x53d11f84f6f767fdC95B11e9b18c92268825414A"
        },
        "cancel_reason": null,
        "yield_offering_id": "42ee80d8-2a95-419c-aad1-5643d306948e"
    },
    "message": "successfully initiate withdrawal",
    "error": null
}