younifyd
Menu

Redeem Gift Card

Redeem gift card

POST/gift_cards/{redemption_code}/redeem

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the Redeem Gift Card action (under gift_cards).
  3. Fill in the fields below, then reference the result from later steps as {{redeemGiftCard.response.data}}.

Request

Path parameters

redemption_codestringrequired

Gift Card redemption code, e.g., `N1A2T8IRXSCMO40V`.

Request body

Enter the body as JSON in the step's Body field.

recipient_accountobjectrequired
idstring
codestring
json
{
  "recipient_account": {
    "id": "string",
    "code": "string"
  }
}

Response

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

idstring
objectstring
gifter_account_idstring

The ID of the account that purchased the gift card.

recipient_account_idstring

The ID of the account that redeemed the gift card redemption code. Does not have a value until gift card is redeemed.

purchase_invoice_idstring

The ID of the invoice for the gift card purchase made by the gifter.

redemption_invoice_idstring

The ID of the invoice for the gift card redemption made by the recipient. Does not have a value until gift card is redeemed.

redemption_codestring

The unique redemption code for the gift card, generated by Recurly. Will be 16 characters, alphanumeric, displayed uppercase, but accepted in any case at redemption. Used by the recipient account to create a credit in the amount of the `unit_amount` on their account.

balancenumber (float)

The remaining credit on the recipient account associated with this gift card. Only has a value once the gift card has been redeemed. Can be used to create gift card balance displays for your customers.

product_codestring

The product code or SKU of the gift card product.

unit_amountnumber (float)

The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.

currencystring

3-letter ISO 4217 currency code.

deliveryobject

Gift card delivery details

methodstring

Whether the delivery method is email or postal service.

One ofemailpost

email_addressstring

The email address of the recipient.

deliver_atstring (date-time)

When the gift card should be delivered to the recipient. If null, the gift card will be delivered immediately. If a datetime is provided, the delivery will be in an hourly window, rounding down. For example, 6:23 pm will be in the 6:00 pm hourly batch.

first_namestring

The first name of the recipient.

last_namestring

The last name of the recipient.

recipient_addressobject8 fields
gifter_namestring

The name of the gifter for the purpose of a message displayed to the recipient.

personal_messagestring

The personal message from the gifter to the recipient.

performance_obligation_idstring

The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

liability_gl_account_idstring

The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

revenue_gl_account_idstring

The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

created_atstring (date-time)
updated_atstring (date-time)
delivered_atstring (date-time)

When the gift card was sent to the recipient by Recurly via email, if method was email and the "Gift Card Delivery" email template was enabled. This will be empty for post delivery or email delivery where the email template was disabled.

redeemed_atstring (date-time)

When the gift card was redeemed by the recipient.

canceled_atstring (date-time)

When the gift card was canceled.

json
{
  "id": "string",
  "object": "string",
  "gifter_account_id": "string",
  "recipient_account_id": "string",
  "purchase_invoice_id": "string",
  "redemption_invoice_id": "string",
  "redemption_code": "string",
  "balance": 0,
  "product_code": "string",
  "unit_amount": 0,
  "currency": "string",
  "delivery": {
    "method": "email",
    "email_address": "string",
    "deliver_at": "2025-01-01T00:00:00Z",
    "first_name": "string",
    "last_name": "string",
    "recipient_address": {
      "phone": "string",
      "street1": "string",
      "street2": "string",
      "city": "string",
      "region": "string",
      "postal_code": "string",
      "country": "string",
      "geo_code": "string"
    },
    "gifter_name": "string",
    "personal_message": "string"
  }
}

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