Perform Action on Collection Case

Once a collection case is created and booked you operate on it through the /collection-batches/<id> sub-resources. Each action has its own right and most require the case to be in an open status (OPEN, RESUME, PAUSED, DISPUTED).

Example - dispute a case:

curl -X PUT "https://$HOST/collection-batches/$CB_ID/dispute" \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{ "reasonCode": "DISPUTED_BY_DEBTOR" }'

Status actions

Action	Endpoint	Right	What it does
Dispute	PUT /collection-batches/<id>/dispute	DisputeCollectionBatch	Mark the case disputed.
Resume	PUT /collection-batches/<id>/resume	ResumeCollectionBatch	Resume a paused/disputed case.
Stop	PUT /collection-batches/<id>/stop	StopCollectionBatch	Stop the case.
Reprieve	PUT /collection-batches/<id>/reprieve	ReprieveCollectionBatch	Grant a payment reprieve (pause ledger to a date).
Close reprieve	PUT /collection-batches/<id>/close-reprieve	ReprieveCollectionBatch	End an active reprieve.
Update	PUT /collection-batches/<id>	UpdateCollectionBatch	Update fields, including advancing the ledger status.

Financial actions

Action	Endpoint	Right	What it does
Add fee / interest	POST /collection-batches/<id>/financial-events	CreateCollectionBatchFinancialEvent	Book a COLLECTION_BATCH_FEE or interest event.
Reverse financial event	PUT /collection-batches/financial-events/<eventId>/reverse	ReversePaymentTransaction	Reverse a booked financial event.
Write off	PUT /collection-batches/<id>/writeoff	WriteOffOnCollectionBatch	Write off outstanding amounts.
Start part payment	PUT /collection-batches/<id>/part-payment/start	PartPaymentStartCollectionBatch	Start a part-payment plan on the case.
Stop part payment	PUT /collection-batches/<id>/part-payment/stop	PartPaymentStopCollectionBatch	Stop the part-payment plan.

Workflow actions

Action	Endpoint	Right	What it does
Trigger ad-hoc event	PUT /collection-batches/events/<id>/trigger	TriggerCollectionBatchEvent	Schedule an ad-hoc ledger event (notification, claim, …). It is performed via the reminder pipeline.
Replace profile	PUT /collection-batches/<id>/replace-collection-profile	ChangeCollectionProfile	Swap the collection profile.
Append profile	PUT /collection-batches/<id>/append-collection-profile	AppendCollectionProfile	Append a profile to the chain.
Postpone ledger events	PUT /collection-batches/<id>/postpone-ledger-events	UpdateCollectionBatch	Push upcoming ledger events later.
Add / remove invoice	POST / DELETE /collection-batches/<id>/invoices/<invoiceId>	UpdateCollectionBatch	Add or remove an invoice from the case.
Manage guarantors	POST / PUT / DELETE /collection-batches/<id>/guarantors[/<guarantorId>]	CreateCollectionBatchGuarantor	Maintain guarantors on the case.

Bulk operations across many cases live under PUT /collection-batches/actions/bulk-update (and /create-note, /postpone-collection-batches). Read state with GET /collection-batches/<id>, /financial-events, /notes, and /events.

Note

Triggering an event only schedules it - the claim/notification is performed and the case marked distributed when its reminder is booked (see Create & Book Collection Case). Confirm action-specific preconditions in the API reference.