younifyd
Menu

Transfer Points

Transfer Loyalty Points

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

Use it in a workflow

  1. Add a step and choose the Voucherify connector.
  2. Pick the Transfer Points action (under Loyalties).
  3. Fill in the fields below, then reference the result from later steps as {{transferPoints.response.data}}.

Request

Path parameters

campaignIdstringrequired

A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).

memberIdstringrequired

A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).

Response

Returns 200 with an object. Read it in later steps with {{transferPoints.response.data.<field>}}.

idstring

Assigned by the Voucherify API, identifies the voucher.

codestring

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

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

category_idstring

Unique category ID assigned by Voucherify.

categoriesarray<object>
idstring

Unique category ID assigned by Voucherify.

namestring

Category name.

hierarchyinteger

Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.

objectstring

The type of the object represented by the JSON. This object stores information about the category.

One ofcategoryDefault "category"

created_atstring (date-time)

Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.

updated_atstring (date-time)

Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.

typestring

Defines the type of the voucher.

One ofLOYALTY_CARD

loyalty_cardobject

Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD.

pointsinteger

Total number of points added to the loyalty card over its lifespan.

balanceinteger

Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`.

next_expiration_datestring

The next closest date when the next set of points are due to expire.

next_expiration_pointsinteger

The amount of points that are set to expire next.

pending_pointsinteger

Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.

expired_pointsinteger

Shows the total number of expired points over the lifetime of the loyalty card.

subtracted_pointsinteger

Shows the total number of subtracted points over the lifetime of the loyalty card.

start_datestring (date-time)

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

expiration_datestring (date-time)

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

validity_timeframeobject

Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.`start_date` **required** when including the `validity_timeframe`.

durationstring

Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a `duration` of `PT1H` will be valid for a duration of one hour.

intervalstring

Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an `interval` of `P2D` will be valid every other day.

validity_day_of_weekarray<integer>

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

validity_hoursobject

Determines the hours of validity, e.g. to create a happy hours scenario.

dailyarray<object>3 fields

Defines the recurring period(s) when the resource is active. The periods should not overlap.

publishobject

This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event. A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer. Typically, a publication is made by distributing your codes to your customers, e.g. through Export to MailChimp or publish voucher API method.

objectstring

The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.

One oflistDefault "list"

countinteger

Publication events counter.

entriesarray<string>
urlstring

The endpoint where this list of publications can be accessed using a **GET** method. /v1/vouchers/{voucher_code}/publications

redemptionobject

Stores a summary of redemptions that have been applied to the voucher.

quantityinteger

How many times a voucher can be redeemed. A null value means unlimited.

redeemed_pointsinteger

Total loyalty points redeemed.

redeemed_quantityinteger

How many times a voucher has already been redeemed.

objectstring

The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.

One oflistDefault "list"

urlstring

The endpoint where this list of redemptions can be accessed using a **GET** method. /v1/vouchers/{voucher_code}/redemptions

activestring

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

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

metadataobject

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.

assetsobject

Stores links to images of QR and barcode that correspond to an encrypted voucher code.

qrobject2 fields

Stores Quick Response (QR) representation of encrypted code.

barcodeobject2 fields

Stores barcode representation of encrypted code.

is_referral_codeboolean

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)
json
{
  "validity_timeframe": {
    "duration": "PT1H",
    "interval": "P2D"
  },
  "validity_day_of_week": [
    0
  ],
  "id": "string",
  "code": "string",
  "campaign": "string",
  "campaign_id": "string",
  "category": "string",
  "category_id": "string",
  "categories": [
    {
      "id": "string",
      "name": "string",
      "hierarchy": 0,
      "object": "category",
      "created_at": "2022-07-14T10:45:13.156Z",
      "updated_at": "2022-08-16T10:52:08.094Z"
    }
  ],
  "type": "LOYALTY_CARD",
  "loyalty_card": {
    "points": 0,
    "balance": 0,
    "next_expiration_date": "string",
    "next_expiration_points": 0,
    "pending_points": 0,
    "expired_points": 0,
    "subtracted_points": 0
  },
  "start_date": "2025-01-01T00:00:00Z"
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.