Skip to main content
GET
Get a collection summary

Authorizations

Authorization
string
header
required

Integration-owned environment-specific API key. Never paste a production key into documentation tools.

Path Parameters

clientCode
string
required

Stable non-sensitive Client code authorized by the Integration grant.

Pattern: ^[A-Za-z0-9_-]{1,128}$
externalReceivableId
string
required

The Source's identifier of the Receivable, as used when it was placed.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Response

Current collection summary for the Receivable.

The working collection position of one Receivable, separate from its Source representation. Requires collection_summaries:read.

actions
object[]
required

The most recent actions, newest first.

Maximum array length: 10
commitments
object[]
required
Maximum array length: 5
externalReceivableId
string
required
Pattern: ^[A-Za-z0-9_-]{1,128}$
financialPosition
object
required

Present on reads. sourceAmount is the declared accounting authority's position, workingAmount is the safe collection balance after confirmed allocated Payments, and confirmedUnreconciledAmount is the allocated confirmed amount the Source has not yet acknowledged. Unapplied funds appear in none of them.

financialType
enum<string>
required
Available options:
loan_instalment,
accelerated_balance,
loan_balance,
service_charge_demand
payment
object
required

Whether a new hosted Payment request would currently be refused. It is informational: payment creation checks every control again.

reconciliation
object
required

Reconciliation status. The supporting amounts are in financialPosition.

recovery
object
required

Working recovery state. It is informational: reading it never starts, resumes or clears recovery.