Skip to main content
POST
companies.registry.charge.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by companies.registry.charges.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

personsEntitled
string[]
required

Disclosed creditor names, which may include people.

Maximum array length: 100
status
string

Charge status.

Maximum string length: 2048
createdOn
string

Date created, ISO 8601.

deliveredOn
string

Date delivered, ISO 8601.

satisfiedOn
string

Date satisfied, ISO 8601.

classification
string

Official classification.

Maximum string length: 2048
description
string

Charge description.

Maximum string length: 2048
assets
string

Disclosed charged assets summary.

Maximum string length: 2048
securedObligations
string

Disclosed secured obligations summary.

Maximum string length: 2048
floatingCharge
boolean

Whether a floating charge is disclosed.

fixedCharge
boolean

Whether a fixed charge is disclosed.