curl --request GET \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/payment-deliveries \
--header 'Authorization: Bearer <token>'{
"data": [
{
"accountingAcceptance": "partially_acknowledged",
"allocations": [
{
"allocatedAmount": {
"amount": "100.00",
"currency": "EUR"
},
"allocationReference": "5f1d3c6e-2b6a-4a57-9a3e-0d8b1c2f4a10",
"externalReceivableId": "REC_EXAMPLE_1",
"matchedAmount": {
"amount": "100.00",
"currency": "EUR"
},
"unmatchedAmount": {
"amount": "0.00",
"currency": "EUR"
}
},
{
"allocatedAmount": {
"amount": "200.00",
"currency": "EUR"
},
"allocationReference": "7a9e1b44-6c0f-4f25-8d71-3e5a9b0c6d21",
"externalReceivableId": "REC_EXAMPLE_2",
"matchedAmount": {
"amount": "0.00",
"currency": "EUR"
},
"unmatchedAmount": {
"amount": "200.00",
"currency": "EUR"
}
}
],
"confirmedAt": "2026-10-15T12:00:00.000Z",
"delivery": {
"attempts": [
{
"channel": "api",
"externalAttemptId": "DELIVERY_ATTEMPT_1",
"outcome": "delivered",
"recordedAt": "2026-10-15T12:10:00.000Z"
}
],
"state": "delivered"
},
"deliveryOwner": "partner",
"externalPaymentRequestId": "PAYREQ_EXAMPLE",
"paymentAmount": {
"amount": "300.00",
"currency": "EUR"
},
"paymentReference": "0c4e8a52-1d3b-4e6f-b7a9-2f5c8d1e3a60",
"reconciliations": [
"RECON_EXAMPLE"
],
"unappliedAmount": {
"amount": "0.00",
"currency": "EUR"
},
"unmatchedAmount": {
"amount": "200.00",
"currency": "EUR"
}
}
],
"hasMore": false,
"nextAfter": 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": "This connection declares PayPathIQ as the receipt delivery owner, so partner retrieval, delivery and acknowledgement operations are unavailable.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 409,
"title": "This connection declares PayPathIQ as the receipt delivery owner, so partner retrieval, delivery and acknowledgement operations are unavailable.",
"type": "https://docs.paypathiq.com/problems/receipt_delivery_owner_mismatch"
}{
"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 delivery-ready Payments
Requires payment_observations:read and a connection whose receipt delivery owner is partner. Lists provider-confirmed Payments of this connection’s hosted Payment requests, in Payment request identifier order, with stable payment and allocation references. Retrieving a Payment is not delivery and never implies posting: delivery attempts are reported separately, and accountingAcceptance reflects only receipt lines acknowledged through payment reconciliations. Payment requests without exactly one confirmed Payment are not listed.
curl --request GET \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/payment-deliveries \
--header 'Authorization: Bearer <token>'{
"data": [
{
"accountingAcceptance": "partially_acknowledged",
"allocations": [
{
"allocatedAmount": {
"amount": "100.00",
"currency": "EUR"
},
"allocationReference": "5f1d3c6e-2b6a-4a57-9a3e-0d8b1c2f4a10",
"externalReceivableId": "REC_EXAMPLE_1",
"matchedAmount": {
"amount": "100.00",
"currency": "EUR"
},
"unmatchedAmount": {
"amount": "0.00",
"currency": "EUR"
}
},
{
"allocatedAmount": {
"amount": "200.00",
"currency": "EUR"
},
"allocationReference": "7a9e1b44-6c0f-4f25-8d71-3e5a9b0c6d21",
"externalReceivableId": "REC_EXAMPLE_2",
"matchedAmount": {
"amount": "0.00",
"currency": "EUR"
},
"unmatchedAmount": {
"amount": "200.00",
"currency": "EUR"
}
}
],
"confirmedAt": "2026-10-15T12:00:00.000Z",
"delivery": {
"attempts": [
{
"channel": "api",
"externalAttemptId": "DELIVERY_ATTEMPT_1",
"outcome": "delivered",
"recordedAt": "2026-10-15T12:10:00.000Z"
}
],
"state": "delivered"
},
"deliveryOwner": "partner",
"externalPaymentRequestId": "PAYREQ_EXAMPLE",
"paymentAmount": {
"amount": "300.00",
"currency": "EUR"
},
"paymentReference": "0c4e8a52-1d3b-4e6f-b7a9-2f5c8d1e3a60",
"reconciliations": [
"RECON_EXAMPLE"
],
"unappliedAmount": {
"amount": "0.00",
"currency": "EUR"
},
"unmatchedAmount": {
"amount": "200.00",
"currency": "EUR"
}
}
],
"hasMore": false,
"nextAfter": 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": "This connection declares PayPathIQ as the receipt delivery owner, so partner retrieval, delivery and acknowledgement operations are unavailable.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 409,
"title": "This connection declares PayPathIQ as the receipt delivery owner, so partner retrieval, delivery and acknowledgement operations are unavailable.",
"type": "https://docs.paypathiq.com/problems/receipt_delivery_owner_mismatch"
}{
"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
Only Payments in this accounting acceptance state are returned.
pending, partially_acknowledged, acknowledged, held The nextAfter value of a previous page. Omit it to read from the start.
^[A-Za-z0-9_-]{1,128}$Maximum Payments to return, from 1 to 100. Defaults to 50.
1 <= x <= 100