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

VirtualTerminalSettings

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
cardBinPrompting required VirtualTerminalCardBinPrompting VirtualTerminalCardBinPrompting
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 VirtualTerminalCardBinPrompting:

Field Type Description
enableCommercial 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.
enableGsa 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.
enableFsa 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.

This body has no documented fields.

allowRepeatSales 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.
allowRefunds 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.
enableEmailReceipts 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.
fields required VirtualTerminalFields VirtualTerminalFields
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 VirtualTerminalFields:

Field Type Description
customer required VirtualTerminalCustomerField VirtualTerminalCustomerField
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.
invoiceNumber required VirtualTerminalInvoiceNumField VirtualTerminalInvoiceNumField
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.
purchaseOrderNumber required VirtualTerminalPurchaseOrderNumField VirtualTerminalPurchaseOrderNumField
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.
billingAddress required VirtualTerminalBillingAddressFieldGroup VirtualTerminalBillingAddressFieldGroup
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.
shippingAddress required VirtualTerminalShippingAddressFieldGroup VirtualTerminalShippingAddressFieldGroup
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.
contactPhone required VirtualTerminalPhoneField VirtualTerminalPhoneField
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.
level3Amount required VirtualTerminalLevel3AmountField VirtualTerminalLevel3AmountField
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.
shippingAmount required VirtualTerminalShippingAmountField VirtualTerminalShippingAmountField
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.
convenienceAmount required VirtualTerminalConvenienceFeeField VirtualTerminalConvenienceFeeField
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.
dutyAmount required VirtualTerminalDutyAmountField VirtualTerminalDutyAmountField
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.
tipAmount required VirtualTerminalTipAmountField VirtualTerminalTipAmountField
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.
taxAmount required VirtualTerminalTaxField VirtualTerminalTaxField
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.
emailAddress required VirtualTerminalEmailField VirtualTerminalEmailField
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.

allowPartialApprovals required boolean Merchant-level master switch for partial approvals. When false, no processor profile can enable partial approvals for this merchant; when true, each profile still decides per card type through its own partial-auth field. A merchant document written before this setting existed carries no value, which reads as the default (available). Conditional: When AllowPartialApprovals is false and CardBinPrompting is not null and CardBinPrompting.EnableFsa is true. 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.
partialApprovalStrategy required PartialApprovalStrategy PartialApprovalStrategy What the platform does with a partial approval. Null means unconfigured and resolves to `RequireOperatorAcknowledgment`. 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.
RequireOperatorAcknowledgment Hold the partial authorization and wait for an operator to accept the approved amount or void it. The platform takes no action of its own until the operator answers, or until partialApprovalAckTimeoutMinutes elapses.
AutoAccept Keep the approved amount without asking. The remainder is collected as a second tender when split tender is permitted, or left uncollected when it is not.
AutoVoid Void the partial authorization immediately and treat the sale as not completed. Use where a short payment is never acceptable and the cardholder should be asked for another card.
allowSplitTender required boolean Whether the remainder of a partially approved sale may be collected on a second tender. Null reads as the default (permitted). 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.
allowTipAdjustmentOnPartialApproval required boolean Whether a tip may be adjusted on a transaction the issuer already reduced. Opt-in; null reads as the default (not permitted). Conditional: When AllowPartialApprovals is false and AllowTipAdjustmentOnPartialApproval is true. 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.
splitTenderMaxTenders required integer (int32) Maximum number of tenders a single sale may be split across. Null reads as the default (`DefaultSplitTenderMaxTenders`). Conditional: When AllowPartialApprovals is false and SplitTenderMaxTenders is not null. nullablemin 1max 4
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.
partialApprovalAckTimeoutMinutes required integer (int32) How long the platform waits for an operator to accept or void a partial approval before the acknowledgment window closes. Only meaningful under `RequireOperatorAcknowledgment`. Null reads as the default (`DefaultPartialApprovalAckTimeoutMinutes`). Conditional: When PartialApprovalAckTimeoutMinutes is not null and PartialApprovalStrategy is not null and PartialApprovalStrategy != RequireOperatorAcknowledgment. nullablemin 1max 1440
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.