Saltar al contenido principal
POST
Create a consignado compensating adjustment

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

Canonical idempotency request ID. Reusing the same key on a retry returns the SAME durably accepted operation, never a duplicate.

Cuerpo

application/json
adjustmentAmount
string
requerido

Signed compensating entry magnitude, exact two-decimal string. Sign convention: payment_shortfall must be negative, payment_excess and every disbursement_* reason must be positive.

currency
string
requerido

ISO-4217 currency code.

Required string length: 3
justification
string
requerido

Operator's structured justification.

Required string length: 1 - 4000
numeroContrato
string
requerido

Canonical rail contract number.

Required string length: 2 - 15
reason
enum<string>
requerido

Closed reason catalog; no free-form 'other'. A disbursement_* or refinance_payoff_* reason clears a disbursement in parts or a refinance payoff: it names the divergence and moves exactly its open amount. refinance_payoff_short_settled_residual only records, on a refinance_payoff_vs_rail item, that part of the shortfall (any amount up to the item's openShortfall and residualAvailable) is the CCB residual of the same contract: it posts nothing.

Opciones disponibles:
payment_shortfall,
payment_excess,
immutable_client_correction,
internal_ccb_residual,
disbursement_excess_recovered,
disbursement_excess_loss,
disbursement_remainder_paid_off_rail,
disbursement_remainder_cancelled,
refinance_payoff_short_recovered,
refinance_payoff_short_loss,
refinance_payoff_excess_refunded,
refinance_payoff_short_settled_residual
correctionEventId
string

Landed correction event this adjustment resolves. At most one of divergenceId/correctionEventId may be set.

Maximum string length: 255
debtAmountAfter
string

CCB debt after this adjustment. Both-or-neither with debtAmountBefore.

debtAmountBefore
string

CCB debt before this adjustment. Both-or-neither with debtAmountAfter.

divergenceId
string<uuid>

Divergence this adjustment resolves. At most one of divergenceId/correctionEventId may be set.

Respuesta

Accepted

adjustmentAmount
string
requerido

Signed compensating entry magnitude, exact two-decimal string.

createdAt
string
requerido

RFC3339 UTC.

createdBy
string
requerido

Validated actor identity that created this operation.

currency
string
requerido

ISO-4217 currency code.

existing
boolean
requerido

True when this call replayed an already-committed operation for the same idempotency key, never a duplicate.

id
string
requerido

Compensating adjustment operation identifier.

idempotencyKey
string
requerido

Idempotency key this operation was created (or replayed) under.

justification
string
requerido

Operator's structured justification.

numeroContrato
string
requerido

Canonical rail contract number.

reason
string
requerido

Closed reason catalog.

resolvedGlAccount
string
requerido

GL account this operation was authorized against: the suspense account, or the above or below account a disbursement_* reason clears. A contract that already booked into the role keeps that account; otherwise the role's account, configured or the Lender's default when it provisions accounts.

correctionEventId
string

Landed correction event this adjustment resolves, when set.

debtAmountAfter
string

CCB debt after, when this adjustment changes the debt.

debtAmountBefore
string

CCB debt before, when this adjustment changes the debt.

divergenceId
string

Divergence this adjustment resolves, when set.