GET
/
gift-cards
using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

ListGiftCardsRequest req = new ListGiftCardsRequest() {};

ListGiftCardsResponse? res = await sdk.GiftCards.ListAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}
{
  "items": [
    {
      "type": "gift-card",
      "id": "356d56e5-fe16-42ae-97ee-8d55d846ae2e",
      "merchant_account_id": "default",
      "gift_card_service": {
        "type": "gift-card-service",
        "id": "35b60feec-a7c7-4844-b503-f39b09192d81",
        "gift_card_service_definition_id": "qwikcilver-gift-card",
        "display_name": "Qwikcilver USA"
      },
      "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",
        "merchant_account_id": "default",
        "display_name": "John Doe",
        "external_identifier": "buyer-12345",
        "billing_details": {
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "john@example.com",
          "phone_number": "+1234567890",
          "address": {
            "city": "San Jose",
            "country": "US",
            "postal_code": "94560",
            "state": "California",
            "state_code": "US-CA",
            "house_number_or_name": "10",
            "line1": "Stafford Appartments",
            "line2": "29th Street",
            "organization": "Gr4vy"
          },
          "tax_id": {
            "value": "12345678931",
            "kind": "us.ein"
          }
        },
        "account_number": "<string>",
        "created_at": "2013-07-16T19:23:00.000+00:00",
        "updated_at": "2013-07-16T19:23:00.000+00:00"
      },
      "created_at": "2013-07-16T19:23:00.000+00:00",
      "updated_at": "2013-07-16T19:23:00.000+00:00"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

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.

Headers

x-gr4vy-merchant-account-id
string

The ID of the merchant account to use for this request.

Examples:

"default"

Query Parameters

buyer_external_identifier
string | null
buyer_id
string | null
cursor
string | null
limit
integer
default:20
Required range: 1 <= x <= 100

Response

200
application/json

Successful Response

items
GiftCard · object[]
required

A list of items returned for this request.

limit
integer
default:20

The number of items for this page.

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

20

next_cursor
string | null

The cursor pointing at the next page of items.

Required string length: 1 - 1000
Examples:

"ZXhhbXBsZTE"

previous_cursor
string | null

The cursor pointing at the previous page of items.

Required string length: 1 - 1000
Examples:

"Xkjss7asS"