Create gift card

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",
    "gift_card_service_definition_id": "mock-gift-card",
    "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",
  "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": "[email protected]",
      "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>",
        "kind": "ae.trn"
      }
    },
    "account_number": "<string>"
  }
}

POST

gift-cards

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",
    "gift_card_service_definition_id": "mock-gift-card",
    "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",
  "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": "[email protected]",
      "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>",
        "kind": "ae.trn"
      }
    },
    "account_number": "<string>"
  }
}

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

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

Body

application/json

number

string

required

The 16-19 digit number for the gift card.

Required string length: 16 - 19

string

required

The PIN for this gift card.

Minimum string length: 1

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

string<uuid>

required

The ID for the gift card.

merchant_account_id

string

required

The ID of the merchant account this buyer belongs to.

gift_card_service

GiftCardService · object

required

The service this gift card belongs to.

Show child attributes

gift_card_service.id

string<uuid>

required

The ID for the gift card service.

gift_card_service.gift_card_service_definition_id

enum<string>

required

The ID of the definition for this service.

Available options:

mock-gift-card,

qwikcilver-gift-card

gift_card_service.display_name

string

required

The display name for the gift card service.

Required string length: 1 - 200

gift_card_service.type

string

default:gift-card-service

Always gift-card-service.

Allowed value: "gift-card-service"

bin

string

required

The first 6 digits of the full gift card number.

sub_bin

string

required

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

last4

string

required

The last 4 digits for the gift card.

created_at

string<date-time>

required

The date this gift card record was created at.

updated_at

string<date-time>

required

The date this gift card record was last updated at.

type

string

default:gift-card

Always gift-card.

Allowed value: "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.

Show child attributes

buyer.merchant_account_id

string

required

The ID of the merchant account this buyer belongs to.

buyer.created_at

string<date-time>

required

The date this buyer was created at.

buyer.updated_at

string<date-time>

required

The date this buyer was last updated at.

buyer.type

string

default:buyer

Always buyer.

Allowed value: "buyer"

buyer.id

string<uuid> | null

The ID for the buyer.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

buyer.display_name

string | null

The display name for the buyer.

Required string length: 1 - 200

Example:

"John Doe"

buyer.external_identifier

string | null

The merchant identifier for this buyer.

Required string length: 1 - 200

Example:

"buyer-12345"

buyer.billing_details

BillingDetails · object

The billing name, address, email, and other fields for this buyer.

Show child attributes

buyer.billing_details.first_name

string | null

The first name(s) or given name for the buyer.

Required string length: 1 - 255

Example:

"John"

buyer.billing_details.last_name

string | null

The last name, or family name, of the buyer.

Required string length: 1 - 255

Example:

"Doe"

buyer.billing_details.email_address

string | null

The email address for the buyer.

Required string length: 1 - 320

Example:

"[email protected]"

buyer.billing_details.phone_number

string | null

The phone number for the buyer which should be formatted according to the E164 number standard.

Example:

"+1234567890"

buyer.billing_details.address

Address · object

The billing address for the buyer.

Show child attributes

buyer.billing_details.address.city

string | null

The city for the address.

Required string length: 1 - 100

Example:

"San Jose"

buyer.billing_details.address.country

string | null

The country for the address in ISO 3166 format.

Example:

"US"

buyer.billing_details.address.postal_code

string | null

The postal code or zip code for the address.

Required string length: 1 - 50

Example:

"94560"

buyer.billing_details.address.state

string | null

The state, county, or province for the address.

Required string length: 1 - 255

Example:

"California"

buyer.billing_details.address.state_code

string | null

The code of state, county, or province for the address in ISO 3166-2 format.

Example:

"US-CA"

buyer.billing_details.address.house_number_or_name

string | null

The house number or name for the address. Not all payment services use this field but some do.

Required string length: 1 - 255

Example:

"10"

buyer.billing_details.address.line1

string | null

The first line of the address.

Required string length: 1 - 255

Example:

"Stafford Appartments"

buyer.billing_details.address.line2

string | null

The second line of the address.

Required string length: 1 - 255

Example:

"29th Street"

buyer.billing_details.address.organization

string | null

The optional name of the company or organisation to add to the address.

Required string length: 1 - 255

Example:

"Gr4vy"

buyer.billing_details.tax_id

TaxId · object

The tax ID information associated with the billing details.

Show child attributes

buyer.billing_details.tax_id.value

string

required

The tax ID for the buyer.

Required string length: 1 - 50

buyer.billing_details.tax_id.kind

enum<string>

required

The kind of tax ID

Available options:

ae.trn,

au.abn,

ar.dni,

ar.cuil,

ar.cuit,

br.cnpj,

br.cpf,

ca.bn,

ca.gst_hst,

ca.pst_bc,

ca.pst_mb,

ca.pst_sk,

ca.qst,

ch.vat,

cl.tin,

co.itin,

co.nit,

es.cif,

eu.vat,

gb.vat,

hk.br,

id.nik,

id.npwp,

in.gst,

in.pan,

jp.cn,

jp.rn,

kr.brn,

li.uid,

mx.curp,

mx.rfc,

my.frp,

my.itn,

my.nric,

my.sst,

no.vat,

nz.gst,

pe.ruc,

ph.tin,

ru.inn,

ru.kpp,

sa.vat,

sg.gst,

sg.uen,

th.id,

th.vat,

tw.vat,

us.ein,

za.vat,

bo.ci,

uy.rut,

uy.ci

buyer.account_number

string | null

The buyer account number

Required string length: 1 - 200

Verify and get gift card balances

Get gift card

⌘I

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Refunds

Sessions

Instruments

Vault

Connections

Errors

Other

Create gift card

Authorizations

Headers

Body

Response