younifyd
Menu

List Gift Cards

List gift cards

GET/gift_cards

Use it in a workflow

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

Fields

baseUrlstring

The API host this action calls. Choose one, or pick Custom to enter your own.

One ofhttps://v3.recurly.comhttps://v3.eu.recurly.com__custom__Default "https://v3.recurly.com"

baseUrlCustomstring
forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

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

objectstring

Will always be List.

has_moreboolean

Indicates there are more results on subsequent pages.

nextstring

Path to subsequent page of results.

dataarray<object>
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.

deliveryobject8 fields

Gift card delivery details

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
{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "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.