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-10-22 22:52 UTC.

API reference Models

MerchantFeatureSettings

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

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
enableGsaBinCheck required boolean Ignored. Nothing reads this flag; the platform decides whether a government-issued card is accepted from the BIN through the merchant card acceptance policy (`CardAcceptancePolicy`), and the Virtual Terminal's GSA prompt is driven by `VirtualTerminal.CardBinPrompting.EnableGsa`. deprecated
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.
enableAuthEdit required boolean
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.
configurationLimits required MerchantConfigLimits MerchantConfigLimits
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 MerchantConfigLimits:

Field Type Description
allowCustomFieldConfig required boolean
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.
allowHostedPaymentPageConfig required boolean
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.
allowOrderDataDefaultsConfig required boolean
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.
allowEmulatorConfig required boolean
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.
allowFraudControlConfig required boolean
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.
allowFraudLog required boolean
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.
allowQuickPayConfig required boolean
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.
allowPaymentTokenizationConfig required boolean When `true`, merchant users may configure their own payment tokenization settings. When `false` or unset, only reseller users may change tokenization configuration on behalf of the merchant. Independent of whether tokenization itself is enabled. 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.

merchantBilling required MerchantBillingSettings MerchantBillingSettings Represents billing configuration options for a merchant, including the referenced price plan and any pricing overrides applied.
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 MerchantBillingSettings:

Field Type Description
pricePlanId required string (uuid) Optional identifier of the price plan governing billing rates for this merchant. 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.
pricePlanVersion required integer (int32) The specific version of the referenced price plan to apply, ensuring billing uses a consistent plan snapshot. 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.
priceOverrides required BillingPriceOverrides BillingPriceOverrides Optional set of billing price overrides that supersede the referenced price plan 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.

This body has no documented fields.

tenders required TenderEnableFlags TenderEnableFlags Per-tender enable flags applied by the capability cascade at the merchant layer. A merchant must explicitly opt in to each non-credit tender (EBT SNAP, EBT Cash, eWIC) before any of its processor accounts can accept it.
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 TenderEnableFlags:

Field Type Description
ebtSnap required boolean Whether `EbtSnap` is enabled at this layer.
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.
ebtCash required boolean Whether `EbtCash` is enabled at this layer.
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.
ewic required boolean Whether `Ewic` is enabled at this layer.
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.

enablePaymentTokenization required boolean Per-merchant override of the reseller-level payment tokenization flag (`paymentTokenization`). `null` means inherit the reseller default; `true`/`false` force-enables or disables tokenization for this merchant. The reseller flag always gates: a merchant cannot turn tokenization on if the reseller has not enabled it. 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.
hppTokenizeOnPaymentDefault required boolean Per-merchant default for whether a Hosted Payment Page session vaults the cardholder's card as a reusable `PaymentToken` on a successful payment, used when the session-create request does not explicitly set `TokenizeOnPayment`. `null` / `false` means do not tokenize by default; `true` opts the merchant's HPP sessions into tokenize-on-payment unless a session overrides it. The targeted page must still allow tokenization (Classic `SupportTokenization` / Streamlined `SavePaymentDetails`) and a tokenizing session must declare a stored-credential consent scope. 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.