Store gift card

Stores a gift card.

Vaulting a gift card stores and validate it against the active gift card service.

It is only possible to store a gift card against a buyer if the same card is not already stored on the buyer and the gift card has not expired yet.

Buyers by default can only have a maximum limit of 10 gift cards stored against them. Please contact our team to change this limit. To clear out any expired or empty gift cards, you can call the GET /buyers/gift-cards endpoint which will automatically archive any of those cards and allow new cards to be stored.

POST

gift-cards

curl --request POST \
  --url https://api.{gr4vy_id}.gr4vy.app/gift-cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "number": "4123455541234561234",
  "pin": "1234"
}'

{
  "type": "gift-card",
  "id": "e6cdf979-87e2-4796-8ff6-9784d5aed893",
  "merchant_account_id": "default",
  "service": {
    "type": "gift-card-service",
    "id": "6c020bf3-179b-4f4f-858d-84e39e196e0f",
    "merchant_account_id": "default",
    "gift_card_service_definition_id": "qwikcilver-gift-card",
    "display_name": "Qwikcilver UK",
    "active": true,
    "fields": [
      {
        "key": "secret_key",
        "value": "sk_test_26PHem9AhJZvU623DfE1x4sd"
      }
    ],
    "created_at": "2012-12-12T10:53:43+00:00",
    "updated_at": "2012-12-12T10:53:43+00:00"
  },
  "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",
    "billing_details": {
      "type": "billing-details",
      "first_name": "John",
      "last_name": "Lunn",
      "email_address": "john@example.com",
      "phone_number": "+1234567890",
      "address": {
        "city": "London",
        "country": "GB",
        "postal_code": "789123",
        "state": "Greater London",
        "state_code": "GB-LND",
        "house_number_or_name": "10",
        "line1": "10 Oxford Street",
        "line2": "New Oxford Court",
        "organization": "Gr4vy"
      },
      "tax_id": {
        "value": "12345678931",
        "kind": "gb.vat"
      }
    },
    "created_at": "2013-07-16T19:23:00.000+00:00",
    "display_name": "John L.",
    "external_identifier": "user-789123",
    "merchant_account_id": "default",
    "updated_at": "2013-07-16T19:23:00.000+00:00",
    "account_number": "1234567"
  },
  "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.write scope.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The gift card details to store.

Response

201

application/json

Returns the stored gift card.

A gift card stored for a buyer, or used in a transaction.

Verify & get balance Get gift card

curl --request POST \
  --url https://api.{gr4vy_id}.gr4vy.app/gift-cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "number": "4123455541234561234",
  "pin": "1234"
}'

{
  "type": "gift-card",
  "id": "e6cdf979-87e2-4796-8ff6-9784d5aed893",
  "merchant_account_id": "default",
  "service": {
    "type": "gift-card-service",
    "id": "6c020bf3-179b-4f4f-858d-84e39e196e0f",
    "merchant_account_id": "default",
    "gift_card_service_definition_id": "qwikcilver-gift-card",
    "display_name": "Qwikcilver UK",
    "active": true,
    "fields": [
      {
        "key": "secret_key",
        "value": "sk_test_26PHem9AhJZvU623DfE1x4sd"
      }
    ],
    "created_at": "2012-12-12T10:53:43+00:00",
    "updated_at": "2012-12-12T10:53:43+00:00"
  },
  "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",
    "billing_details": {
      "type": "billing-details",
      "first_name": "John",
      "last_name": "Lunn",
      "email_address": "john@example.com",
      "phone_number": "+1234567890",
      "address": {
        "city": "London",
        "country": "GB",
        "postal_code": "789123",
        "state": "Greater London",
        "state_code": "GB-LND",
        "house_number_or_name": "10",
        "line1": "10 Oxford Street",
        "line2": "New Oxford Court",
        "organization": "Gr4vy"
      },
      "tax_id": {
        "value": "12345678931",
        "kind": "gb.vat"
      }
    },
    "created_at": "2013-07-16T19:23:00.000+00:00",
    "display_name": "John L.",
    "external_identifier": "user-789123",
    "merchant_account_id": "default",
    "updated_at": "2013-07-16T19:23:00.000+00:00",
    "account_number": "1234567"
  },
  "created_at": "2013-07-16T19:23:00.000+00:00",
  "updated_at": "2013-07-16T19:23:00.000+00:00"
}