Skip to main content

GiftcardItem

gift_card_id stringrequired

'uuid' of individual gift card from partner sales channel.

redemption_method stringrequired

How gift card should be delivered.

Possible values: [text, email]

recipient_name stringrequired

Name of the recipient

recipient_email string

Email address of the recipient (email delivery only). Note that this should be omitted if 'bypass' is enabled.

recipient_phone_number string

Phone number of the recipient (text delivery only). In E.164 Format. Note that this should be omitted if 'bypass' is enabled.

sender_name stringrequired

Name of the purchaser

sender_email string

Email address of the purchaser

custom_message stringnullable

Custom message added to redemption communications

value int32required

Card value in pennies. The maximum amount that can be provisioned is $250.

search_provider string

Search result source. Defaults to Yelp

Possible values: [yelp]

card_program string

Used to provision a choose your own card type. Note that the business_id field should be omitted if this field is populated.

Possible values: [choose_your_own_restaurant, choose_your_own_salon]

business_id stringrequired

Business 'id' from search results

GiftcardItem
{
"gift_card_id": "string",
"redemption_method": "text",
"recipient_name": "string",
"recipient_email": "string",
"recipient_phone_number": "string",
"sender_name": "string",
"sender_email": "string",
"custom_message": "string",
"value": 0,
"search_provider": "yelp",
"card_program": "choose_your_own_restaurant",
"business_id": "string"
}