GetBalance
[POST] .../v1/retailcard/getbalance
Returns the current bonus balance of a customer card. Retrieve the current bonus balance of a retail customer card in a specific loyalty program. The request filters by card_id and promo_id and returns result with the current PromoBonusesRemainder value. The method checks the current request user and requires customer card balance permission; missing body, missing card_id, missing promo_id, denied permission, missing balance data and storage errors are returned as HTTP 200 ErrorResult.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| filters | Array of Filter | Required | Filters by fields available for this API method. Required filter fields: card_id, promo_id. |
Filterable Fields
| Field | Type | Required | Description |
|---|---|---|---|
| card_id | int | Required | Customer card ID. |
| promo_id | int | Required | Promotion ID. |
Request Example
{
"filters": [
{
"Field": "card_id",
"Operator": "Equal",
"Value": "string"
}
]
}Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | PromoBonusesRemainder | Result object. |
Response Example
{
"ok": true,
"result": {
"last_update": 1,
"value": 1.0
}
}