Docs API Reference Contact Credit/bff/contact-credit/list

/bff/contact-credit/list

Returns the current credit balance (both in credits and monetary value) and a list of credit transactions for a contact. The creditMoney / amountMoney / balanceMoney values are in the organisation default currency (currency) and are purely bookkeeping — the order payment logic always uses 1 credit = 1 unit of money. Each item may include an optional reason selected from the per-organisation credit-reason catalog.

Contact CreditgetBffContact-creditList

Parameters

1 query

1 total

Query · 1

customerIdstringRequired

Contact external ID.

Request

GET /bff/contact-credit/list

get

curl -X GET "https://api.bizkithub.com/bff/contact-credit/list?customerId=abc123def456ghij" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "credit": 3300,
  "creditMoney": 3000,
  "currency": "CZK",
  "items": [
    {
      "id": "HxanU4a1n4El61zx",
      "amount": 3300,
      "amountMoney": 3000,
      "balance": 3300,
      "balanceMoney": 3000,
      "order": {
        "orderNumber": "25000087",
        "hash": "sSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S",
        "groupName": "GymRoom Vinohrady"
      },
      "expiration": {
        "date": "2026-12-31T00:00:00.000Z"
      },
      "reason": {
        "externalId": "rsn1234567890abc",
        "code": "cleaning-complaint",
        "name": "Reklamace úklidu"
      },
      "payerBranch": {
        "slug": "example_slug",
        "name": "example_name"
      },
      "linkedWriteoff": {
        "externalId": "example_externalId",
        "isDeleted": false
      },
      "description": "Order 25000087",
      "insertedDate": "2026-04-21T10:00:00.000Z"
    }
  ],
  "itemCount": 42
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key