List gift cards

This endpoint requires the gift-cards.read scope.

Authorizations

Authorization

string

headerrequired

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

Query Parameters

buyer_id

string

Filters the results to only the items for which the buyer has an id that matches this value.

buyer_external_identifier

string

Filters the results to only the items for which the buyer has an external_identifier that matches this value.

limit

integer

default: 20

Defines the maximum number of items to return for this request.

Required range: 1 < x < 100

cursor

string

A cursor that identifies the page of results to return. This is used to paginate the results of this API.

For the first page of results, this parameter can be left out. For additional pages, use the value returned by the API in the next_cursor field. Similarly the previous_cursor can be used to reverse backwards in the list.

Response

200 - application/json

A list of stored gift cards.

items

object[]

A list of stored gift cards.

items.type

enum<string>

The type of this resource.

Available options:

gift-card

items.id

string

The ID of this gift card.

items.merchant_account_id

string

The unique ID for a merchant account.

items.service

object

An configured gift card service.

items.bin

string

The first 6 digits of the full gift card number.

items.sub_bin

string

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

items.last4

string

The last 4 digits for the gift card.

items.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.

items.buyer

object

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

items.buyer.type

enum<string>

The type of this resource. Is always buyer.

Available options:

buyer

items.buyer.id

string

The unique Gr4vy ID for this buyer.

items.buyer.billing_details

object

The billing details associated with a buyer.

items.buyer.billing_details.type

enum<string>

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

Available options:

billing-details

items.buyer.billing_details.first_name

string | null

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

Required string length: 1 - 255

items.buyer.billing_details.last_name

string | null

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

Required string length: 1 - 255

items.buyer.billing_details.email_address

string | null

The email address of the buyer.

Required string length: 1 - 320

items.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

items.buyer.billing_details.address

object

The billing address of the buyer.

items.buyer.billing_details.tax_id

object

The tax information associated with the billing details.

items.buyer.created_at

string

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

items.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

items.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

items.buyer.merchant_account_id

string

The unique ID for a merchant account.

items.buyer.updated_at

string

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

items.created_at

string

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

items.updated_at

string

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

limit

integer

default: 20

The limit applied to request. This represents the number of items that are at maximum returned by this request.

Required range: 1 < x < 100

next_cursor

string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000

previous_cursor

string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000

Payments

Instruments

Vault

Connections

Dashboard

Errors

List gift cards

Authorizations

Query Parameters

Response