Create Gift Card

post

https://{subdomain}.{domain}/v2/gift_cards

Purchase a gift card on the gifter's account.

Note: To use the gift cards API endpoints, some configuration is required. Please see our docs for further instructions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

product_code

string

required

The product code of the gift card product.

unit_amount_in_cents

integer

required

The amount of the gift card. Must match an amount on the gift card product.

currency

string

required

The currency of the unit_amount_in_cents.

tax_service_opt_out

boolean

Defaults to false

Set to true to bypass sending the purchase to your configured tax service. Defaults to false.

delivery

object

required

Block of delivery information. Includes the params method through personal_message below.

method

string

required

Whether the delivery method is email or post.

deliver_at

date-time

When the gift card should be delivered to the recipient. If null, the gift card will be delivered immediately. If a datetime is provided, the delivery will be in an hourly window, rounding down. For example, 6:23 pm will be in the 6:00 pm hourly batch. Must be at least an hour in the future and less than a year in the future

email_address

string

The email address of the recipient. Required if method = email.

first_name

string

The first name of the recipient.

last_name

string

The last name of the recipient.

address

object

Block of address information for the recipient. Includes the params address1 through phone below. Required if method = post.

address1

string

The first street address line of the recipient. Required if method = post.

address2

string

The second street address line of the recipient.

city

string

The city of the recipient. Required if method = post.

state

string

The state/province of the recipient. Required if method = post and country = US, CA, IT or NL.

zip

string

The zip/postal code of the recipient. Required if method = post.

country

string

The country of the recipient. Required if method = post.

phone

string

The phone number of the recipient.

gifter_name

string

The name of the gifter for the purpose of message displays to the recipient.

personal_message

string

The personal message from the gifter to the recipient. 255 characters.

gifter_account

object

required

Block of account details for the gifter. This can reference an existing account_code or create a new account using the Account objects params. An account_code is required.

account_code

string

required

The account code of the gifter's account.

billing_info

object

Accepts nested three_d_secure_action_result_token_id (string)

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/xml

201

404