The house asking a guest for money against one booking, with a pay link (Mews’s payment request): an amount, a reason (deposit, prepayment, fee, a missing or declined card), a kind (payment takes the money, preauthorization places a hold captured later) and a required expires_at. pending until the guest pays on the card rail’s hosted page (completed, with the payment it produced), the house withdraws it (cancelled, only from pending) or the night audit finds it past expires_at (expired). A completed payment lands on the booking’s own account through record_deposit_payment, so the deposit engine’s status ladder moves; a completed preauthorization is the authorise path’s pending payment. Money that moves after a request was cancelled or expired is still recorded — the request completes late — because a ledger that refuses a settled payment disagrees with the processor.
Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.
When the card rail next looks at the chase — the next reminder, else the deadline; cleared once the deadline has passed
stringformat: date-time
authentication_overdue_at
When the deadline passed with the guest not done and the house was told
stringformat: date-time
authentication_page_decline
The processor's words for the decline on the page — the chase stays pending
string
authentication_page_declined_at
When the guest's card was last declined on the page
stringformat: date-time
authentication_page_overpaid_at
When the chase's page was paid after what it asked for had been taken another way — the page's payment has no ledger home
stringformat: date-time
authentication_page_overpaid_detail
Why the page's payment had no home, and whether it was given back or is left for a person
string
authentication_page_overpaid_reference
The processor's intent the overpaid page took
string
authentication_page_refund_reference
The processor's refund that gave the overpaid page's money back
string
authentication_reminders
How many reminders the house sends before the deadline
integer
authentication_reminders_sent
How many reminders have been taken so far
integer
authentication_resent_at
When the desk last re-sent the chase's page (one re-send per ten minutes)
stringformat: date-time
authentication_stay_ref
The departed stay whose late charges the guest is asked to confirm
stringformat: uuid
cancellation_reason
Why the house withdrew it
string
cancelled_at
When the house withdrew it
stringformat: date-time
completed_at
When the processor settled it
stringformat: date-time
completed_late
True when the money arrived after the request was cancelled or had expired — recorded, and worth the desk's look
boolean
expired_at
When the night audit expired it
stringformat: date-time
expires_at
required
When the request lapses; the night audit closing on or after this instant's date expires it while it is still pending
stringformat: date-time
guest_notice_note
Why the pay link was not sent to the guest, when it was not
string
guest_notice_ref
The outbound message that carries the pay link to the guest
stringformat: uuid
guest_notified_at
When the pay link was queued for the guest
stringformat: date-time
id
required
Payment request id
string
kind
required
`payment` takes the money; `preauthorization` holds it for capture later
string
Allowed values: paymentpreauthorization
note
What the guest reads beside the amount (the pay page's line item)
string
page_fee_ceiling
Payment request page fee ceiling
The application_fee_amount the card rail set on the hosted page when it minted it, in the request’s currency: the account’s dearest card class online, because a Payment Link’s fee is fixed before any card exists. When the page completes the rail reads the card it was paid with and refunds the difference to that card’s own class to the hotel, recording the outcome on the payment (record_page_fee). Absent when the page settles to the platform’s own account (no fee) or was minted before the ceiling.
object
amount
required
stringformat: decimal
currency
required
stringformat: iso-4217
pay_url
The card rail's hosted page the guest pays on — absent until the rail has minted it
string
payment_id
The payment the completed request produced
stringformat: uuid
psp_link_reference
The processor's handle on the hosted page (a Stripe Payment Link id), so the rail can switch it off when the request ends
Why the hold could not be re-placed (no stored card, a decline) — it lapses at the issuer, and the desk takes a new guarantee
string
reauthorisation_refused_at
When the card rail last tried to re-place the hold and could not
stringformat: date-time
reauthorised_at
When the card rail last re-placed the hold before the issuer lapsed it
stringformat: date-time
refusal_notice_at
When the guest was queued a message that their card was not accepted
stringformat: date-time
refusal_notice_note
Why the guest was not told their card was not accepted, when they were not
string
refusal_notice_ref
The outbound message that tells the guest their card was not accepted
stringformat: uuid
refusal_signal_ref
The network's answer that refused the hold the guest's card placed on the pay page
stringformat: uuid
requested_at
required
When the house asked
stringformat: date-time
reuse_terms
The card terms the pay page showed the guest — what they agreed to when the page saved their card for later charges by the house
string
status
required
pending → completed / cancelled / expired
string
Allowed values: pendingcompletedcancelledexpired
stuck_psp_reference
The processor's intent the issuer refused to complete without the cardholder (a Stripe PaymentIntent left `requires_payment_method`); cancelled once the page is paid
string
provenance
Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.
Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.