Balance

A balance represents a change to the overall balance of a gift card.

List all balances

get

Returns a list of balance events across all gift cards. The balance events are ordered by the date they happened, with the most recent first.

Authorizations

x_api_key

x-api-keystringRequired

Value for the x-api-key header parameter.

Query parameters

pageintegerOptional

The collection page number

Default: 1

createdAt[before]stringOptional

createdAt[strictly_before]stringOptional

createdAt[after]stringOptional

createdAt[strictly_after]stringOptional

updatedAt[before]stringOptional

updatedAt[strictly_before]stringOptional

updatedAt[after]stringOptional

updatedAt[strictly_after]stringOptional

happenedAt[before]stringOptional

happenedAt[strictly_before]stringOptional

happenedAt[after]stringOptional

happenedAt[strictly_after]stringOptional

expiresAt[before]stringOptional

expiresAt[strictly_before]stringOptional

expiresAt[after]stringOptional

expiresAt[strictly_after]stringOptional

typestring · enumOptionalPossible values:

amount[between]stringOptional

amount[gt]stringOptional

amount[gte]stringOptional

amount[lt]stringOptional

amount[lte]stringOptional

order[happenedAt]string · enumOptionalDefault: ascPossible values:

Responses

200

Balance collection

application/jsonapplication/ld+json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

get

/balances

HTTPcURLJavaScriptPython

GET /balances HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "createdAt": "2025-11-21T23:21:53.080Z",
    "updatedAt": "2025-11-21T23:21:53.080Z",
    "type": "Activation",
    "amount": 1,
    "location": {},
    "happenedAt": "2025-11-21T23:21:53.080Z",
    "expiresAt": null,
    "reversed": {
      "id": 1,
      "createdAt": "2025-11-21T23:21:53.080Z",
      "updatedAt": "2025-11-21T23:21:53.080Z",
      "type": "Activation",
      "amount": 1,
      "location": {},
      "happenedAt": "2025-11-21T23:21:53.080Z",
      "expiresAt": null,
      "reversed": {
        "id": 1,
        "createdAt": "2025-11-21T23:21:53.080Z",
        "updatedAt": "2025-11-21T23:21:53.080Z",
        "type": "Activation",
        "amount": 1,
        "location": {},
        "happenedAt": "2025-11-21T23:21:53.080Z",
        "expiresAt": null,
        "reversed": "[Circular Reference]",
        "mewsPayment": {},
        "attachedMember": "https://example.com/",
        "storedCreditAccount": "[Circular Reference]"
      },
      "mewsPayment": {},
      "attachedMember": "https://example.com/",
      "storedCreditAccount": {
        "balances": [
          "[Circular Reference]"
        ]
      }
    },
    "mewsPayment": {},
    "attachedMember": "https://example.com/",
    "storedCreditAccount": {
      "balances": [
        "[Circular Reference]"
      ]
    }
  }
]

Retrieve a balance event

get

Retrieves a Balance resource.

Authorizations

x_api_key

x-api-keystringRequired

Value for the x-api-key header parameter.

Path parameters

idstringRequired

Balance identifier

Responses

200

Balance resource

application/jsonapplication/ld+json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

404

Not found

application/ld+jsonapplication/problem+jsonapplication/json

get

/balances/{id}

HTTPcURLJavaScriptPython

GET /balances/{id} HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "createdAt": "2025-11-21T23:21:53.080Z",
  "updatedAt": "2025-11-21T23:21:53.080Z",
  "type": "Activation",
  "amount": 1,
  "location": {},
  "happenedAt": "2025-11-21T23:21:53.080Z",
  "expiresAt": null,
  "reversed": {
    "id": 1,
    "createdAt": "2025-11-21T23:21:53.080Z",
    "updatedAt": "2025-11-21T23:21:53.080Z",
    "type": "Activation",
    "amount": 1,
    "location": {},
    "happenedAt": "2025-11-21T23:21:53.080Z",
    "expiresAt": null,
    "reversed": {
      "id": 1,
      "createdAt": "2025-11-21T23:21:53.080Z",
      "updatedAt": "2025-11-21T23:21:53.080Z",
      "type": "Activation",
      "amount": 1,
      "location": {},
      "happenedAt": "2025-11-21T23:21:53.080Z",
      "expiresAt": null,
      "reversed": "[Circular Reference]",
      "mewsPayment": {},
      "attachedMember": "https://example.com/",
      "storedCreditAccount": {
        "balances": "[Circular Reference]"
      }
    },
    "mewsPayment": {},
    "attachedMember": "https://example.com/",
    "storedCreditAccount": {
      "balances": "[Circular Reference]"
    }
  },
  "mewsPayment": {},
  "attachedMember": "https://example.com/",
  "storedCreditAccount": {
    "balances": "[Circular Reference]"
  }
}