curl --request GET \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/collection-summaries/{externalReceivableId} \
--header 'Authorization: Bearer <token>'{
"actions": [
{
"channel": "message",
"executedAt": "2026-10-14T10:02:00Z",
"origin": "automatic",
"status": "completed"
}
],
"commitments": [
{
"amount": {
"amount": "50.00",
"currency": "EUR"
},
"arrangementTotal": {
"amount": "200.00",
"currency": "EUR"
},
"dueAt": "2026-10-31T00:00:00Z",
"frequency": "monthly",
"instalmentsPaid": 1,
"kind": "payment_plan",
"nextInstalment": {
"amount": {
"amount": "50.00",
"currency": "EUR"
},
"dueAt": "2026-10-31T00:00:00Z"
},
"status": "active",
"totalInstalments": 4
}
],
"externalReceivableId": "LOAN_5521_INST_07",
"financialPosition": {
"confirmedUnreconciledAmount": {
"amount": "40.00",
"currency": "EUR"
},
"receiptAcknowledgedAmount": {
"amount": "0.00",
"currency": "EUR"
},
"sourceAmount": {
"amount": "140.00",
"currency": "EUR"
},
"workingAmount": {
"amount": "100.00",
"currency": "EUR"
}
},
"financialType": "loan_instalment",
"payment": {
"holds": [],
"initiationHeld": false
},
"reconciliation": {
"status": "pending_accounting"
},
"recovery": {
"entryMode": "explicit_instruction",
"held": false,
"holds": [],
"state": "eligible"
}
}{
"detail": "API key is invalid, inactive, revoked, or for another environment.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 401,
"title": "API key is invalid, inactive, revoked, or for another environment.",
"type": "https://docs.paypathiq.com/problems/invalid_api_key"
}{
"detail": "The Client code is unknown, the grant lacks the required scope, or the calling address is outside the grant's IP allowlist.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 403,
"title": "The Client code is unknown, the grant lacks the required scope, or the calling address is outside the grant's IP allowlist.",
"type": "https://docs.paypathiq.com/problems/client_scope_denied"
}{
"detail": "Receivable was not found within the authorized scope.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 404,
"title": "Receivable was not found within the authorized scope.",
"type": "https://docs.paypathiq.com/problems/receivable_not_found"
}{
"detail": "Route parameters or the representation are invalid. Route parameters are checked before authentication. Field errors carry a code such as invalid_format, unrecognized_keys, custom, sensitive_external_id, or sensitive_source_reference.",
"errors": [
{
"code": "invalid_format",
"detail": "Invalid ISO date",
"pointer": "/dueDate"
}
],
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 422,
"title": "Route parameters or the representation are invalid. Route parameters are checked before authentication. Field errors carry a code such as invalid_format, unrecognized_keys, custom, sensitive_external_id, or sensitive_source_reference.",
"type": "https://docs.paypathiq.com/problems/validation_error"
}{
"detail": "Each API key may send 60 requests per minute and run 1 request at a time. In sandbox, the same limits also apply per Client across all of its keys. Every request, including GET, counts.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 429,
"title": "Each API key may send 60 requests per minute and run 1 request at a time. In sandbox, the same limits also apply per Client across all of its keys. Every request, including GET, counts.",
"type": "https://docs.paypathiq.com/problems/rate_limit_exceeded"
}{
"detail": "An unexpected error prevented a safe commit, and nothing was saved. Retry with backoff.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 503,
"title": "An unexpected error prevented a safe commit, and nothing was saved. Retry with backoff.",
"type": "https://docs.paypathiq.com/problems/projection_unavailable"
}Get a collection summary
Requires collection_summaries:read, a scope separate from intake, corrections, recovery and Payment initiation. Returns the Receivable’s working collection position, separate from its Source representation: source and working amounts, confirmed amounts awaiting accounting, reconciliation status, current recovery and Payment holds, authorized promise-to-pay and Payment-plan summaries, and recent action outcomes. Staff notes, protected data, message content and provider responses are never included. A commitment appears only when every Receivable it covers belongs to this connection. Only Receivables placed by this connection’s own grant are visible, and a revoked or changed grant stops access immediately. Reads are informational: they never start, resume or clear recovery, and each recovery or Payment action checks every control again when it is attempted. Reading does not count as fresh Source evidence.
curl --request GET \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/collection-summaries/{externalReceivableId} \
--header 'Authorization: Bearer <token>'{
"actions": [
{
"channel": "message",
"executedAt": "2026-10-14T10:02:00Z",
"origin": "automatic",
"status": "completed"
}
],
"commitments": [
{
"amount": {
"amount": "50.00",
"currency": "EUR"
},
"arrangementTotal": {
"amount": "200.00",
"currency": "EUR"
},
"dueAt": "2026-10-31T00:00:00Z",
"frequency": "monthly",
"instalmentsPaid": 1,
"kind": "payment_plan",
"nextInstalment": {
"amount": {
"amount": "50.00",
"currency": "EUR"
},
"dueAt": "2026-10-31T00:00:00Z"
},
"status": "active",
"totalInstalments": 4
}
],
"externalReceivableId": "LOAN_5521_INST_07",
"financialPosition": {
"confirmedUnreconciledAmount": {
"amount": "40.00",
"currency": "EUR"
},
"receiptAcknowledgedAmount": {
"amount": "0.00",
"currency": "EUR"
},
"sourceAmount": {
"amount": "140.00",
"currency": "EUR"
},
"workingAmount": {
"amount": "100.00",
"currency": "EUR"
}
},
"financialType": "loan_instalment",
"payment": {
"holds": [],
"initiationHeld": false
},
"reconciliation": {
"status": "pending_accounting"
},
"recovery": {
"entryMode": "explicit_instruction",
"held": false,
"holds": [],
"state": "eligible"
}
}{
"detail": "API key is invalid, inactive, revoked, or for another environment.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 401,
"title": "API key is invalid, inactive, revoked, or for another environment.",
"type": "https://docs.paypathiq.com/problems/invalid_api_key"
}{
"detail": "The Client code is unknown, the grant lacks the required scope, or the calling address is outside the grant's IP allowlist.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 403,
"title": "The Client code is unknown, the grant lacks the required scope, or the calling address is outside the grant's IP allowlist.",
"type": "https://docs.paypathiq.com/problems/client_scope_denied"
}{
"detail": "Receivable was not found within the authorized scope.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 404,
"title": "Receivable was not found within the authorized scope.",
"type": "https://docs.paypathiq.com/problems/receivable_not_found"
}{
"detail": "Route parameters or the representation are invalid. Route parameters are checked before authentication. Field errors carry a code such as invalid_format, unrecognized_keys, custom, sensitive_external_id, or sensitive_source_reference.",
"errors": [
{
"code": "invalid_format",
"detail": "Invalid ISO date",
"pointer": "/dueDate"
}
],
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 422,
"title": "Route parameters or the representation are invalid. Route parameters are checked before authentication. Field errors carry a code such as invalid_format, unrecognized_keys, custom, sensitive_external_id, or sensitive_source_reference.",
"type": "https://docs.paypathiq.com/problems/validation_error"
}{
"detail": "Each API key may send 60 requests per minute and run 1 request at a time. In sandbox, the same limits also apply per Client across all of its keys. Every request, including GET, counts.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 429,
"title": "Each API key may send 60 requests per minute and run 1 request at a time. In sandbox, the same limits also apply per Client across all of its keys. Every request, including GET, counts.",
"type": "https://docs.paypathiq.com/problems/rate_limit_exceeded"
}{
"detail": "An unexpected error prevented a safe commit, and nothing was saved. Retry with backoff.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 503,
"title": "An unexpected error prevented a safe commit, and nothing was saved. Retry with backoff.",
"type": "https://docs.paypathiq.com/problems/projection_unavailable"
}Authorizations
Integration-owned environment-specific API key. Never paste a production key into documentation tools.
Path Parameters
Stable non-sensitive Client code authorized by the Integration grant.
^[A-Za-z0-9_-]{1,128}$The Source's identifier of the Receivable, as used when it was placed.
^[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.
The most recent actions, newest first.
10Show child attributes
Show child attributes
5Show child attributes
Show child attributes
^[A-Za-z0-9_-]{1,128}$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.
Show child attributes
Show child attributes
loan_instalment, accelerated_balance, loan_balance, service_charge_demand Whether a new hosted Payment request would currently be refused. It is informational: payment creation checks every control again.
Show child attributes
Show child attributes
Reconciliation status. The supporting amounts are in financialPosition.
Show child attributes
Show child attributes
Working recovery state. It is informational: reading it never starts, resumes or clears recovery.
Show child attributes
Show child attributes