Skip to main content
POST
Create collateral reduction

Authorizations

Authorization
string
header
required

Scoped API key from the Totalis app settings. Each key acts for one account, yours or a maker's, and holds only scopes that account can use. Each operation lists the scopes it requires.

Headers

Idempotency-Key
string<uuid>
required

Lowercase UUIDv7 naming this command, unique per caller and route. A retry with the same key and body returns the original result; the same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Path Parameters

maker_id
string<uint64-decimal>
required

On-chain maker ID, as a decimal string. The credential must be authorized for this maker. Never 0.

Maximum string length: 20
Pattern: ^(0|[1-9][0-9]{0,18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-5])$

Response

The job is queued. Totalis computes the reduction itself, so the request has no body. Follow the job with GET /v1/makers/{maker_id}/collateral-reductions/{job_id} or COLLATERAL_REDUCTION_UPDATED on the maker stream, then submit its transaction.

job_id
string<uuid>
required

ID of the collateral-reduction job.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
status
enum<string>
required

QUEUED: waiting until the maker is eligible for a reduction; SOLVING: computing the requirement; NO_IMPROVEMENT: no lower requirement found, nothing to submit; DURABLE: certificate signed and ATTEST operation stored; FAILED: ended without a certificate.

Available options:
QUEUED,
SOLVING,
NO_IMPROVEMENT,
DURABLE,
FAILED
next_eligible_at
string<date-time>
required

Earliest RFC 3339 UTC time the maker's next reduction can land on chain; the job stays QUEUED until then.

Maximum string length: 30
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?Z$
status_url
string
required

Relative path to poll for this job's status.

Pattern: ^/v1/makers/[1-9][0-9]{0,19}/collateral-reductions/[0-9a-f-]{36}$