Skip to content

Gift cards

Gift cards can be created by adding as many activities from the activities catalog as needed. The data structure used to add gift cards to the cart is described in the add to cart section.

After purchasing the gift card, a unique code is generated so that it can be redeemed. The dates and sessions, if applicable, of the included activities are chosen at redemption time.

To perform the redemption process, the products included in the gift card are added to the cart indicating the gift card code they belong to. The data structure used to indicate that an activity belongs to a gift card is described in the add to cart section.

Check gift card

Using this method, we can check whether a gift card can be redeemed from a redemption code.

Access method

GET /activity/giftcard

Request structure

  • GiftCardIdentifier: (string). Redemption code.
  • LanguageCode: (string) Optional. Defines the language in which the texts will be displayed. By default, the language configured for the partner will be returned.

Request example

{
    "GiftCardIdentifier": "3167250411491835499"
}

{
    "GiftCardIdentifier": "3167250411491835499",
    "LanguageCode": "en"   
}

Response structure

  • GiftCardIdentifier: (string). Redemption code.
  • SaleId: (string). Sale identifier.
  • PartnerSaleId: (string). Partner identifier.
  • IsExchanged: (boolean). Indicates whether the gift card has already been redeemed.
  • HoursInAdvanceOfGiftCardExchange: (short). Hours in advance required for redemption compared with 00:00 of the day after the visit.
  • Message: (string). Message from the gift card purchaser to the person redeeming it.
  • Client: (object). Data of the customer who will redeem the card.
    • CreatedDate: (dateTime). Date when the customer record was created.
    • FullName: (string). Name.
    • Surname: (string). Surname.
    • CountryCode: (string). Country code.
    • LanguageCode: (string). Language code.
    • Gender: (byte). Gender.
    • AcceptsEmailContact: (boolean). Accepts receiving marketing communications.
    • AllowCustomerProfiling: (boolean). Accepts the creation of a customer profile.
  • Success (boolean): value that indicates whether the call was processed correctly or not.
  • Timestamp (dateTime): time at which the request was processed. ISO 8601 format (yyyy-MM-ddThh:mm:ss.fffffff).
  • ErrorMessage (string): error message explaining why the request was not successful. If it was correct, it will return null.
  • ErrorCodes (string[]): list of codes that identify the errors that occurred in the call.
  • ErrorEntityBreakDown (list): list that contains objects with the name and ID in case of error.
    • Id (string): identifier
    • Name (string): related name of the identifier.

Response example

{
    "GiftCardIdentifier": "3167250411491835499",
    "SaleId": "4000795350002495741",
    "Message": "",
    "Client": {
        "CreatedDate": "2025-06-05T09:32:18",
        "FullName": "Sara Cruz",
        "Surname": "Sara Cruz",
        "Email": "sara.cruz@gmail.com",
        "CountryCode": "es",
        "LanguageCode": "es",
        "Gender": 0,
        "AcceptsEmailContact": false,
        "AllowCustomerProfiling": false
    },
    "PartnerSaleId": "9031552178833_102",
    "Products": [
        {
            "Id": "154864ftfmxh",
            "Name": "Nombre del producto 1"
        },
        {
            "Id": "gimas51204d",
            "Name": "Nombre del producto 2"
        }
    ],
    "HoursInAdvanceOfGiftCardExchange": 0,
    "IsExchanged": false,
    "Success": true,
    "Timestamp": "2025-06-13T10:47:42"
}