curl --request GET \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/payment-requests/{externalPaymentRequestId}/receipt-delivery \
--header 'Authorization: Bearer <token>'{
"acknowledgement": {
"allocatedAmount": {
"amount": "300.00",
"currency": "EUR"
},
"matchedAmount": {
"amount": "0.00",
"currency": "EUR"
},
"status": "pending",
"unmatchedAmount": {
"amount": "300.00",
"currency": "EUR"
}
},
"capability": {
"disabledReason": "no_verified_route",
"state": "disabled",
"unverifiedRoutes": [
{
"missingProof": "Blockman documents read endpoints only; no receipt-posting endpoint is verified.",
"route": "blockman_receipt_posting"
}
]
},
"deliveryOwner": "paypathiq",
"externalPaymentRequestId": "PAYREQ_EXAMPLE"
}{
"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": "No Payment request exists at this authorized reference.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 404,
"title": "No Payment request exists at this authorized reference.",
"type": "https://docs.paypathiq.com/problems/payment_request_not_found"
}{
"detail": "The Payment request has no provider-confirmed Payment to deliver.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 409,
"title": "The Payment request has no provider-confirmed Payment to deliver.",
"type": "https://docs.paypathiq.com/problems/payment_not_confirmed"
}{
"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 receipt delivery and acknowledgement
Requires payment_requests:read. Returns the connection’s declared receipt delivery owner, what PayPathIQ can deliver today, every delivery attempt and, separately, the accounting acknowledgement derived from Source receipt lines. Delivery and acknowledgement are independent facts: a submission or an exported file never acknowledges a Payment.
curl --request GET \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/payment-requests/{externalPaymentRequestId}/receipt-delivery \
--header 'Authorization: Bearer <token>'{
"acknowledgement": {
"allocatedAmount": {
"amount": "300.00",
"currency": "EUR"
},
"matchedAmount": {
"amount": "0.00",
"currency": "EUR"
},
"status": "pending",
"unmatchedAmount": {
"amount": "300.00",
"currency": "EUR"
}
},
"capability": {
"disabledReason": "no_verified_route",
"state": "disabled",
"unverifiedRoutes": [
{
"missingProof": "Blockman documents read endpoints only; no receipt-posting endpoint is verified.",
"route": "blockman_receipt_posting"
}
]
},
"deliveryOwner": "paypathiq",
"externalPaymentRequestId": "PAYREQ_EXAMPLE"
}{
"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": "No Payment request exists at this authorized reference.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 404,
"title": "No Payment request exists at this authorized reference.",
"type": "https://docs.paypathiq.com/problems/payment_request_not_found"
}{
"detail": "The Payment request has no provider-confirmed Payment to deliver.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 409,
"title": "The Payment request has no provider-confirmed Payment to deliver.",
"type": "https://docs.paypathiq.com/problems/payment_not_confirmed"
}{
"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}$Caller-assigned, opaque identifier of this hosted payment request. Reusing it with the identical body is a safe retry; reusing it with a different body conflicts.
^[A-Za-z0-9_-]{1,128}$Response
Delivery state and acknowledgement.
Accounting acknowledgement, from Source receipt lines matched by payment reconciliations. It is independent of delivery: a successful submission or an exported file leaves it pending until exact receipt lines arrive.
Show child attributes
Show child attributes
What PayPathIQ can deliver for this connection today. disabled means no delivery attempt will be made.
Show child attributes
Show child attributes
partner, paypathiq ^[A-Za-z0-9_-]{1,128}$Show child attributes
Show child attributes