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

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.

Examples:

"default"

Query Parameters

timeout_in_seconds
number
default:1

Body

application/json

Response

200
application/json
Successful Response

The response is of type object.