BizKitHub Developer Documentation

Parameters

2 query

Query parameters

· 2

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

identityIdstringRequired

Logged user identity (from your frontend cookies). Learn more

ExampleZ9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg

Response schema

1 status code documented

200Success

creditBalancenumberRequired

Example510

creditMoneyBalancenumberRequired

Total credit balance in the organisation default currency.

Example460

currencystringRequired

ISO 4217 code of the organisation default currency.

ExampleCZK

itemsobject[]Required

Each array item:

idstringRequired

ExampleHxanU4a1n4El61zx

amountnumberRequired

Example100

amountMoneynumberRequired

Transaction value in default currency (CZK). Defaults to same as amount (1:1).

Example90

balancenumberRequired

Example410

balanceMoneynumberRequired

Running balance in default currency (CZK).

Example370

orderobjectOptional

orderNumberstringRequired

Example25000087

hashstringRequired

ExamplesSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S

groupNamestringRequired

ExampleGymRoom Vinohrady

expirationobjectOptional

dateDate | string | string | numberRequired

One of 4:

Variant 1

Date

Example2025-01-10T16:19:41.675Z

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

status"processed" | "expired" | "pending"Required

Examplepending

processedDate | string | string | numberOptional

One of 4:

Variant 1

Date

Example2025-01-10T16:19:41.675Z

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

descriptionstringOptional

ExampleOrder 25000087

insertedDateDate | string | string | numberRequired

Date and time of credit record.

One of 4:

Variant 1

Date

Date and time of credit record.

Example2025-01-10T16:19:41.675Z

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

Response example

application/json

{
  "creditBalance": 510,
  "creditMoneyBalance": 460,
  "currency": "CZK",
  "items": [
    {
      "id": "HxanU4a1n4El61zx",
      "amount": 100,
      "amountMoney": 90,
      "balance": 410,
      "balanceMoney": 370,
      "order": {
        "orderNumber": "25000087",
        "hash": "sSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S",
        "groupName": "GymRoom Vinohrady"
      },
      "expiration": {
        "date": "2025-01-10T16:19:41.675Z",
        "status": "pending",
        "processed": "2025-01-10T16:19:41.675Z"
      },
      "description": "Order 25000087",
      "insertedDate": "2025-01-10T16:19:41.675Z"
    }
  ]
}

/api/v1/customer/credit-log

Parameters

Query parameters

Response schema

Response example

Request example

Need an API key?