Skip to main content
POST
/
gift-cards
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.CreateAsync(giftCardCreate: new GiftCardCreate() {
    Number = "4123455541234561234",
    Pin = "1234",
});

// handle response
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merchant_account_id": "<string>",
  "gift_card_service": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "display_name": "<string>",
    "type": "gift-card-service"
  },
  "bin": "<string>",
  "sub_bin": "<string>",
  "last4": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "usage_count": 123,
  "cit_usage_count": 123,
  "type": "gift-card",
  "expiration_date": "2013-07-16T19:23:00.000+00:00",
  "buyer": {
    "merchant_account_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "type": "buyer",
    "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
    "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": "<string>"
      }
    },
    "account_number": "<string>"
  },
  "last_used_at": "2013-07-16T19:23:00.000+00:00",
  "cit_last_used_at": "2013-07-16T19:23:00.000+00:00"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gr4vy.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint requires the gift-cards.write 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.

Example:

"default"

Body

application/json
​
number
string
required

The 16-19 digit number for the gift card.

Required string length: 16 - 19
Pattern: ^\d+$
Example:

"4123455541234561234"

​
pin
string
required

The PIN for this gift card.

Minimum string length: 1
Example:

"1234"

​
buyer_id
string<uuid> | null

The ID of the buyer to associate this gift card to. If this field is provided then the buyer_external_identifier field needs to be unset.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

​
buyer_external_identifier
string | null

The external_identifier of the buyer to associate this gift card to. If this field is provided then the buyer_id field needs to be unset.

Required string length: 1 - 200
Example:

"buyer-12345"

Response

Successful Response

​
id
string<uuid>
required

The ID for the gift card.

Example:

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

​
merchant_account_id
string
required

The ID of the merchant account this buyer belongs to.

Example:

"default"

​
gift_card_service
GiftCardService · object
required

The service this gift card belongs to.

​
bin
string
required

The first 6 digits of the full gift card number.

Example:

"412345"

​
sub_bin
string
required

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

Example:

"554"

​
last4
string
required

The last 4 digits for the gift card.

Example:

"1234"

​
created_at
string<date-time>
required

The date this gift card record was created at.

Example:

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

​
updated_at
string<date-time>
required

The date this gift card record was last updated at.

Example:

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

​
usage_count
integer
required

The number of times this gift card has been used in transactions.

Example:

100

​
cit_usage_count
integer
required

The number of times this gift card has been used in transactions for client initiated transactions.

Example:

50

​
type
string
default:gift-card

Always gift-card.

Allowed value: "gift-card"
Example:

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

Example:

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

​
buyer
Buyer · object

The buyer for which this gift card is stored.

​
last_used_at
string<date-time> | null

The timestamp when this gift card was last used in a transaction.

Example:

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

​
cit_last_used_at
string<date-time> | null

The timestamp when this gift card was last used in a transaction for client initiated transactions.

Example:

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