Create a Gift Card

Gift cards let you define a marketing template (name, image, face value, currency) and issue redeemable codes with a monetary balance. Codes can exist without a member assignment, or be linked to a member account. Balance is stored in cents on each code for internal cards; Shopify-linked cards will query external balance in a future release.

Typical workflow:

  1. Create a gift card template (POST /v1/gift-card).
  2. Issue one or more codes (POST /v1/gift-card/{gift_card_id}/codes/create).
  3. Optionally assign a code to a member (POST /v1/gift-card/code/{code}/assign).
  4. Check balance before checkout (GET /v1/gift-card/code/{code}).
  5. Redeem fully or partially at payment time (POST /v1/gift-card/code/{code}/redeem).
  6. Refund a previous redemption if needed (POST /v1/gift-card/transaction/{transaction_id}/refund).

OAuth scopes: read_gift_card for read endpoints, write_gift_card for create/update/redeem/refund.

Create a new gift card marketing template.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to Holiday Gift Card

Display name shown in apps and balance lookups.

string
Defaults to Redeemable store credit for the holiday season.
string

UUID of an uploaded image file used as the gift card artwork.

int32
required
Defaults to 5000

Default face value in cents issued to new codes (e.g. EUR 50.00 = 5000).

string
required
Defaults to EUR

ISO 4217 currency code copied to issued codes.

boolean
Defaults to true

Whether the template is active for issuing new codes.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json