New gift card

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

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.

buyer.billing_details

object

The billing details associated with a buyer.

buyer.billing_details.address

object

The billing address of the buyer.

buyer.billing_details.email_address

string | null

The email address of the buyer.

Required string length: 1 - 320

buyer.billing_details.first_name

string | null

The first name(s) or given name of the buyer.

Required string length: 1 - 255

buyer.billing_details.last_name

string | null

The last name, or family name, of the buyer.

Required string length: 1 - 255

buyer.billing_details.phone_number

string | null

The phone number of the buyer. This number is formatted according to the E164 number standard.

Required string length: 1 - 50

buyer.billing_details.tax_id

object

The tax information associated with the billing details.

buyer.billing_details.type

enum<string>

The type of this resource. Is always billing-details.

Available options:

billing-details

buyer.created_at

string

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

buyer.display_name

string | null

A unique name for this buyer which is used in the Gr4vy admin panel to give a buyer a human readable name.

Required string length: 1 - 200

buyer.external_identifier

string | null

An external identifier that can be used to match the buyer against your own records.

Required string length: 1 - 200

buyer.id

string

The unique Gr4vy ID for this buyer.

buyer.merchant_account_id

string

The unique ID for a merchant account.

buyer.type

enum<string>

The type of this resource. Is always buyer.

Available options:

buyer

buyer.updated_at

string

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

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.

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.

Payments

Instruments

Vault

Connections

Dashboard

Errors

New gift card

Authorizations

Body

Response