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

ReceiptSplitTenderContextDto

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

Split tender context printed on a receipt: the group the transaction belongs to and its position in it, plus, on a split tender summary, every tender in the group.

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
groupId required string (uuid) Identifier shared by every tender in the group. 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.
tenderSequence required integer (int32) 1-based position of this receipt's transaction within the group. Null on a split tender summary, which covers the whole group. 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.
totalTendersInGroup required integer (int32) Number of tenders in the group, voided ones included. Null when the group size was not known when the receipt was generated, which is the case on a per-tender receipt. 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.
groupTotalAuthorized required number (double) Combined amount authorized across the tenders in the group that were not voided or reversed, in the transaction currency. Null when the whole group was not known when the receipt was generated. 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.
returnedAmount required number (double) What the bank took back from the group after it completed: the sum of the lines marked `isReturned`, in the transaction currency. Null on every receipt that shows no return, including the summary issued when the group completed. 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.
tenders required array of ReceiptSplitTenderLineDto array of ReceiptSplitTenderLineDto One line per tender, ordered by sequence. Populated on a split tender summary; empty otherwise. 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.

Fields of each ReceiptSplitTenderLineDto:

Field Type Description
tenderSequence required integer (int32) 1-based position of the tender within the group. 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.
tenderKind required ReceiptTenderKind ReceiptTenderKind What kind of payment the tender was: a card, an ACH debit from a bank account (check), or cash. A client that meets a value it does not recognize should name the line by its position and amount alone.
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.
Card A card, named by its brand and last four digits.
Check An ACH debit from a bank account, named by the account's last four digits and the check number.
Cash Cash, named as cash: it carries no instrument to identify.
cardBrand required string Card brand (e.g. "Visa"). Null on a check or cash line. 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.
lastFour required string Last four digits of the tender's card, or of the bank account on a check line. Null on a cash line. 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.
checkNumber required string The check number on a check line, when the payment carried one. Null on a card or cash line. 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.
authorizedAmount required number (double) The amount this tender authorized, in the transaction currency. 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.
chargedPrice required ReceiptTenderPrice ReceiptTenderPrice Which of a dual pricing merchant's two prices the payment paid for its share, for a group whose payments are each priced on their own share; null otherwise. 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.
CardPrice A card charged the card price for its share.
CashPrice A cash or bank payment charged the cash price under the merchant's program.
cashPriceAmount required number (double) For a payment charged the card price for its share: what it paid toward the order at the cash price, in the transaction currency, in major currency units. Null otherwise. 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.
isVoided required boolean True when the tender was voided or reversed, so its amount is not part of the group total.
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.
isReturned required boolean True when the bank returned this check payment after the group had collected its order total, so its amount is no longer collected. Shown only on a summary issued after the return.
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.
returnCode required string The NACHA return code (for example `R01`) on a returned check line. 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.
returnReason required string The reason for the return on a returned check line. 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.