Holdings Transfers

This method is used to initiate fund movements between the customers' default holding account and yield profiles.

The holding account is automatically credited whenever a customer successfully initiates a crypto wallet deposit or a NGN account deposit

This method can be utilized by the partner to move funds from the holding to the partners' float or to another yield profile as a savings deposit transaction.

📘

Note

When action = credit, funds would be moved from the holding account to the yield profile whose id has been specified.

When action = debit, funds would be debited from the yield profile whose id has been specified and credited to the customers' holding account.

HTTP Method : POST
API Endpoint : {{base_url}}/api/v1/transfer-funds

Sample cURL Request

curl --location --request POST 'https://sandbox-api.ovalfi-app.com/api/v1/transfer-funds' \
--header 'Signature: 6934d3824d6de3a5b43643e11e16d8192931adef7934b34edff199ddaedc8456' \
--data-raw '{
    "customer_id":"9f40fb69-64e3-4d23-853a-0243af155427",
    "reference":"polmu",
    "amount": 10.00,
    "action": "credit",
    "yield_offering_id":"42ee80d8-2a95-419c-aad1-5643d306948e"
}'

Sample JSON Request

{
    "customer_id":"9f40fb69-64e3-4d23-853a-0243af155427",
    "reference":"polmu",
    "amount": 10.00,
    "action": "credit",
    "yield_offering_id":"42ee80d8-2a95-419c-aad1-5643d306948e"
}

Response Parameters

{
    "status": 200,
    "data": {
        "id": "80b5357e-1595-4591-9d41-2aa8739e1cee",
        "customer_id": "9f40fb69-64e3-4d23-853a-0243af155427",
        "business_id": "d04319d7-b3fb-478e-ade5-76cc5176e1dd",
        "reference": "polmu",
        "currency": "",
        "amount": 10,
        "channel": "",
        "created_at": "2022-10-25T11:30:36.942934167Z",
        "deposit_before_id": "146b5399-278e-4464-a85c-9679d26e52d9",
        "batch_date": "2022-10-25",
        "status": "completed",
        "yield_offering_id": "00000000-0000-0000-0000-000000000000"
    },
    "message": "successfully deposit",
    "error": null
}