Payments and Reconciliation

Receive payment notifications and query payment data for reconciliation.

How It Works

Collection partners record payments as they collect. You receive notifications and can query payment data to update your accounting systems.

Getting Payment Data

Real-time: Subscribe to the payment.created and payment.deleted webhook events. See Webhooks for setup.

On-demand: Query the payments API:

• GET /Payments — All payments with pagination
• GET /Payments/{id} — Single payment by ID
• GET /cases/{id}/payments — Payments for a specific case

Handling Reversals

A payment can be deleted after the fact — for example a collection partner correcting one that was recorded with the wrong amount. A deleted payment simply disappears from the list endpoints above; there's no separate "deleted" state to query for, so periodically re-querying the payments API will not surface a reversal. Subscribe to payment.deleted to catch these — see Webhooks for the payload shape.

Reconciliation Pattern

1. Subscribe to payment.created and payment.deleted webhooks
2. On payment.created, match the payment to your invoice using case reference and record it
3. On payment.deleted, reverse the corresponding entry in your accounting system using paymentId
4. Periodically query the API to catch any missed payment.created events — reversals still require the payment.deleted webhook, since a deleted payment can't be discovered by re-querying

See the case lifecycle for the Paid and Partially paid close codes, and idempotency for handling duplicate webhook events.