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. Required when redemption_method = email, or when the transaction's deliver_to_recipient is true and this item's delivery_type = send_to_some_else. Should be omitted when bypass is true.
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. Required when the transaction's deliver_to_recipient is true and this item's delivery_type = send_to_myself. Should be omitted when bypass is true.
Required when the transaction's deliver_to_recipient is true. send_to_some_else sends the redemption email to recipient_email. send_to_myself sends it to sender_email. Should be omitted when bypass is true.
Possible values: [send_to_some_else, send_to_myself]
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_spas_and_salons, choose_your_own_burger, choose_your_own_chicken, choose_your_own_restaurant_bars, choose_your_own_restaurant_coffee, choose_your_own_serviceprovider_auto, choose_your_own_serviceprovider_home, choose_your_own_serviceprovider_personal]
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. bypass and deliver_to_recipient cannot both be true in the same request.
Determines if the USIO program used is an incentive or a consumer card.
Possible values: [incentive, consumer]
Determines if Gift Card Market emails the redemption link after provisioning. Requires redemption_method = email. When true, each item in gift_cards must set delivery_type, and the corresponding email field must be populated: send_to_some_else requires recipient_email; send_to_myself requires sender_email. Cannot be true when bypass is also true.
{
"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",
"delivery_type": "send_to_some_else",
"custom_message": "string",
"value": 0,
"search_provider": "yelp",
"card_program": "choose_your_own_restaurant",
"business_id": "string"
}
],
"bypass": true,
"card_type": "incentive",
"deliver_to_recipient": true
}