Skip to main content
POST
/
gift-cards
/
balances
Verify and check gift card balances
using RestSharp;


var options = new RestClientOptions("https://api.sandbox.{id}.gr4vy.app/gift-cards/balances");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);
{
  "items": [
    {
      "type": "gift-card",
      "id": "e6cdf979-87e2-4796-8ff6-9784d5aed893",
      "merchant_account_id": "default",
      "bin": "412345",
      "sub_bin": "554",
      "last4": "1234",
      "expiration_date": "2013-07-16T19:23:00.000+00:00",
      "balance": 1299,
      "currency": "USD",
      "balance_error_code": "incorrect_currency",
      "balance_raw_error_code": "10363",
      "balance_raw_error_message": "This currency is not supported by the merchant."
    }
  ]
}
This endpoint requires the gift-cards.read scope.

Authorizations

Authorization
string
header
required

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

Body

application/json

A request to check the balance for a set of stored and non-stored gift cards.

items
(Gift Card Balance (New) · object | Gift Card Balance (Stored) · 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.

Minimum array length: 1

Check the balance for a non-stored gift card.

Response

Returns the balances for each of the gift cards. Balances are returned in the same order they are requested.

A list of gift cards in a short format including the latest balance.

items
A stored gift card (summary) · object[]

A list of stored gift cards.