GiftcardTransaction
Unique transaction Id of entire purchase from partner sales channel. Acts as Idempotency key
Store identifier assigned to partner by Giftcard Market
gift_cards object[]required
'uuid' of individual gift card from partner sales channel.
How gift card should be delivered.
Possible values: [text
, email
]
Name of the recipient
Email address of the recipient (email delivery only). Note that this should be omitted if 'bypass' is enabled.
Phone number of the recipient (text delivery only). In E.164 Format. Note that this should be omitted if 'bypass' is enabled.
Name of the purchaser
Email address of the purchaser
Custom message added to redemption communications
Card value in pennies. The maximum amount that can be provisioned is $250.
Search result source. Defaults to Yelp
Possible values: [yelp
]
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' from search results
Determines if the MFA requirement will be handled by the provisioning partners or if Gift Card Market will manage the user verification in the redemption page. If this is enabled then the redemption method and recipient contact information should be omitted.
{
"transaction_id": "string",
"store_id": "string",
"gift_cards": [
{
"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"
}
],
"bypass": true
}