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

TrxAmounts

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

Represents the various amounts associated with a transaction.

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
base required number (double) The base amount of the transaction. This value cannot be negative and is required. 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.
tip required number (double) The tip amount of the transaction. This value cannot be negative. 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.
tax required number (double) The tax amount of the transaction. This value cannot be negative. 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.
shipping required number (double) The shipping amount of the transaction. This value cannot be negative. 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.
convenience required number (double) The convenience fee amount of the transaction. This value cannot be negative. 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.
conveniencePercentage required number (double) The convenience fee percentage of the transaction. This value cannot be negative. 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.
surcharge required number (double) The surcharge amount of the transaction. This value cannot be negative. Applies only when the surcharging feature is enabled for the merchant: on an initial transaction submit, a non-zero value is rejected at the create boundary when surcharging is disabled. 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.
surchargeAssessed required boolean Server-owned marker indicating the gateway itself computed `surcharge` for this transaction. Only the trusted surcharge-enrichment path may set this; every other create/update path must leave it null, including when a caller supplies a raw `surcharge` value. 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.
convenienceChargedSeparately required boolean Server-owned marker indicating the convenience fee is billed as a separate, linked charge transaction rather than folded into this transaction's `total`. Only the trusted transaction pipeline may set this; every create/update path must leave it null, including when a caller supplies a raw `convenience` value. 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.
cashback required number (double) The cash handed to the cardholder at the point of sale on a PIN debit or EBT Cash purchase. This value cannot be negative. 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.
total required number (double) The total amount of the transaction. This property is calculated based on the sum of Base, Tip, Tax, Shipping, Convenience, and (when `surchargeAssessed` is true) Surcharge amounts. When `convenienceChargedSeparately` is true the Convenience amount is excluded, because the fee bills as its own linked charge transaction. The value must be positive and is required. 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.