POST
/
gift-cards

This endpoint requires the gift-cards.write scope.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The gift card details to store.

number
string
required

The 16-19 digit number for this gift card.

Required string length: 16 - 19
pin
string
required

The PIN for this gift card.

buyer_external_identifier
string

The external_identifier of the buyer to associate this gift card to. If this field is provided then the buyer_id field needs to be unset.

buyer_id
string

The ID of the buyer to associate this gift card to. If this field is provided then the buyer_external_identifier field needs to be unset.

Response

201 - application/json

A gift card stored for a buyer, or used in a transaction.

bin
string

The first 6 digits of the full gift card number.

buyer
object

The optional buyer for which this payment method has been stored.

created_at
string

The date and time when this gift card was created in our system.

expiration_date
string | null

The date and time when this gift card expires. This is a full date/time and may be more accurate than the actual expiry date received by the gift card service.

id
string

The ID of this gift card.

last4
string

The last 4 digits for the gift card.

merchant_account_id
string

The unique ID for a merchant account.

service
object

An configured gift card service.

sub_bin
string

The 3 digits after the bin of the full gift card number.

type
enum<string>

The type of this resource.

Available options:
gift-card
updated_at
string

The date and time when this gift card was last updated in our system.