latestOpenAPI 3.0.42026-08-194977335.3 KB

40bd25a4edaf

ManagedCases

Record a payment on a test case (managing partner)

Records a payment on a test case you submitted as managing partner.

Test-Only Restriction: This endpoint only works on cases created with isTestCase: true. Attempting to record a payment on a production case returns a 400 error. For production cases, the assigned collection partner must use POST /cases/{id}/payments.

Purpose: Allows managing partners (e.g. Get-Systems) to test their full payment integration end-to-end — including webhook delivery, lifecycle transitions, and remainder updates — without involving the collection partner.

Payout Handling: A payout record is created automatically with the full payment amount going to the creditor and zero to the collection partner. CommissionPaymentStatus is set to Unpaid.

Webhooks: Payment webhooks fire normally, making this useful for end-to-end integration testing.

CloseCase: If closeCase=true and the payment amount is less than the outstanding balance, a 400 is returned.

post/managed-cases/{id}/payments

Path parameters

idstring uuid required

Request body

datestring date-time required

Payment date (when payment was received).

paymentAmountnumber double required

Total payment amount received.

closeCaseboolean

Whether to close the case after recording this payment (default: false). If true and payment < invoice remainder, returns validation error.

Example request

{
  "date": "2025-11-19",
  "paymentAmount": 5000
}

Response

Payment recorded successfully

paymentIdstring uuid
caseReferencestring nullable required
datestring date-time
paymentAmountnumber double
caseClosedboolean
remainingAmountnumber double