curl --request PUT \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/payment-requests/{externalPaymentRequestId}/receipt-delivery \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"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"
}Deliver a receipt to the accounting Source
Requires payment_requests:write. Asks PayPathIQ to deliver the receipt of a confirmed Payment to the Client’s accounting Source. Only the connection’s declared delivery owner may post: a partner-owned connection is refused. Blockman, a Blockman transaction CSV and Xero payment write-back are disabled because no receipt-posting endpoint or import format is verified, so this operation returns receipt_delivery_route_unsupported and records nothing. Where a verified route is enabled, every attempt is recorded with a stable delivery reference; the vendor’s acceptance leaves the acknowledgement pending until exact receipt lines are reconciled. A rejected attempt may be retried with the same reference. An ambiguous outcome is never retried until exact receipt evidence acknowledges the Payment. Delivery state changes are announced as receipt_delivery.created or receipt_delivery.updated in the change feed.
curl --request PUT \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/payment-requests/{externalPaymentRequestId}/receipt-delivery \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"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"
}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}$Body
One uncompressed resource representation, limited to 256 KiB.
Asks PayPathIQ to deliver the receipt of this confirmed Payment through the connection's verified route. The body carries no fields: the receipt content is always derived from the confirmed Payment and its allocations.
Response
Current delivery state; no new attempt was needed or the attempt did not create the delivery.
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