List gift cards for a buyer

List all the stored gift cards for a specific buyer.

GET /buyers/gift-cards

C#

C#

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"
);

ListBuyerGiftCardsRequest req = new ListBuyerGiftCardsRequest() {};

var res = await sdk.Buyers.GiftCards.ListAsync(req);

// handle response

200

{
  "items": [
    {
      "merchant_account_id": "<string>",
      "bin": "<string>",
      "sub_bin": "<string>",
      "last4": "<string>",
      "usage_count": 123,
      "cit_usage_count": 123,
      "type": "gift-card",
      "id": "356d56e5-fe16-42ae-97ee-8d55d846ae2e",
      "currency": "AUD",
      "expiration_date": "2013-07-16T19:23:00.000+00:00",
      "balance": 1299,
      "balance_error_code": "incorrect_currency",
      "balance_raw_error_code": "10363",
      "balance_raw_error_message": "This currency is not supported by the merchant.",
      "last_used_at": "2013-07-16T19:23:00.000+00:00",
      "cit_last_used_at": "2013-07-16T19:23:00.000+00:00"
    }
  ]
}

This endpoint requires the gift-cards.read or embed 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.

Example:

"default"

Query Parameters

buyer_external_identifier · string | null

buyer_id · string<uuid> | null

sort_by · Sort By · string Sort By · string Sort By · string Sort By · string

The field to sort the gift cards by.

Allowed value: "last_used_at"

Example:

"last_used_at"

order_by · enum<string> · default: desc

The direction to sort the gift cards in.

Available options: asc, desc

Example:

"desc"

Response

200

application/json

Successful Response

items · GiftCardSummary · object[] · required

A list of items returned for this request.

Show child attributes