Skip to main content
GET
Get a hosted payment request

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

Current payment request.

createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
expiresAt
string<date-time> | null
required

When the most recent payment link stops working. Null once the request is no longer open.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
externalCustomerId
string
required

Caller-assigned, opaque identifier for this Customer's source-system record. It is not a PayPathIQ ID, member number, loan or account number, or contact detail. Keep it stable when Customer details change.

Pattern: ^[A-Za-z0-9_-]{1,128}$
externalPaymentRequestId
string
required
Pattern: ^[A-Za-z0-9_-]{1,128}$
items
object[]
required
paymentUrl
string<uri> | null
required

Hosted payment page on the Client's verified payment domain. It is a secret: send it only to the paying Customer. Returned by create and by an exact retry while the request is open; null on reads.

revision
integer
required

Increases each time the request's status changes. It matches the revision in change-feed events.

Required range: 1 <= x <= 9007199254740991
status
enum<string>
required

paid is set only after the payment provider's verified confirmation. Returning from the hosted page never changes this status.

Available options:
open,
payment_in_progress,
under_review,
paid,
expired,
replaced,
cancelled
totalAmount
object
required