Guides

Initiate a Savings Deposit

Suggest Edits

This method is used to deposit funds on behalf of a customer who has an existing OvalFi account (uniquely identified by their CustomerID) for savings and yield (interest) generation purposes

Considering the fact that a customer can be assigned to more that 1 yield offering profile, it's mandatory for you to pass the offering ID of the profile this deposit is to be assigned to.

HTTP Method : POST
API Endpoint : {{baseurl}}/api/v1/deposit

Sample cURL Request 

curl --location --request POST 'https://api.ovalfi-app.com/api/v1/deposit' \
--header 'Authorization: Bearer eyJidXNpbmVzc0lEIjoiZDA0MzE5ZDctYjNmYi00NzhlLWFkZTUtNzZjYzUxNzZlMWRkIiwidXNlcklEIjoiMmFhMjAwYzItMDMzZS00OTZhLTg1MDMtZDIzZDYwYjBiOTA0Iiwia2V5Ijoib2xhcHJvZzEifQ==' \
--header 'Signature: b1e399b4bcf4efc044337da9a4c19d1e94ad87da34aeb14e889ba5af5aed4ab5' \
--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"
}

📘

reference

This is an ID in the request body uniquely identifying the deposit request at the fintech partners' platform. It should be treated like a payment reference from the partner.

Response Parameters

{
  "status": 200,
  "data": {
    "id": "69a35ec4-58e2-4db2-8aa5-bce5b44a6b0d",
    "customer_id": "66c13ffc-6b1b-46eb-a3a9-335e436b92f2",
    "business_id": "35742cfc-5769-4b5a-9a30-eef03adf5807",
    "reference": "011120222045",
    "currency": "USD",
    "amount": 200,
    "channel": "api",
    "created_at": "2022-11-01T20:45:45.932958Z",
    "deposit_before_id": "00000000-0000-0000-0000-000000000000",
    "batch_date": "2022-11-01",
    "status": "initiated",
    "yield_offering_id": "d4ab71b5-f996-40b0-9fd9-bab8004e1f3f"
  },
  "message": "successfully deposit",
  "error": null
}

📘

id

This is the Deposit ID returned by Oval, it uniquely identifies the deposit attempt at our end.

Updated about 2 years ago

What’s Next