VOvoucherifyio
Loyalties

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/v1/loyalties/members/{memberId}/balance

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/loyalties/members/{memberId}/balance
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, loyalties

Request body

pointsinteger required

Incremental balance to be added to/subtracted from the loyalty card.

  • To add points: 100
  • To subtract points, add a minus: -100
expiration_type'PROGRAM_RULES' | 'CUSTOM_DATE' | 'NON_EXPIRING'
expiration_datestring date-time

Set expiration date for added points, i.e. YYYY-MM-DD. This parameter is required only when expiration_type is set to CUSTOM_DATE.

reasonstring

Reason for the transfer.

source_idstring

The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service.

Response

Returns a balance object.

pointsinteger required

The incremental points removed or added to the current balance on the loyalty card.

totalinteger required

The total of points accrued over the lifetime of the loyalty card.

balanceinteger required

The balance after adding/removing points.

type'loyalty_card' | 'gift_voucher' required

The type of voucher being modified.

object'balance' required

The type of the object represented by JSON. Default is balance.

operation_type'MANUAL' | 'AUTOMATIC'

The type of operation being performed.

Changes

No recorded changes to this operation across all 1 revision of this API.