api/v1/customer/balances

POST

/api/v1/customer/balances

This API method will grab a list of balances available to the customer for the specific store provided.

Sample Request body

Parameter

Value / Type

Required

store_id

STRING

true

product_id

STRING

false

Sample Response

{
  "status": true,
  "items": [
    {
      "id": "dnbPV7yRzv3EWaX1GKZv",
      "balance_type_id": "jq7w3P59EGvzKvBO80ok",
      "balance_type_name": "Default",
      "balance": "20000.00",
      "redeemed": "0.00",
      "created_at": "2018-07-22 15:49:00",
      "updated_at": "2018-07-26 01:21:14"
    },
    {
      "id": "G2D3wn94m41zrAOKPvM6",
      "balance_type_id": "vdoV8pgXe62De0JqAWwR",
      "balance_type_name": "New Balance",
      "balance": "1600.00",
      "redeemed": "0.00",
      "created_at": "2018-09-06 07:44:53",
      "updated_at": null
    }
  ]
}
{
  "status": false,
  "errorCode": "NO_ITEMS",
  "message": "There are no balances available on your account"
}