WinkPG Docs
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

ConsentConfigDto

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

The effective consent configuration for an authenticated merchant, returned by `GetAsync`. API clients fetch this to render the exact consent text the cardholder will see and to know whether capture is enforced.

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
isConsentRequired required boolean True when the authenticated merchant's scope has consent capture enforced. A transaction that tokenizes/persists a card without a `StoredCredentialConsentInput` will be rejected with `stored_credential_consent_required`.
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.
allowedUsages required StoredCredentialUsage StoredCredentialUsage The usage scopes the merchant's configuration permits. Matches the flags that can legitimately appear on captured consents for this merchant; consumers render only the matching checkboxes / bullets. 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.
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.
None No permitted uses. Consent record is effectively inactive.
Recurring Scheduled recurring charges (subscriptions, membership dues). Maps to Recurring.
Installment Fixed-schedule installment plans dividing a known total. Maps to Installment.
UnscheduledCOF Merchant-triggered charges for pre-agreed events (balance top-ups, usage overages, no-show fees, delayed charges). Maps to several MIT reason codes including UnscheduledCOF, NoShow, DelayedCharge, and IncrementalAuth.
OneTimeFuture A single known future cardholder-initiated purchase the credential was saved for (e.g. "save card for my next order"). Not used for MITs.
text required ConsentTextConfigDto ConsentTextConfigDto Rendered consent text with version metadata.
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 of ConsentTextConfigDto:

Field Type Description
version required string Version hash of the rendered template. Clients persist this and submit it back on the transaction so WinkPG records exactly what the cardholder saw. 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.
rendered required string Fully-rendered, substituted consent text with merchant variables applied. No `{{Variable}}` markers should remain in well-configured merchants; any that do are surfaced via `missingVariables` for diagnosis. 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.
locale required string Locale of the rendered text. Single-locale (en-US) for v1. 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.
lastUpdatedAt required string (date-time) Reserved. Always `1970-01-01T00:00:00Z` today; `version` is the identity of the text.
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.
missingVariables required array of string array of Reserved for the names of template variables that had no value at render time. Always empty today. 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 body has no documented fields.

disclosures required ConsentDisclosuresDto ConsentDisclosuresDto Merchant-configured disclosure URLs referenced from the consent text.
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 of ConsentDisclosuresDto:

Field Type Description
termsUrl required string Merchant's terms of service URL. Empty when not configured. 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.
privacyUrl required string Merchant's privacy policy URL. Empty when not configured. 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 body has no documented fields.

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.