Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Loyalties

Transfer Loyalty Points

Transfer points between different loyalty cards which have holders.

Provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters. In the request body, provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.

Transfer works only for loyalty cards that have holders, meaning the cards were published to customers.

The transferred points expire according to the target program expiration rules.

post/v1/loyalties/{campaignId}/members/{memberId}/transfers

Request body

codestring required

Unique loyalty card code from which the user wants to transfer loyalty points (source).

pointsinteger required

The number of loyalty points that the user wants to transfer to another loyalty card. The number of points cannot be higher than the current balance on the loyalty card (source).

reasonstring

Reason for the transfer.

source_idstring required

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 loyalty card object for the loaded loyalty card, ie. the one that that points were transferred to from the other cards(s).

idstring required

Assigned by the Voucherify API, identifies the voucher.

codestring required

A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.

campaignstring

A unique campaign name, identifies the voucher's parent campaign.

campaign_idstring

Assigned by the Voucherify API, identifies the voucher's parent campaign.

categorystring nullable required

Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.

category_idstring nullable required

Unique category ID assigned by Voucherify.

type'LOYALTY_CARD' required

Defines the type of the voucher.

start_datestring date-time nullable required

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.

expiration_datestring date-time nullable required

Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.

validity_day_of_weekinteger[] required

Integer array corresponding to the particular days of the week in which the voucher is valid.

  • 0 Sunday
  • 1 Monday
  • 2 Tuesday
  • 3 Wednesday
  • 4 Thursday
  • 5 Friday
  • 6 Saturday
activestring required

A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the start_date and expiration_date.

  • true indicates an active voucher
  • false indicates an inactive voucher
additional_infostring nullable required

An optional field to keep any extra textual information about the code such as a code description and details.

metadataobject required

The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.

is_referral_codeboolean required

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

holder_idstring

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

updated_atstring date-time

Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.

created_atstring date-time required

Example response

{
  "categories": [
    {
      "created_at": "2022-07-14T10:45:13.156Z",
      "updated_at": "2022-08-16T10:52:08.094Z"
    }
  ],
  "validity_timeframe": {
    "duration": "PT1H",
    "interval": "P2D"
  },
  "validity_hours": {
    "daily": [
      {
        "start_time": "12:00",
        "expiration_time": "14:00"
      }
    ]
  },
  "assets": {
    "qr": {
      "id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==",
      "url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"
    },
    "barcode": {
      "id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==",
      "url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"
    }
  }
}