API reference

CustomerVerification

Type: Enum

Usage: It conveys information to display/ print the customer verification text for card transaction receipt

ValueDescription
OFFLINE_PINReceipt should print "Verified by PIN"
OFFLINE_PIN_AND_SIGNATUREReceipt should print "Verified by PIN and signature"
SIGNATUREReceipt should print "Verified by cardholder signature"
CDCVM(Amex CPQR) requires to print "Verified by CDCVM"
STTReceipt should print "No signature required (STT)"
NO_NEEDReceipt should print "no signature required"

EntryMode

Type: Enum

ValueDescription
CONTACTLESS(NFC) Contactless card/ mobile
CHIP(ICC) Chip card
MAGSTRIPE(MSR) Magnetic stripe card
FALLBACKFallback from chip to swipe
MANUAL(MKE) Manual keyed entry
QR_SCAN(CPQR) Consumer-present QR, merchant scan
QR_PRESENT(MPQR) Merchant-present QR, consumer scan
CASHCash
OCTOPUSOctopus

ForceAcquirer

Type: Enum

  • EDC
  • CUP
  • QR
  • EPS
  • DCC

PaymentMethod

Type: Enum

ValueDescription
VISAVisa
MASTERMastercard
AMEXAmerican Express
JCBJCB
UNIONPAYUnionPay
ALIPAYAlipay
WECHATWeChat Pay
CASHCash
FPSFPS
OCTOPUSOctopus
UPI_QRUnionPay International QR
EPSEPS

PosRequestData

Type: defined data structure

FieldTypePresenceDescriptionRemark
posIdStringMandatoryPOS identifier
messageIdStringMandatoryRequest identifier from POS
transactionTypeEnum<TransactionType>MandatoryRequested transaction type
requestAmountDecimalConditionalRequest total amountRequired for SALE, TIP_ADJUST, AUTH, REFUND
currencyStringConditionalISO-4217 Alpha-3 currency codeRequired for SALE, TIP_ADJUST, AUTH, REFUND
tipAmountDecimalOptionalTip amount
cashbackAmountDecimalOptionalCashback amount (EPS)
preferredInstrumentEnum<PreferredInstrument>OptionalThe first interface prompt in payment app
passwordStringOptionalThe operation password for sensitive ops (eg. void, refund)
forceAcquirerEnum<ForceAcquirer>OptionalForce the terminal to use only this specific acquirer
approvalCodeStringConditionalApproval code of (previously) authorized transactionRequired for OFFLINE_SALE, AUTH_COMPLETE
rrnStringOptionalRRN of (previously) approved transactionOptional for REFUND, AUTH VOID
originalTerminalTransactionIdStringConditionalOriginal transaction ID used to retrieve (and modify) transaction(Either this or trace) Required for VOID, TIP_ADJUST
traceStringConditionalOriginal trace used to retrieve (and modify) transaction(Either this or OrgTranId) Required for VOID, TIP_ADJUST
upiVoidDataObject<UPIAuthVoidDetailData>ConditionalAdditional info for CUP Pre-auth voidRequired for CUP AUTH VOID

PosResponseData

Type: defined data structure

FieldTypePresenceDescriptionRemark
responseResultEnum<ResponseResult>MandatoryThe request result
posIdStringMandatoryCopy from request
messageIdStringMandatoryCopy from request
terminalTransactionIdStringConditionalThe unique transaction ID generated by terminalFor payment request and result SUCCESS
responseCodeIntConditional4 digits response code. Ref to ResponseCodeFor request result FAILED
responseMessageStringConditionalHuman readable response message. Ref to ResponseCodeFor request result FAILED
transactionResultTransactionResultConditionalPayment request resultFor payment request and result SUCCESS
settlementResultList<SettlementResponseData>ConditionalSettlement request resultFor settlement request and result SUCCESS

PreferredInstrument

Type: Enum

  • DEFAULT
  • CARD
  • QR
  • EPS
  • OCTOPUS
  • CASH
  • ZELLE

ReceiptRequest

Type: defined data structure

FieldTypeDescription
htmlStringStringThe html to print

ResponseResult

Type: Enum

  • SUCCESS
  • FAILED

SettlementResponseData

Type: defined data structure

FieldTypeDescription
resultResponseResult
responseCodeInt4 digits response code. Ref to ResponseCode
responseTextStringHuman readable response message. Ref to ResponseCode
acquirerIdString
acquireNameStringAcquirer name used to print on receipt/ report
batchNumberLong
valueDateString(EPS only)

TransactionResult

Type: defined data structure

FieldTypeDescription
posReferenceIdString
poiReferenceIdString
processorReferenceIdString
acqReferenceIdString
traceLong
batchLong
deviceIdString
acquirerIdString
acquirerMidString
acquirerTidString
messageFormatEnum<MessageFormat>
createTimeString
lastUpdateTimeString
originalTransactionDateString
currencyString
totalAmountDecimal
baseAmountDecimal
billingAmountDecimal
tipAmountDecimal
cashbackAmountDecimal
receivedAmountDecimal
remainingValueDecimal
receivedCashDecimal
changeDueDecimal
cardholderCurrencyString
dccBaseAmountDecimal
dccTipAmountDecimal
fxRateTextString
markupRateTextString
tranTypeEnum<TransactionType>
tranStatusEnum<TransactionStatus>
paymentMethodEnum<PaymentMethod>
entryModeEnum<EntryMode>
customerVerificationEnum<CustomerVerification>
refundableBoolean
voidableBoolean
adjustableBoolean
printRetrievalQrBoolean
settledBoolean
demoModeBoolean
maskedPanString
displayExpiryString
cardholderNameString
paymentAccountIdString
appNameString
aidString
tcString
approvalCodeString
tvrString
tsiString
atcString
upiTraceString
upiRRNString
ippPlanString
numberOfInstalmentsInt
signatureStringString
debitAccountIndicatorString(EPS only)
inputSequenceNumberString(EPS only)
debitAccountUsedString(EPS only)
transactionValueDayString(EPS only)
shopLogoString
shopNameString
shopAddressString
receiptHeaderList
shopEmailString
shopPhoneString
promotionMessage1String
promotionMessage2String
productCodeString

TransactionStatus

Type: Enum

  • PROCESSING
  • APPROVED
  • DECLINED
  • ERROR
  • VOIDED
  • ADJUSTED
  • OFFLINE

TransactionType

Type: Enum

  • SALE
  • VOID
  • REFUND
  • AUTH
  • AUTH_COMPLETE
  • TIP_ADJUST
  • OFFLINE_SALE

UPIAuthVoidDetailData

Type: defined data structure

FieldTypePresenceDescription
originalTranTypeEnum<TransactionType>Original transaction type
approvalCodeString
upiRRNString
originalIdString
Last updated on 10/23/2020 by Jeff Kwok
← Receipt requestResponse code →