This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-11-12 05:58 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The evidence the hosted payment page records when a cardholder ticks the consent checkbox.
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
ipAddressrequired
string
The cardholder's IP address when they consented.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.
userAgentrequired
string
The cardholder's browser user agent when they consented.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.
hppSessionIdrequired
string
The hosted payment page session in which the cardholder consented.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.
checkboxLabelrequired
string
The exact label of the checkbox the cardholder ticked.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.
cardConsentMerchantTermsVersionrequired
string
Version (`sha256:{hex}`) of the merchant's own terms the hosted payment page showed under the
card consent text. Null when the page showed no terms, and for a bank account consent.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.
pageDisclosureTextVersionrequired
string
Version hash (`sha256:{hex}`) of the hosted payment page disclosure text the cardholder
accepted on the payment that established this consent. Read-only. `null` when
the page did not require acceptance, when the page asked the cardholder to accept a convenience
fee disclosure without showing disclosure text of its own, or for a consent captured before
acceptance was recorded.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.
pageDisclosureAcceptedAtrequired
string (date-time)
UTC time the cardholder's acceptance of the hosted payment page disclosure was recorded on the
payment that established this consent (server-stamped). Read-only. `null` when
the page did not require acceptance, or for a consent captured before acceptance was recorded.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.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.