/api/v1/collections/{id}/escalate
Escalate a delinquent account to legal collections, or request its charge-off.
- Scope
collections:write- Rate limit
- 20 requests / min
- Idempotency
Idempotency-Keysupported
Authentication
Send your key as Authorization: Bearer …. It must carry the scope collections:write; a key without it receives 403 forbidden.
Path parameters
idstringrequiredHeaders
Idempotency-KeystringReplays the first response for a repeated request. Reusing a key with a different body is idempotency_key_reused (409), never a silent replay.
Request body
application/jsonrequiredtypestring (enum)requiredlegalcharge_offRefused parameters26
Sending any of these returns 400 validation_error naming the field. Each entry explains what to do instead.
amount'amount' is not accepted: the charge-off balance is DERIVED from the loan's remaining balance plus the interest and late fees on its due, unsettled installments. A caller-supplied write-off amount is never trusted. The derived figures are returned under 'charge_off'.
balance'balance' is not accepted: the charge-off balance is DERIVED from the loan's remaining balance plus the interest and late fees on its due, unsettled installments. A caller-supplied write-off amount is never trusted. The derived figures are returned under 'charge_off'.
charge_off_amount'charge_off_amount' is not accepted: the charge-off balance is DERIVED from the loan's remaining balance plus the interest and late fees on its due, unsettled installments. A caller-supplied write-off amount is never trusted. The derived figures are returned under 'charge_off'.
principal_amount'principal_amount' is not accepted: the charge-off balance is DERIVED from the loan's remaining balance plus the interest and late fees on its due, unsettled installments. A caller-supplied write-off amount is never trusted. The derived figures are returned under 'charge_off'.
principalAmount'principalAmount' is not accepted: the charge-off balance is DERIVED from the loan's remaining balance plus the interest and late fees on its due, unsettled installments. A caller-supplied write-off amount is never trusted. The derived figures are returned under 'charge_off'.
interest_amount'interest_amount' is not accepted: the charge-off balance is DERIVED from the loan's remaining balance plus the interest and late fees on its due, unsettled installments. A caller-supplied write-off amount is never trusted. The derived figures are returned under 'charge_off'.
interestAmount'interestAmount' is not accepted: the charge-off balance is DERIVED from the loan's remaining balance plus the interest and late fees on its due, unsettled installments. A caller-supplied write-off amount is never trusted. The derived figures are returned under 'charge_off'.
late_fee_amount'late_fee_amount' is not accepted: the charge-off balance is DERIVED from the loan's remaining balance plus the interest and late fees on its due, unsettled installments. A caller-supplied write-off amount is never trusted. The derived figures are returned under 'charge_off'.
lateFeeAmount'lateFeeAmount' is not accepted: the charge-off balance is DERIVED from the loan's remaining balance plus the interest and late fees on its due, unsettled installments. A caller-supplied write-off amount is never trusted. The derived figures are returned under 'charge_off'.
total_amount'total_amount' is not accepted: the charge-off balance is DERIVED from the loan's remaining balance plus the interest and late fees on its due, unsettled installments. A caller-supplied write-off amount is never trusted. The derived figures are returned under 'charge_off'.
totalAmount'totalAmount' is not accepted: the charge-off balance is DERIVED from the loan's remaining balance plus the interest and late fees on its due, unsettled installments. A caller-supplied write-off amount is never trusted. The derived figures are returned under 'charge_off'.
amount_cents'amount_cents' is not accepted: the charge-off balance is DERIVED from the loan's remaining balance plus the interest and late fees on its due, unsettled installments. A caller-supplied write-off amount is never trusted. The derived figures are returned under 'charge_off'. Every amount on this API is in WHOLE DOLLARS.
approve'approve' is not accepted: this endpoint REQUESTS a charge-off. Approving one posts a write-off journal entry and is a separate, human step.
auto_approve'auto_approve' is not accepted: this endpoint REQUESTS a charge-off. Approving one posts a write-off journal entry and is a separate, human step.
approved_by'approved_by' is not accepted: this endpoint REQUESTS a charge-off and does not approve one.
stage'stage' is not accepted: the stage an escalation moves the case to is determined by 'type'. Escalation only moves a case forward along the delinquency ladder.
status'status' is not accepted: the case's resulting status is determined by the escalation and is returned on the response.
performed_by'performed_by' is not accepted: an escalation is always attributed to the API key that performed it.
performedBy'performedBy' is not accepted: an escalation is always attributed to the API key that performed it.
requested_by'requested_by' is not accepted: an escalation is always attributed to the API key that performed it.
collection_case_id'collection_case_id' is not accepted: the case is taken from the URL path.
case_id'case_id' is not accepted: the case is taken from the URL path.
loan_id'loan_id' is not accepted: the loan is the one the collection case in the URL path belongs to.
notes'notes' is not accepted: an escalation records no free-text note. Use POST /v1/collections/:id/activity to log commentary against the case.
reason'reason' is not accepted: an escalation records no free-text reason. Use POST /v1/collections/:id/activity to log commentary against the case.
idempotency_key'idempotency_key' is not accepted as a body field: send it as the 'Idempotency-Key' HTTP header.
Response
200application/jsonSerializedEscalationcollection_case_idstringrequiredloan_idstringrequiredescalation_typestringrequiredlegal | charge_off — the escalation the caller asked for.
case_statusstring (enum)requiredpendingapproveddeclinedreviewinvitedThe case's status AFTER the escalation. A charge-off REQUEST does not move it.
case_stagestringrequiredThe case's stage AFTER the escalation. legal only on a legal escalation.
days_past_duenumberrequiredescalated_bystringrequiredapi_key:<keyId> — the principal that performed the escalation.
escalated_atstringrequiredcharge_offSerializedChargeOffRequest | nullrequirednullableNull on a legal escalation; the requested charge-off otherwise.
Errors
The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.
400validation_error401unauthorized403forbidden404not_found409conflictidempotency_key_reused429rate_limit_exceeded500internal_error