Parameters
1 query
Query parameters
· 1customerIdstringRequiredContact external ID.
Example
abc123def456ghij/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
Response schema
1 status code documented
200Success
creditnumberRequiredCurrent credit balance (number of credits).
Example
3300creditMoneynumberRequiredCurrent credit balance expressed in the organisation default currency.
Example
3000currencystringRequiredISO 4217 code of the organisation default currency used for all *Money fields.
Example
CZKitemsobject[]RequiredCredit transactions ordered from most recent to oldest.
Each array item:
idstringRequiredTransaction external ID.
Example
HxanU4a1n4El61zxamountnumberRequiredCredit amount (positive = added, negative = spent).
Examples
3300-100amountMoneynumberRequiredMonetary value of the transaction in the organisation default currency. Defaults to the same value as amount (1:1) when no explicit money value was stored.
Examples
3000-1000balancenumberRequiredRunning credit balance after this transaction.
Example
3300balanceMoneynumberRequiredRunning monetary balance after this transaction (in the organisation default currency).
Example
3000orderobjectOptionalorderNumberstringRequiredExample
25000087hashstringRequiredExample
sSO98YxzR4KJiOu66Jn6K3wRwa4FPI7SgroupNamestringRequiredExample
GymRoom VinohradyexpirationobjectOptionaldateDate | string | string | numberRequiredOne of 4:
Variant 1
Date
Example
2026-12-31T00:00:00.000ZVariant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
status"pending" | "processed" | "expired"RequiredprocessedDate | string | string | numberOptionalOne of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
reasonobjectOptionalexternalIdstringRequiredCredit reason external ID.
Example
rsn1234567890abccodestringRequiredCredit reason code.
Example
cleaning-complaintnamestringRequiredCredit reason display name.
Example
Reklamace úklidupayerBranchobjectOptionalBranch that internally bears the cost of this credit movement. Omitted when the organisation absorbs it.
slugstringRequiredSlug of the branch that internally bears this credit cost.
namestringRequiredDisplay name of the payer branch.
linkedWriteoffobjectOptionalBranch write-off that was auto-spawned for this credit (1:1 via shop__contact_credit_expense_link). Omitted when no branch was picked, or when the spawn failed and was logged.
externalIdstringRequiredExternal id of the linked shop__expense write-off row.
status"draft" | "pending" | "approved" | "rejected"RequiredisDeletedbooleanRequireddescriptionstringOptionalExample
Order 25000087insertedDateDate | string | string | numberRequiredOne of 4:
Variant 1
Date
Example
2026-04-21T10:00:00.000ZVariant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemCountnumberRequiredTotal number of credit transactions.
Example
42Response example
application/json{
"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
}Request example
GET /bff/contact-credit/list
curl -X GET "https://api.bizkithub.com/bff/contact-credit/list?customerId=abc123def456ghij" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY"Need an API key?
All BizKitHub public API endpoints require authentication via API key.