Developer ZoneRecipesAPI ReferenceChangelog
Developer Zone

Response Parameters

📘

Data Attribute Reference

Data Type

  • A: Alphabet
  • AN: Alphanumeric
  • C: Characters
  • B: Boolean
  • D: Decimal
  • N: Numeric

Mandatory attributes

  • M: Mandatory
  • C: Conditional
  • O: Optional

Response Parameters

Parameter

Data Type

Mandatory

Description

rspCode

C 4

M

Response code

rspMsg

C 255

M

Response description

TransactionResponse  

O

Transaction Response Object
  tranId C 255

O

Generated Unique Transaction ID
  trace C 255

O

Unique Trace ID Generated
  rrn C 255

O

Unique RRN generated by Payment Host
  tranType enum

O

Transaction Type

  • SALE
  • VOID
  • REFUND
  • AUTH
  tranStatus enum

O

Transaction Status

  • Approved
  • Declined
  • Processing
  • Voided
  • Reversed
  approvalCode C 255

O

Approval Code

 

paymentMethod

C 255

O

Payment Method that was used.

 

cardData

C 255

O

Payment Method that was used.

  aid C 255

O

Application AID
  appName C 255

O

EMV Application Name
  tc C 255

O

Transaction Certificate
  tsi C 255

O

Transaction Status Indicator
  tvr C 255

O

Terminal Verification Results
  entryMode C 255

O

Entry Mode (e.g. NFC)
  maskedAccount C 255

O

Masked Account (e.g. **** **** **** 1234)
  cvmPerformed C 255

O

CVM method being used
  acqMid C 255

O

MID which processes this transaction
  acqTid C 255

O

TID which processes this transaction
  posMessageId C 255

O

Unique reference ID generated by application
  mchAddress C 255

O

Merchant address
  mchName C 255

O

Merchant name
  totalAmount D

O

Total transaction amount
  createByName C 255

O

Name of the creator
  createdAt C 255

O

Creation timestamp
  updatedAt C 255

O

Update timestamp

Error Codes

ResultCodeMessage
APPROVED0APPROVED
ERR_TIMEOUT-1Transaction timeout
ERR_INSECURITY_DEVICE-2Device attestation error or security flaw
ERR_ACTIVATION_CODE-3Invalid activation code
ERR_CONNECT-4Transaction connection error
ERR_SEND-5Transaction sending error
ERR_RECEIVE-6Transaction receiving error
ERR_PACK-7Transaction pack request message error
ERR_UNPACK-8Transaction unpack response message error
ERR_NO_ORIG_TRANS-9Original transaction NOT exist
ERR_ALREADY_VOIDED-10Transaction has been voided
ERR_REFUND_UNSUPPORTED-11Not support refund
ERR_VOID_UNSUPPORTED-12Not support void
ERR_HOST_DECLINED-13Host declined the transaction
ERR_USER_CANCEL-14User cancelled the transaction
ERR_ABORTED-15Transaction was aborted with some reasons,please try to get device status or do warmup
ERR_AMOUNT-16Transaction amount exceeds the allowed contactless transaction limit
ERR_CARD_UNSUPPORTED-17The transaction is declined by the card and cannot perform the transaction
ERR_CARD_INVALID-18Invalid card, please change another card and retry
ERR_EMV_DECLINED-19Invalid EMV parameters, please check EMV configurations
ERR_NOT_ACTIVATED-20Card reading incomplete, please tap and hold card steadily
ERR_INVALID_REQUEST-21Our service is temporally not available to process your payment,please check the payment status in backend portal
ERR_NOT_ACTIVATED-22Device not activated
ERR_INVALID_REQUEST-23Invalid request
ERR_CAN_NOT_DETECT_MPOS-24Bluetooth can not detect MPOS D177 device, please check the MPOS D177 is available or not
ERR_BT_DISCONNECTED-25Bluetooth disconnected now, please check the MPOS D177 is available or not
ERR_BT_DISABLED-26Bluetooth disabled now, please kindly to enable it
ERR_BT_PERMISSION_MISSING-27The location permission is missing now, please kindly to allow it
ERR_UNEXPECTED-100Unexpected error, need to restart SoftPOS application by warmup