README.md

Balances

(giftCards.balances)

Overview

Available Operations

• list - List gift card balances

list

Fetch the balances for one or more gift cards.

Example Usage

import { Gr4vy } from "@gr4vy/sdk";

const gr4vy = new Gr4vy({
  merchantAccountId: "<id>",
  server: "sandbox",
  id: "example",
  bearerAuth: withToken({
    privateKey: fs.readFileSync("private_key.pem", "utf8"),
  }),
});

async function run() {
  const result = await gr4vy.giftCards.balances.list({
    items: [
      {
        id: "356d56e5-fe16-42ae-97ee-8d55d846ae2e",
      },
      {
        id: "356d56e5-fe16-42ae-97ee-8d55d846ae2e",
      },
      {
        number: "4123455541234561234",
        pin: "1234",
      },
    ],
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { Gr4vyCore } from "@gr4vy/sdk/core.js";
import { withToken } from "@gr4vy/sdk/lib/auth.js";
import { giftCardsBalancesList } from "@gr4vy/sdk/funcs/giftCardsBalancesList.js";

// Use `Gr4vyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const gr4vy = new Gr4vyCore({
  merchantAccountId: "<id>",
  server: "sandbox",
  id: "example",
  bearerAuth: withToken({
    privateKey: fs.readFileSync("private_key.pem", "utf8"),
  }),
});

async function run() {
  const res = await giftCardsBalancesList(gr4vy, {
    items: [
      {
        id: "356d56e5-fe16-42ae-97ee-8d55d846ae2e",
      },
      {
        id: "356d56e5-fe16-42ae-97ee-8d55d846ae2e",
      },
      {
        number: "4123455541234561234",
        pin: "1234",
      },
    ],
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("giftCardsBalancesList failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
giftCardBalanceRequest	components.GiftCardBalanceRequest	✔️	N/A
merchantAccountId	string	➖	The ID of the merchant account to use for this request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.GiftCardSummaries>

Errors

Error Type	Status Code	Content Type
errors.Error400	400	application/json
errors.Error401	401	application/json
errors.Error403	403	application/json
errors.Error404	404	application/json
errors.Error405	405	application/json
errors.Error409	409	application/json
errors.HTTPValidationError	422	application/json
errors.Error425	425	application/json
errors.Error429	429	application/json
errors.Error500	500	application/json
errors.Error502	502	application/json
errors.Error504	504	application/json
errors.SDKError	4XX, 5XX	*/*