GET
List Payments

Overview

Returns payments recorded on a debt through the External API, including direct pay-downs, paid installments, cancelled payments, and payment deltas created from paidAmount or remainingAmount updates. This endpoint is intended for reconciliation by an external payment platform. It does not expose unrelated internal provider transactions. When called through a grouped debt, the response also includes installment payments recorded on the shared plan debt. Direct payments made without installment_id remain visible only on the debt they paid.

Authentication

Requires a valid OAuth 2.0 access token with the debts:read scope.

Request

string
required
Encrypted debt ID.
string
Optional partner payment identifier. When provided, only the matching payment is returned.

Response

string
Opaque UUID of the payment transaction.
string
Encrypted debt that owns the payment. A grouped installment payment is owned by the shared plan debt.
string
Encrypted installment ID when the payment is attached to an installment, otherwise null.
string
Partner payment identifier when one was supplied.
string
Partner/provider label supplied when the payment was recorded, or the internal transaction provider.
number
Payment amount.
string
Payment transaction status.
string
Payment date/time in ISO 8601 format.

Example