GET
/
gift-cards
/
{gift_card_id}
C#
using Gr4vy;
using Gr4vy.Models.Components;

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

var res = await sdk.GiftCards.GetAsync(giftCardId: "356d56e5-fe16-42ae-97ee-8d55d846ae2e");

// handle response
{
  "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"
}
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 | null

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

Examples:

"default"

Path Parameters

​
gift_card_id
string<uuid>
required

The ID of the gift card.

Examples:

"356d56e5-fe16-42ae-97ee-8d55d846ae2e"

Response

Successful Response

​
id
string<uuid>
required

The ID for the gift card.

Examples:

"356d56e5-fe16-42ae-97ee-8d55d846ae2e"

​
merchant_account_id
string
required

The ID of the merchant account this buyer belongs to.

Examples:

"default"

​
gift_card_service
object
required

The service this gift card belongs to.

​
bin
string
required

The first 6 digits of the full gift card number.

Examples:

"412345"

​
sub_bin
string
required

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

Examples:

"554"

​
last4
string
required

The last 4 digits for the gift card.

Examples:

"1234"

​
created_at
string<date-time>
required

The date this gift card record was created at.

Examples:

"2013-07-16T19:23:00.000+00:00"

​
updated_at
string<date-time>
required

The date this gift card record was last updated at.

Examples:

"2013-07-16T19:23:00.000+00:00"

​
type
string
default:gift-card

Always gift-card.

Allowed value: "gift-card"
Examples:

"gift-card"

​
expiration_date
string<date-time> | 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.

Examples:

"2013-07-16T19:23:00.000+00:00"

​
buyer
object | null

The buyer for which this gift card is stored.