Skip to main content
POST
Record a client settlement-deposit ack

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key
string

Idempotency key for safe retries; a replay carrying the same key returns the stored response instead of appending a duplicate audit row (scoped to tenant + this instruction's ack route).

Path Parameters

instructionId
string
required

Settlement instruction id (UUID).

Example:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

Body

application/json
result
string
required

Client deposit result: SENT (deposited) or FAILED (could not). Case-insensitive — the value is upper-cased before validation, so "sent"/"failed" are accepted (intentionally lenient).

Example:

"SENT"

ackedAt
string

When the client reported the ack (RFC3339). Omitted stores NULL.

Example:

"2026-06-28T11:00:00Z"

amountCents
integer<int64>

Deposited amount in cents.

Example:

5011

errorDetail
string

Failure reason when result is FAILED.

Example:

"insufficient reserves"

ldl0022Ref
string

Client reference to its LDL0022 (IF->STR); recorded for audit, outside the SLC.

Example:

"LDL0022-2026-06-28-000123"

Response

OK

instructionId
string
required

The settlement instruction id the ack was recorded against.

result
string
required

The accepted ack result (SENT/FAILED), upper-cased.

transitioned
boolean
required

Whether this ack drove the instruction to ACKED. True only for a SENT ack that matched an instruction in PENDING or NOTIFIED; false for FAILED and for a SENT ack against an instruction not in PENDING/NOTIFIED (already acked/settled). The ack is recorded either way.

state
string

The resulting instruction state — present ONLY when this ack drove the transition (always ACKED). Omitted when transitioned is false; do not infer a state from the result.