Loyalty cards

Transfer card data

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card.

[!important] Note

  • The original card is automatically blocked once the new card is created, and it cannot be activated again.
  • The default status of the new card is active.
put/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer

Request

Path parameters

loyaltyProgramIdinteger required

Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.

loyaltyCardIdstring required

Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.

Important: The loyalty card ID requires URL encoding if it contains special characters. For example, you must encode NewCard2026% as NewCard2026%25.

Request body

newCardIdentifierstring required

The identifier of the loyalty card, which must match the regular expression ^[A-Za-z0-9._%+@-]+$.

blockReasonstring

Reason for transferring and blocking the loyalty card.

Example request

{
  "newCardIdentifier": "summer-loyalty-card-0543",
  "blockReason": "Current card lost. Customer needs a new card."
}

Response

No Content

Changes

No recorded changes to this operation across all 2 revisions of this API.