Skip to main content

Create a payment on a case

POST 
/cases/:invoiceId/payments

Records a payment received for a collection case.

Use Case: Use this endpoint when you receive a payment from the debtor. You must provide the payment amount and specify how it should be split between the creditor and collection partner.

Currency: Payment must be in the same currency as the invoice. The currency is automatically determined from the case.

PaymentRecipient Options: • Creditor - Payment was received by the creditor (your client). When using this option, you MUST also specify CommissionPaymentStatus. • CollectionPartner - Payment was received by you (the collection partner). Commission is automatically marked as Paid since you already have the funds.

CommissionPaymentStatus: This field tracks whether the collection partner's commission has been paid. It's only required when PaymentRecipient is 'Creditor'. • Paid - The creditor has already paid your commission • Unpaid - The creditor has not yet paid your commission

Note: When PaymentRecipient is 'CollectionPartner', this field is automatically set to 'Paid' since you already have the money.

Critical Validation: • PayoutCreditor + PayoutCollectionPartner MUST equal PaymentAmount (within 0.01 tolerance) • If CloseCase=true and payment < outstanding amount, returns validation error • CommissionPaymentStatus is required only if PaymentRecipient is 'Creditor'

Payment Flow:

  1. Full Payment (payment >= outstanding):

    • If CloseCase=true → closes case with 'Paid' status
    • If CloseCase=false → case remains open

  2. Partial Payment (payment < outstanding):

    • If CloseCase=true → returns validation error
    • If CloseCase=false → case remains open

Request​

Responses​

Payment created successfully