InvoicePaymentLinkInfoDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The operator-facing view of an invoice's pay-by-link state: the absolute hosted-payment-page URL a payer can be handed, when it lapses, and the QR code that encodes it.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
invoiceId
required |
string (uuid) | The invoice the link pays.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||
hasPaymentLink
required |
boolean | Whether the invoice currently carries a payment link at all. When `false`, every other
link property is null and the invoice has no payable link to hand out.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||
paymentUrl
required |
string | Absolute, HTTPS hosted-payment-page URL for the payer. Null when
`hasPaymentLink` is `false`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||
expiresAt
required |
string (date-time) | When the link stops working. Null when the invoice carries no link.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||
isExpired
required |
boolean | Whether `expiresAt` is already in the past. Computed server-side so the caller
never has to compare against a client clock. Always `false` when there is no link.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||
qrCodeUrl
required |
string | Public URL of the PNG QR code encoding `paymentUrl`. Null when the invoice has
no link, or when QR generation was skipped or failed: generation is best-effort and never
blocks a send, so a live link with no QR is a normal outcome rather than an error.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||
hppSessionId
required |
string (uuid) | The hosted-payment-page session backing the link. Null for an invoice with no link, and for
a pre-cutover invoice still on the legacy opaque token. Safe to log and to quote in a
support conversation, unlike the URL.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||
amountDue
required |
number (double) | Outstanding balance the link collects, in `currency`.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||
currency
required |
string | ISO 4217 currency code of `amountDue`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||
linkState
required |
InvoicePaymentLinkState InvoicePaymentLinkState | Whether the link still opens the payment page. `Spent`
and `Revoked` come from the payment session behind the
link; when that session cannot be read, the state falls back to
`Live` or `Expired`
from `expiresAt` alone. `None` exactly when
`hasPaymentLink` is `false`.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||
remainingDeclineRetries
required |
integer (int32) | How many more declined payment attempts the link can absorb and still reopen for the payer.
Null when the link does not reopen after a decline, or when the payment session could not be
read.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||
lastAttemptAt
required |
string (date-time) | When a payer last attempted a payment on the link: the attempt that spent it, or the most
recent declined attempt the link reopened after. Null when no attempt is recorded, or when
the payment session could not be read.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.