StoredCreditAccount

A stored credit account contains all balance changes.

Retrieve a stored credit account by its code

get

Retrieve a stored credit account by its unique code. The response includes details such as the balance, status, and validity period.

Authorizations

x_api_key

x-api-keystringRequired

Value for the x-api-key header parameter.

Path parameters

codestringRequired

StoredCreditAccount identifier

Responses

200

StoredCreditAccount resource

application/jsonapplication/ld+json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

404

Not found

application/ld+jsonapplication/problem+jsonapplication/json

get

/credit_accounts/{code}

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "createdAt": "2026-01-09T22:37:41.247Z",
  "updatedAt": "2026-01-09T22:37:41.247Z",
  "contact": "https://example.com/",
  "giftCard": {
    "id": 1,
    "createdAt": "2026-01-09T22:37:41.247Z",
    "updatedAt": "2026-01-09T22:37:41.247Z",
    "contact": "https://example.com/",
    "status": "Chargeback",
    "expiresAt": null,
    "validFrom": "2026-01-09T22:37:41.247Z",
    "partiallyRedeemable": true,
    "name": "text",
    "topupable": false,
    "terms": "",
    "selectedOptions": [
      {}
    ],
    "recipientDescription": "",
    "usingRecipientDescription": false,
    "description": "",
    "personalMessage": "",
    "class": "Standard",
    "redeemInstructions": "",
    "lastRedeemedAt": null,
    "purchaserName": "",
    "deliveryName": ""
  },
  "balances": [
    "https://example.com/"
  ],
  "attachedMember": "https://example.com/",
  "type": "Gift Card",
  "currencyCode": "text",
  "code": "text"
}

Retrieve the balance events for a gift card

get

Retrieve all balance transactions for a specific gift card by its code.

Authorizations

x_api_key

x-api-keystringRequired

Value for the x-api-key header parameter.

Path parameters

codestringRequired

StoredCreditAccount identifier

Responses

200

StoredCreditAccount resource

application/jsonapplication/ld+json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

404

Not found

application/ld+jsonapplication/problem+jsonapplication/json

get

/credit_accounts/{code}/balances

HTTPcURLJavaScriptPython

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

{
  "balances": [
    {
      "id": 1,
      "createdAt": "2026-01-09T22:37:41.247Z",
      "updatedAt": "2026-01-09T22:37:41.247Z",
      "type": "Activation",
      "amount": 1,
      "location": {},
      "happenedAt": "2026-01-09T22:37:41.247Z",
      "expiresAt": null,
      "reversed": {
        "id": 1,
        "createdAt": "2026-01-09T22:37:41.247Z",
        "updatedAt": "2026-01-09T22:37:41.247Z",
        "type": "Activation",
        "amount": 1,
        "location": {},
        "happenedAt": "2026-01-09T22:37:41.247Z",
        "expiresAt": null,
        "reversed": "[Circular Reference]",
        "mewsPayment": {},
        "storedCreditAccount": "https://example.com/"
      },
      "mewsPayment": {},
      "storedCreditAccount": "https://example.com/"
    }
  ]
}

Redeem a gift card

post

Redeem a gift card by providing the amount and currency.

Authorizations

x_api_key

x-api-keystringRequired

Value for the x-api-key header parameter.

Path parameters

codestringRequired

StoredCreditAccount identifier

Body

application/jsonapplication/ld+json

amountintegerRequired

locationintegerOptional

currencystringOptional

Responses

201

StoredCreditAccount resource created

application/jsonapplication/ld+json

400

Invalid input

application/ld+jsonapplication/problem+jsonapplication/json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

422

An error occurred

application/ld+jsonapplication/problem+jsonapplication/json

post

/credit_accounts/{code}/redeem

HTTPcURLJavaScriptPython

POST /credit_accounts/{code}/redeem HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "amount": 1,
  "location": 1,
  "currency": "text"
}

application/jsonapplication/ld+json

{
  "id": 1,
  "createdAt": "2026-01-09T22:37:41.247Z",
  "updatedAt": "2026-01-09T22:37:41.247Z",
  "type": "Activation",
  "amount": 1,
  "location": {},
  "happenedAt": "2026-01-09T22:37:41.247Z",
  "expiresAt": null,
  "reversed": {
    "id": 1,
    "createdAt": "2026-01-09T22:37:41.247Z",
    "updatedAt": "2026-01-09T22:37:41.247Z",
    "type": "Activation",
    "amount": 1,
    "location": {},
    "happenedAt": "2026-01-09T22:37:41.247Z",
    "expiresAt": null,
    "reversed": {
      "id": 1,
      "createdAt": "2026-01-09T22:37:41.247Z",
      "updatedAt": "2026-01-09T22:37:41.247Z",
      "type": "Activation",
      "amount": 1,
      "location": {},
      "happenedAt": "2026-01-09T22:37:41.247Z",
      "expiresAt": null,
      "reversed": "[Circular Reference]",
      "mewsPayment": {},
      "storedCreditAccount": "https://example.com/"
    },
    "mewsPayment": {},
    "storedCreditAccount": "https://example.com/"
  },
  "mewsPayment": {},
  "storedCreditAccount": "https://example.com/"
}