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",
  "buyer_id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
  "buyer_external_identifier": "user-789123"
}'
{
  "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"
  },
  "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
headerrequired

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

Body

application/json
number
string
required

The 16-19 digit number for this gift card.

pin
string
required

The PIN for this gift card.

buyer_id
string

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.

buyer_external_identifier
string

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.

Response

201 - application/json
type
enum<string>

The type of this resource.

Available options:
gift-card
id
string

The ID of this gift card.

merchant_account_id
string

The unique ID for a merchant account.

service
object

An configured gift card service.

bin
string

The first 6 digits of the full gift card number.

sub_bin
string

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

last4
string

The last 4 digits for the gift card.

expiration_date
string | 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.

buyer
object

The optional buyer for which this payment method has been stored.

created_at
string

The date and time when this gift card was created in our system.

updated_at
string

The date and time when this gift card was last updated in our system.