Objects

Objects used by the POS Custom Payment Adapter plugin.

BatchReportObject

Returned by batchReport and historyReport, this object contains necessary reporting data.

Variable	Type
transactionStatus	boolean
resultCode	string
resultText	string
totalCount	number
totalAmount	number
batchNumber	string
timestamp	string
hostResponseMessage	string
terminalId	string
merchantId	string
transactions	ReportObjectTransaction[]

BatchSettleObject

Used by endOfDay and batch, this object contains information required to settle transactions.

Variable	Type
transactionStatus	boolean
resultCode	string
resultText	string
totalCount	number
totalAmount	number
batchNumber	string
timestamp	string
transactionStatusCode?	number
uploadedCount?	number
uploadedAmount?	number
pendingCount?	number
pendingAmount?	number
failedCount?	number
failedAmount?	number
hostResponseMessage	string
terminalId	string
merchantId	string
batchContainsSaf?	boolean
transactions	ReportObjectTransaction[]

Variables marked with ? are optional.

Device Features

Used by getAvailableFeatures to return a list of available payment device features.

Variable	Type
ACCOUNT_AS_PARAMETER	boolean
ACTIVATE	boolean
ADJUST_TIPS	boolean
BATCH_GENERATION	boolean
BATCH_SCHEDULE	boolean
CASHOUT	boolean
GET_TIMEOUTS	boolean
GET_TRANSACTION	boolean
KEEP_ORDER_CONNECTION	boolean
MANUAL	boolean
ORDER_START	boolean
PAIRING	boolean
PING	boolean
SAF_UPLOAD_ON_REQUEST	boolean
SWIPE_AHEAD	boolean
TRANSACTION_STATUS_CODE	boolean
VOICE_AUTH	boolean
VOID_EVERYWHERE	boolean
VOID_REFUND	boolean

ReportObjectTransaction

Contained within SAFUploadObject and BatchSettleObject, this object contains transaction necessary data.

Variable	Type
transaction_id	string
offline_id	string
transaction_type	string
transaction_amount	string
card_type	string
card_number	string
processed_at	string - timestamp
transaction_status	boolean
saf_status	'approved' \| 'declined' \| 'pending'

SAFUploadObject

Used by isSAFUploadOK and safUpload, this object includes necessary SAF processing information.

Variable	Type
transactionStatus	boolean
resultCode	string
resultText	string
uploadedCount	number
uploadedAmount	number
pendingCount	number
pendingAmount	number
failedCount	number
failedAmount	number
transactions	ReportObjectTransaction[]

Timeouts

Returned by getTimouts, this object contains device timeouts for operations in seconds.

{
 CREDIT: {
    ADJUST: number,
    PRE_AUTH: number,
    REFUND: number,
    SALE: number,
    SALE_TIPS: number,
    VERIFY: number,
    VOID_TRANS: number,
    VOICE_AUTH: number,
 },
 DEBIT: {
    REFUND: number,
    SALE: number,
    SALE_TIPS: number,
    VERIFY: number,
    VOID_TRANS: number,
    VOICE_AUTH: number,
 },
 GIFT: {
    ACTIVATE: number,
    ADD_VALUE: number,
    CASH_OUT: number,
    DEACTIVATE: number,
    GET_BALANCE: number,
    SALE: number,
    VOID_TRANS: number,
 },
 REPORT: number,
 BATCH: number,
 ADMIN: number,
}

Transaction

Used by safReport and getTransactionInfo, this object contains necessary transaction information.

Variable	Type
transactionId	string
transactionStatus	boolean
transactionType	string
transactionStatusCode?	number
isResponseTimeout?	boolean
paymentType?	string
resultCode?	string
resultText?	string
safObject?	SAFUploadObject \| SAFReportObject
totalAmount?	number
totalCount?	number
transactionDateTime?	string
uploadedAmount?	number
uploadedCount?	number
acquiredMethod?	string
balance?	string
cardNumber?	string