curl --request GET \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/collection-summaries \
--header 'Authorization: Bearer <token>'{
"data": [
{
"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"
}
}
],
"hasMore": false,
"nextCursor": null
}{
"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": "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"
}List collection summaries
Requires collection_summaries:read. Returns collection summaries for the Receivables this connection may see, ordered by externalReceivableId, with a cursor for the next page. Each summary has the same shape and exclusions as the single read. Summaries reflect committed state at read time, so a financial or recovery change made between pages appears on whichever page reads that Receivable afterwards.
curl --request GET \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/collection-summaries \
--header 'Authorization: Bearer <token>'{
"data": [
{
"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"
}
}
],
"hasMore": false,
"nextCursor": null
}{
"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": "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}$Query Parameters
Opaque cursor from a previous response's nextCursor. Omit it to read from the first Receivable.
1 - 200Maximum summaries to return, from 1 to 50. Defaults to 25.
1 <= x <= 50Response
A page of collection summaries.