GET
/
gift-cards
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/gift-cards \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "type": "gift-card",
      "id": "e6cdf979-87e2-4796-8ff6-9784d5aed893",
      "merchant_account_id": "default",
      "service": {
        "type": "gift-card-service",
        "id": "6c020bf3-179b-4f4f-858d-84e39e196e0f",
        "merchant_account_id": "default",
        "gift_card_service_definition_id": "qwikcilver-gift-card",
        "display_name": "Qwikcilver UK",
        "active": true,
        "fields": [
          {
            "key": "secret_key",
            "value": "sk_test_26PHem9AhJZvU623DfE1x4sd"
          }
        ],
        "created_at": "2012-12-12T10:53:43+00:00",
        "updated_at": "2012-12-12T10:53:43+00:00"
      },
      "bin": "412345",
      "sub_bin": "554",
      "last4": "1234",
      "expiration_date": "2013-07-16T19:23:00.000+00:00",
      "buyer": {
        "type": "buyer",
        "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
        "billing_details": {
          "type": "billing-details",
          "first_name": "John",
          "last_name": "Lunn",
          "email_address": "john@example.com",
          "phone_number": "+1234567890",
          "address": {
            "city": "London",
            "country": "GB",
            "postal_code": "789123",
            "state": "Greater London",
            "state_code": "GB-LND",
            "house_number_or_name": "10",
            "line1": "10 Oxford Street",
            "line2": "New Oxford Court",
            "organization": "Gr4vy"
          },
          "tax_id": {
            "value": "12345678931",
            "kind": "gb.vat"
          }
        },
        "created_at": "2013-07-16T19:23:00.000+00:00",
        "display_name": "John L.",
        "external_identifier": "user-789123",
        "merchant_account_id": "default",
        "updated_at": "2013-07-16T19:23:00.000+00:00",
        "account_number": "1234567"
      },
      "created_at": "2013-07-16T19:23:00.000+00:00",
      "updated_at": "2013-07-16T19:23:00.000+00:00"
    }
  ],
  "limit": 1,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": null
}

This endpoint requires the gift-cards.read scope.

Authorizations

​
Authorization
string
header
required

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.

Example:

"8724fd24-5489-4a5d-90fd-0604df7d3b83"

​
buyer_external_identifier
string

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

Example:

"user-12345"

​
limit
integer
default:20

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

Required range: 1 <= x <= 100
Example:

1

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

Example:

"ZXhhbXBsZTE"

Response

200
application/json
Returns a list of gift cards.

A list of stored gift cards.

​
items
object[]

A list of stored gift cards.

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

​
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
Example:

1

​
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
Example:

"ZXhhbXBsZTE"

​
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
Example:

null

Was this page helpful?

List gift cards for buyerVerify & get balance