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.
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.
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.
sureChargeAmtrequired
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.
authAmtrequired
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.
totalAmtrequired
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.