Get Customer Balance

This API is called to fetch and retrieve the balance of a customers’ specific yield account taking into consideration accrued yield values.

Unique identifier for this API is the CustomerID which was generated & returned during customer creation as well as the exact yield offering i for which the balance is to be spooled

📘

Yield Account

This is a savings account created automatically for the customer upon successful creation. It's utilized for both deposit and withdrawal transactions

HTTP Method : GET
API Endpoint : {{baseurl}}/api/v1/customer/balance?customer_id=&yield_offering_id=

Sample cURL Request

curl --request GET \
     --url 'https://sandbox-api.ovalfi-app.com/api/v1/customer/balance?customer_id=66c13ffc-6b1b-46eb-a3a9-335e436b92f2&yield_offering_id=d4ab71b5-f996-40b0-9fd9-bab8004e1f3f' \
     --header 'Authorization: sha512-y166Yc0gusfCKzJnxSNjspysLvjg9VRZEG2JjfMuLiTtuPXl/eN442TAJaJzHlsiaTsjWlRRvqoMHH3ZJAumgA==?fQ==' \
     --header 'accept: application/json'

Response Parameters

{
  "status": 200,
  "data": {
    "yield_offering_id": "d4ab71b5-f996-40b0-9fd9-bab8004e1f3f",
    "name": "Custom Design",
    "currency": "USD",
    "balance": 200
  },
  "message": "got customer balance successfully!",
  "error": null
}