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

BatchFileTransactionDto

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

DTO for a transaction within a batch file.

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
id required string (uuid) Gets or sets the unique identifier of the batch file transaction.
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.
batchFileId required string (uuid) Gets or sets the unique identifier of the batch file associated with this transaction.
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.
lineNumber required integer (int32) Gets or sets the line number associated with the batch file transaction.
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.
transactionType required TransactionType TransactionType Gets or sets the type of the transaction.
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.
Authorization Represents an authorization transaction, typically used to verify funds availability without capturing the amount.
Sale Represents a sale transaction, which authorizes and captures funds in a single step.
Return Represents a return transaction, used to refund money to the customer.
Void Represents a void transaction, used to cancel a previously authorized transaction before it is settled.
Force Represents a force transaction, typically used to manually enter a previously authorized transaction.
Capture Represents a capture transaction, used to capture funds from a previously authorized transaction.
CaptureAll Represents a capture all transaction, used to capture funds from multiple previously authorized transactions.
RepeatSale Represents a repeat sale transaction, used to process a new sale based on a previous transaction's details.
Adjustment Represents an adjustment transaction, used to modify the amount of a previous transaction.
Activate Represents an activate transaction, typically used to activate a gift card or prepaid card.
Deactivate Represents a deactivate transaction, typically used to deactivate a gift card or prepaid card.
Redeem Represents a redeem transaction, typically used to redeem value from a gift card or loyalty program.
Inquire Represents an inquire transaction, used to check the status or balance of an account or card.
Reload Represents a reload transaction, typically used to add value to a gift card or prepaid card.
VoucherClear Represents an offline EBT voucher clear: a terminal was offline, a paper food-stamp (SNAP) or eWIC voucher was written against a voice-obtained approval code, and the voucher is later uploaded so the benefit clears. Permitted on EBT SNAP and eWIC tenders only.
Payout Represents a payout transaction, used to push funds from the merchant to an external bank account as an ACH credit. Unlike Return, which refunds a prior debit, a payout is a standalone outbound fund transfer with no originating transaction.
amount required number (double) Gets or sets the monetary amount associated with the batch file transaction.
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.
cardNumber required string Gets or sets the masked payment card number associated with the transaction. 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.
customerName required string Gets or sets the customer name associated with the batch file transaction. 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.
processedTransactionId required string (uuid) Gets or sets the identifier of the transaction that has been processed for this batch file transaction. 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.
resultCode required ResultCode ResultCode Gets or sets the result code indicating the outcome of the batch file transaction. 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.
Ok Indicates a successful operation.
UserAuthenticationFailed Indicates that user authentication has failed.
InvalidTransaction Indicates that the transaction is invalid.
InvalidTransactionType Indicates that the transaction type is invalid.
InvalidAmount Indicates that the amount specified in the transaction is invalid.
InvalidMerchantInfo Indicates that the merchant information provided is invalid.
InvalidRegisterInfo Indicates that the register information provided is invalid.
FieldFormatError Indicates an error in the format of a field.
NotATransactionServer Indicates that the server is not a transaction server.
InvalidParameterStream Indicates that the parameter stream is invalid.
TooManyLineItems Indicates that there are too many line items in the transaction.
ClientTimeoutWaitingForResponse Indicates that the client timed out while waiting for a response.
Decline Indicates that the transaction was declined.
Referral Indicates that the transaction requires a referral.
TransactionTypeNotSupportedInThisVersion Indicates that the transaction type is not supported in the current version.
Partial Indicates a partial completion of the transaction.
DuplicateBatchProcessed Indicates that a duplicate batch has been processed.
IndeterminateBatchState Indicates that the batch state is indeterminate.
Reject Indicates that the transaction was rejected.
OriginalTransactionIdNotFound Indicates that the original transaction ID was not found.
CustomerReferenceNumberNotFound Indicates that the customer reference number was not found.
AccountNumberTruncated Indicates that the account number was truncated.
InvalidAbaNumber Indicates that the ABA (American Bankers Association) number is invalid.
InvalidAccountNumber Indicates that the account number is invalid.
InvalidExpirationDate Indicates that the expiration date is invalid.
TransactionTypeNotSupportedByHost Indicates that the transaction type is not supported by the host.
InvalidReferenceNumber Indicates that the reference number is invalid.
InvalidReceiptInformation Indicates that the receipt information is invalid.
InvalidCheckHolderName Indicates that the check holder name is invalid.
InvalidCheckNumber Indicates that the check number is invalid.
CheckDlVerificationRequiresDlState Indicates that check DL verification requires a DL state.
PaymentTypesDoNotMatch Indicates that the payment types do not match.
InvalidVNumber Indicates that the V number is invalid.
Submit Indicates that the transaction should be submitted.
Pend Indicates that the transaction is pending: nothing was created and nothing went wrong, the outcome is simply not final yet.
InsufficientFundsAvailable Indicates that there are insufficient funds available for the transaction.
GeneralError Indicates a general error has occurred.
TimeoutValueTooSmall Indicates that the timeout value is too small.
ProcessorNotAvailable Indicates that the processor is not available.
ErrorReadingResponseFromHost Indicates an error occurred while reading the response from the host.
TimeoutWaitingForProcessorResponse Indicates a timeout occurred while waiting for the processor response.
CreditError Indicates a credit error has occurred.
HostNotAvailable Indicates that the host is not available.
DuplicateSuppressionTimeout Indicates a timeout occurred during duplicate suppression.
VoidError Indicates an error occurred during a void operation.
TimeoutWaitingForHostResponse Indicates a timeout occurred while waiting for the host response.
DuplicateTransaction Indicates that the transaction is a duplicate.
CaptureError Indicates an error occurred during capture.
FailedAvsCheck Indicates that the AVS (Address Verification System) check failed.
CannotExceedSalesCap Indicates that the transaction cannot exceed the sales cap.
NetworkNotFound Indicates that the network was not found.
ReversalError Indicates an error occurred during reversal.
InvalidIssuer Indicates that the issuer is invalid.
InvalidIndustry Indicates that the industry is invalid.
InvalidCompliance Indicates that the compliance is invalid.
RegisterNotAuthenticated Indicates that the register is not authenticated.
RegisterAuthenticationFailed Indicates that register authentication failed.
RegisterAlreadyAuthenticated Indicates that the register is already authenticated.
ProcessorNotConfigured Indicates that no active processor profile is configured for the transaction's payment method. This is a merchant configuration issue, not a communications failure.
PinDebitNotSupportedOnCreditBin Indicates that the request carried PIN data while the resolved BIN funding source is Credit. A credit BIN cannot take a PIN debit authorization, so the request contradicts itself rather than merely being underspecified, and the gateway rejects it before the processor sees it.
CardNotAcceptedByMerchantPolicy Indicates that the merchant's card acceptance policy refuses this card. The card was judged from its BIN by funding source, issued entity and issuer country, and one of those axes is one the merchant has configured itself not to take.
ThreeDSecureAuthenticationRequired Indicates that the merchant requires 3-D Secure authentication on this kind of transaction and the transaction arrived without a usable authentication: none ran, the issuer did not authenticate the cardholder, or the result the pipeline was handed failed validation.
CashAmountExceedsMerchantPolicy Indicates that a cash sale is above the largest cash sale the merchant's cash policy allows.
CashRegisterRequiredByMerchantPolicy Indicates that a cash sale names no register (till) and the merchant's cash policy requires one.
CashSourceNotAllowedByMerchantPolicy Indicates that a cash sale came from a source other than the Virtual Terminal and the merchant's cash policy takes cash at the Virtual Terminal only.
GenericHostError Indicates a generic host error.
InvalidLogin Indicates that the login is invalid.
InsufficientPrivilege Indicates insufficient privileges for the operation.
InvalidLoginBlocked Indicates that the invalid login has been blocked.
InvalidLoginDeactivated Indicates that the invalid login has been deactivated.
TransactionTypeNotAllowed Indicates that the transaction type is not allowed.
UnsupportedProcessor Indicates that the processor is not supported.
InvalidRequestMsg Indicates that the request message is invalid.
InvalidVersion Indicates that the version is invalid.
PaymentTypeNotSupported Indicates that the payment type is not supported.
ErrorStartingTransaction Indicates an error occurred while starting the transaction.
ErrorFinishingTransaction Indicates an error occurred while finishing the transaction.
ErrorCheckingDuplicate Indicates an error occurred while checking for duplicates.
NoRecordsToSettle Indicates that there are no records to settle.
NoRecordsToProcess Indicates that there are no records to process.
MustSettleAllPaymentTypes Indicates that all payment types must be settled.
InvalidPoNumber Indicates that the PO (Purchase Order) number is invalid.
FraudControlDecline Indicates a fraud control decline.
FraudControlAuthAndHold Indicates a fraud control authorization and hold.
FraudControlNoAuthAndHold Indicates a fraud control with no authorization and hold.
FraudControlAudit Indicates a fraud control audit.
PolicyRejected The transaction was rejected by the merchant's own address verification (AVS) or security code (CVV) policy rather than by the issuer. Not an error: the request was answered, and the answer is on the transaction. responseData.declineReasonCode says which of two shapes it took, using the published decline reason vocabulary (/docs/decline-reason-codes on the developer portal): CV_REJECTED when the processor approved and the platform then released the hold with a reversal or void, and CV_NATIVE_DECLINE when the processor applied the rule itself and declined outright, so no hold was ever placed.
Undefined Indicates an undefined or unspecified result.
resultMessage required string Gets or sets a message describing the outcome of the batch file transaction. 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.
isProcessed required boolean Gets or sets a value indicating whether the batch file transaction has been processed.
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.
isSuccess required boolean Gets or sets a value indicating whether the batch file transaction completed successfully.
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.
processedDate required string (date-time) Gets or sets the date and time when the batch file transaction was processed. 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.
rawData required string Always null. Retained so existing clients that read the member keep deserializing. 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.
errorMessage required string Gets or sets a human-readable description of the error associated with the batch file transaction, if any. 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.
expirationDate required string (date-time) Gets or sets the expiration date of the card as supplied in the batch file row. 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.