Credit line dashboard

GET/api/v1/credit/lines/{credit_line_id}

Limit, current balance, available credit, utilisation in basis points, start date, term, and linked account. Available credit and utilisation are returned rather than derived so the dashboard card and the statement band cannot disagree.

Operation ID: get_credit_line_api_v1_credit_lines__credit_line_id__get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

credit_line_idstringrequired

Responses

200Successful Response

Schema: SuccessEnvelope_CreditLineResponse_

successboolean
messagestring
codestring
dataCreditLineResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/credit/lines/{credit_line_id}

bash

curl -X GET 'https://api.ondayzero.com/api/v1/credit/lines/{credit_line_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'