Skip to main content
GET
Get receipt delivery and acknowledgement

Authorizations

Authorization
string
header
required

Integration-owned environment-specific API key. Never paste a production key into documentation tools.

Path Parameters

clientCode
string
required

Stable non-sensitive Client code authorized by the Integration grant.

Pattern: ^[A-Za-z0-9_-]{1,128}$
externalPaymentRequestId
string
required

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.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Response

Delivery state and acknowledgement.

acknowledgement
object
required

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.

capability
object
required

What PayPathIQ can deliver for this connection today. disabled means no delivery attempt will be made.

deliveryOwner
enum<string>
required
Available options:
partner,
paypathiq
externalPaymentRequestId
string
required
Pattern: ^[A-Za-z0-9_-]{1,128}$
delivery
object