View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

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.

API reference Models

ConsentCaptureMethod

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

How consent was obtained from the cardholder when captured via API or Virtual Terminal attestation (HPP has its own channel-implicit capture). Describes the interaction channel between merchant and cardholder, not the integration channel between merchant and WinkPG.

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.
InPerson In-person interaction. Cardholder was physically present.
Phone Phone call with the cardholder (potentially recorded).
SignedForm Paper / digital form signed by the cardholder.
Email Email exchange in which cardholder agreed.
OnlineForm Online form on the merchant's own website / app.
OnScreen The cardholder accepted the terms on a device screen at the point of sale, such as a payment terminal or a tablet, at the moment the card was read.
Other Other method not captured above. Operators / merchants use the notes field or merchant reference to explain.

Fields

Field Type Description

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.