Create a new gift card

Creates a new gift card.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int64
required

The amount in cents which is used as the initial balance for the newly created gift card. The amount must be equal or greater than zero.

string

The ID of the card design to use for the new gift card. If no card design ID is specified, the first created and active card design is used.

string

The external ID of a location in the gift card program. This ID is can be provided instead of the location_id field. This location will be used for the initial balance topup transaction for the gift card. If this field is left empty, the primary location of the gift card program will be used.

funding_source
object

Funding source details

string

The gift card account number (card number) used for the new gift card. If the gan is provided, it cannot be already used for another gift card. The gan must be between 8 and 20 characters long. If the gan is not provided, a 16 character unique gan is generated and used for the new gift card.

string
required

A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

string

The ID of the location from where the gift card will be issued. If no location ID is specified, the primary location of the gift card program is used.

string

An optional personal message to include in the gift email sent to the recipient.

string

An internal note for the gift card. This note is not shown to the sender or recipient of the gift card.

boolean

Whether to send the gift email to the recipient's email or phone number if those fields were provided. Defaults to true.

boolean

Whether to send the gift receipt to the sender's email if it was provided. Defaults to true.

string

The gift card recipient's email address. If provided, the email is linked to the new gift card and used to send the gift received notification email to the gift recipient's email address.

string

The gift card recipient's name. If provided, the name is linked to the new gift card and used in the notification email sent to the gift recipient's email address.

string

The gift card sender's email. If provided, a receipt email will be sent to the sender with the gift card's purchase details. This receipt email does not contain any redemption details of the gift card (card number or QR code).

string

The gift card sender's name.

string
enum
required

The type of gift card. Can be either DIGITAL or PHYSICAL.

Allowed:
Responses

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