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

OriginalTransaction

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

Represents an original transaction with its identifying information.

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
transactionId required string The unique identifier for 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.
pnRef required integer (int32) The PNRef (Processor's Reference Number) for 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.
authCode required string The authorization code for 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.
transactionType required TransactionType TransactionType The transaction type of the original 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.
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.
entryMode required EntryModes EntryModes The entry mode used in the original transaction, if available. 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.
Unknown The entry mode is unknown.
NotApplicable The entry mode is not applicable for this transaction.
Manual The transaction details were entered manually.
UnencryptedCardReaderSwipe The card was swiped through an unencrypted card reader.
EncryptedCardReaderSwipe The card was swiped through an encrypted card reader.
Icc The transaction was processed using an ICC (Integrated Circuit Card) or chip card.
Proximity The transaction was processed using a proximity or contactless payment method.
Fallback The transaction was processed using a fallback method when the primary method failed.
TechnicalFallback The transaction was processed using a fallback method when the primary method failed.
EmptyCandidateFallback The transaction was processed using a fallback method when the primary method failed.
DigitalWallet The transaction was processed using a digital wallet.
paymentMethodsGranular required PaymentMethodsGranular PaymentMethodsGranular The granular payment method used in the original 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.
Amex American Express card.
Discover Discover card.
Visa Visa card.
MasterCard MasterCard.
JCB Japan Credit Bureau card.
CUP China UnionPay card.
Diners Diners Club card.
Debit Debit card.
Ebt Electronic Benefit Transfer.
Ach Automated Clearing House.
Check Check payment.
Cash Cash payment.
Generic Generic or unspecified payment method.
ApplePay Apple Pay digital wallet.
GooglePay Google Pay digital wallet.
DigitalWallet Generic / unspecified digital wallet.
Paze Paze digital wallet.
AlternativePayment An alternative payment method approved inside a provider (PayPal, Venmo, Pay Later, Affirm, Klarna, Afterpay) and presented to the gateway as an approval reference.
sureChargeAmt required number (double) The surcharge amount from the original 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.
authAmt required number (double) The authorized amount from the original 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.
totalAmt required number (double) The total amount from the original 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.

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.