Get all Customer Balances

This API is called to fetch and retrieve the a customers' balance across all yield profiles.

Unique identifier for this API is the CustomerID which was generated & returned during customer creation.

HTTP Method : GET
API Endpoint : {{baseurl}}/api/v1/customer/balance/{{customer_id}}

Sample cURL Request

curl --request GET \
     --url https://sandbox-api.ovalfi-app.com/api/v1/customer/balances/690a58e1-25b8-43fc-9f6c-39678917f940 \
     --header 'Authorization: sha512-y166Yc0gusfCKzJnxSNjspysLvjg9VRZEG2JjfMuLiTtuPXl/eN442TAJaJzHlsiaTsjWlRRvqoMHH3ZJAumgA==?fQ==' \
     --header 'accept: application/json'

Response Parameters

{
  "status": 200,
  "data": {
    "customer_id": "690a58e1-25b8-43fc-9f6c-39678917f940",
    "total_balance": 632,
    "detail": [
      {
        "yield_offering_id": "d4ab71b5-f996-40b0-9fd9-bab8004e1f3f",
        "name": "Custom Design",
        "currency": "USD",
        "balance": 100
      },
      {
        "yield_offering_id": "21c5b640-266e-44fd-ac30-af3f39f1c4f8",
        "name": "Free Customers",
        "currency": "USD",
        "balance": 532
      }
    ]
  },
  "message": "got customer balance successfully!",
  "error": null
}