curl --request POST \
  --url https://{cluster}.voucherify.io/v1/loyalties/members/{memberId}/balance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "points": -100
}'

{
  "points": 100,
  "total": 13436,
  "balance": 13136,
  "type": "loyalty_card",
  "object": "balance",
  "related_object": {
    "type": "voucher",
    "id": "v_0aMj6Mdp0i3zuXrd9NnBKboc7746mlgF"
  }
}

Adjust Loyalty Card Balance

This method gives adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest.

🚧 Async Action

This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls.

📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to add or remove loyalty card balance without having to provide the campaignId as a path parameter.

POST

loyalties

members

{memberId}

balance

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/loyalties/members/{memberId}/balance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "points": -100
}'

{
  "points": 100,
  "total": 13436,
  "balance": 13136,
  "type": "loyalty_card",
  "object": "balance",
  "related_object": {
    "type": "voucher",
    "id": "v_0aMj6Mdp0i3zuXrd9NnBKboc7746mlgF"
  }
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Authorization

string

header

required

Path Parameters

memberId

string

required

Example:

Body

application/json

points

integer

required

expiration_type

enum<string>

Available options:

PROGRAM_RULES,

CUSTOM_DATE,

NON_EXPIRING

expiration_date

string<date-time>

reason

string

source_id

string

Response

points

integer

required

total

integer

required

balance

integer

required

Required range: x >= 0

type

enum<string>

required

Available options:

loyalty_card,

gift_voucher

object

enum<string>

default:balance

required

Available options:

balance

Show child attributes

operation_type

enum<string>

Available options:

MANUAL,

AUTOMATIC

Adjust Loyalty Card Balance with campaign ID Transfer Loyalty Points

⌘I

Introduction

Endpoints

Events

Adjust Loyalty Card Balance

Authorizations

Path Parameters

Body

Response