Documentation

uti

String

Unique Transaction Identifier assigned by the terminal

referenceId

String

Reference ID (from REFERENCE_ID parameter or auto-generated)

correlationId

String

Correlation ID passed by the caller

transactionType

String

SALE, REFUND, PREAUTH, COMPLETION, TOPUP, CASHBACK, CASH_ADVANCE, ALTERNATIVE_PAYMENT

transactionSource

String

PICC (contactless), ICC (chip), MAG (swipe), MOTO

transactionResponse

String

Two-character acquirer response code. "00" = approved

authCode

String

Authorization code (approved transactions only)

messageId

int

Terminal message ID. Required for completion/cancel pre-auth

totalAmount

String

Total charged amount in minor units (includes tip and cashback)

tipAmount

long

Tip amount in minor units

cashbackAmount

long

Cashback amount in minor units

cashbackAdded

boolean

Whether cashback was added to this transaction

primaryAccountNumber

String

PAN: first 6 and last 4 unmasked, middle digits replaced with *

cardNumberLength

int

Full length of the PAN

transactionDate

Date

Date/time of the transaction

timestamp

long

Unix timestamp in milliseconds

merchantId

String

Terminal merchant ID

terminalId

String

Terminal ID

currencyCode

String

ISO 4217 numeric currency code

currencyCodeAlpha

String

ISO 4217 alpha currency code

cardAcceptorAddress

String

Merchant address from terminal configuration

cardholderVerificationMethod

String

CVM_NO_CVM, CVM_OFFLINE_PIN, CVM_ONLINE_PIN, CVM_SIG, CVM_ONLINE_PIN_SIG, CVM_CONSUMER_DEVICE

applicationId

String

EMV AID of the selected card application

appName

String

Card application name in hex

transSource

String

Card type: 240/250/260 = debit; 400/500/530 = credit

isSignature

boolean

Whether a signature is required on the receipt

signature

byte[]

Signature image bytes (on-screen signature only)

merchantReceipt

String[][]

Merchant receipt content (2D array of label/value rows)

cardholderReceipt

String[][]

Cardholder receipt content

payerAccountReference

String

PAR (Payer Account Reference)

walletProvider

String

GOOGLE_PAY, APPLE_PAY, SAMSUNG_PAY, MICROSOFT_PAY, VISA_CHECKOUT, FITBIT_PAY, GARMIN_PAY, UNKNOWN

voided

boolean

Whether this transaction has been voided

dccTransaction

boolean

Whether DCC (Dynamic Currency Conversion) was applied

dccOriginalAmount

long

Original amount before DCC conversion (0 if no DCC)

dccExchangeRate

double

DCC exchange rate (0 if no DCC)

dccCommissionAmount

long

DCC commission in minor units (0 if no DCC)

dccCurrencyCode

String

DCC alphabetic currency code

tsi

String

Transaction Status Information (EMV; empty for MAG/MOTO)

tvr

String

Terminal Verification Result (EMV; omitted for MAG/MOTO)

cvmResult

String

Card Verification Method results

voucherBenefitCardIssuer

String

Card issuer for voucher/benefit card

voucherWalletName

String

Wallet name for voucher transaction

voucherBalance

String

Remaining voucher balance

voucherExpirationDate

String

Voucher expiration date

passReaderId

String

Pass reader device ID (if applicable)

processorCorrelationId

String

Correlation ID assigned by the payment processor

productId

String

Product identifier

productDescription

String

Product description

issuerIdentifier

String

Card issuer identifier

issuingCountry

String

Country of card issuance

issuerRegion

String

Issuer region

cardholderBillingCurrency

String

Cardholder's billing currency

cardUsage

String

Card usage type

cardCategory

String

Card category

adminFee

long

Administrative fee in minor units