POST
/
gift-cards
/
balances
curl --request POST \
  --url https://api.{gr4vy_id}.gr4vy.app/gift-cards/balances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "items": [
    {
      "number": "4123455541234561234",
      "pin": "1234"
    }
  ]
}'
{
  "items": [
    {
      "balance": 1299,
      "balance_error_code": "incorrect_currency",
      "balance_raw_error_code": "10363",
      "balance_raw_error_message": "This currency is not supported by the merchant.",
      "bin": "412345",
      "currency": "USD",
      "expiration_date": "2013-07-16T19:23:00.000+00:00",
      "id": "e6cdf979-87e2-4796-8ff6-9784d5aed893",
      "last4": "1234",
      "merchant_account_id": "default",
      "sub_bin": "554",
      "type": "gift-card"
    }
  ]
}

This endpoint requires the gift-cards.read scope.

This feature is in limited release and not yet available in all environments.

Authorizations

Authorization
string
headerrequired

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

Body

application/json
items
object[]

One or more gift cards to check balances for, up to a default limit of 10 gift cards. Please contact our team to change this limit.

  • Gift Card Balance (New)

  • Gift Card Balance (Stored)

Response

200 - application/json
items
object[]

A list of stored gift cards.