Data Model (MMS)

Request Type

OrderRequest

Name	In	Type	Presence	Description
`Authorization`	header	`String`	Required	Bearer Token
`createdStart`	query	`String(date)`	Optional	none
`createdEnd`	query	`String(date)`	Optional	none
`transactionId`	query	`String`	Optional	none
`acquirerRefNo`	query	`String`	Optional	none
`deviceId`	query	`String`	Optional	none
`pageSize`	query	`Number`	Optional	Default 10, query all use -1
`pageNumber`	query	`Number`	Optional	Default 1
`settleState`	query	`Number`	Optional	WAIT_FOR_SETTLE: 0
`state`	query	`Number`	Optional	INIT: 0, PROCESSING: 1, APPROVED: 2, DECLINED: 3, VOIDED: 4, REFUNDED: 5, CLOSED: 6, REVERSED: 7

MerchantRequest

Name	Schema	Presence	Description
`mchName`	`String`	Optional	Merchant name
`mchId`	`String`	Required	Merchant unique ID generated by MineSec system
`providerReference`	`String`	Optional	PBO unique ID for the merchant (must be unique per merchant)
`contactName`	`String`	Optional	Contact name of merchant
`contactEmail`	`String`	Optional	Contact email of merchant
`contactAddress`	`String`	Optional	Contact address of merchant (will be presented in e-receipt if set)
`contactPhone`	`String`	Optional	Contact phone of merchant
`mcc`	`String`	Optional	Merchant category code (refer to ISO18245)
`activated`	`Boolean`	Optional	`true` - merchant is activated and allowed to do payment `false` - merchant is inactivated
`timeZone`	`String`	Optional	Timezone of merchant (if not provided, defaults to PBO's timezone)
`receiptLogo`	`String`	Optional	Merchant logo URL or a base64-encoded jpg/jpeg/png image
`supportedPaymentMethods`	`Array`	Optional	List of supported payment methods
`extParams`	`Object`	Optional	Extra parameters (e.g., MID/TID, SubMID, subTID, secret Token)
`terminalEmvParams`	`Object`	Optional	EMV parameters (won't impact settings for issued activation codes)

DeviceRequest

Name	Schema	Presence	Description
`emvParams`	`Object`	Required	EMV parameters for the device
`emvParams.amexFloorLimit`	`String`	Required	Amex floor limit (e.g., "00000100")
`emvParams.terminalCountryCode`	`String`	Required	Terminal country code (e.g., "0840" for USA)
`emvParams.txnCurrencyCode`	`String`	Required	Transaction currency code (e.g., "0840" for USD)
`emvParams.amexExReaderCapability`	`String`	Required	Amex extended reader capability (e.g., "18E00003")
`emvParams.amexReaderCapability`	`String`	Required	Amex reader capability (e.g., "C3")
`emvParams.terminalType`	`String`	Required	Terminal type (e.g., "21")
`emvParams.terminalCapability`	`String`	Required	Terminal capability (e.g., "0068C8")
`emvParams.ifdSN`	`String`	Optional	IFD serial number (e.g., "00001234")
`emvParams.emvFlags`	`String`	Required	EMV flags (e.g., "VMAUJDP")
`activateCodeAlias`	`String`	Required	Activation code alias
`deviceType`	`String`	Required	Device type (e.g., "COTS")
`methodList`	`String`	Required	Comma-separated list of payment methods
`extParams`	`Object`	Required	Extra parameters (e.g., MID/TID values)
`mchId`	`String`	Required	Merchant ID

EmvRequest

Name	Schema	Presence	Description
`aid`	`String`	Required	List of Application Identifiers (AID)
`appVersion`	`String`	Required	Application version
`terminalTransactionQualifiers`	`String`	Optional	Terminal transaction qualifiers (not available for MC and Amex)
`clFloorLimit`	`Long`	Required	Contactless floor limit (can be 0 for online only)
`clTransLimit`	`Long`	Required	Contactless transaction limit (transaction declined if amount exceeds this limit)
`clCVMLimit`	`Long`	Required	Contactless CVM limit (if amount is ≥ this value, reader requires CVM)
`terminalRiskMgmtData`	`String`	Optional	Terminal Risk Management Data (available for MC only)
`defaultDDOL`	`String`	Optional	Dynamic Data Authentication Data Object List (default or "039F3704")
`defaultTDOL`	`String`	Optional	Default Transaction Certificate Data Object List (default or "0F9F02065F2A029A039C0195059F3704")
`kernelConfiguration`	`String`	Optional	Tag DF811B (available for MC only)
`isNewCVMRuleForMC`	`Boolean`	Optional	Enable new MC CVM rules (available for MC only, default is false)
`cvmCapabilityCVMRequired`	`String`	Optional	CVM Capability – CVM Required (Tag DF8118)
`cvmCapabilityNoCVM`	`String`	Optional	CVM Capability – No CVM Required (Tag DF8119)

AcqProfileRequest

Name	In	Type	Required	Description
`body`	body	`Object`	Optional	none
`profileName`	body	`String`	Required	none
`currency`	body	`String`	Required	none
`connMessageFormat`	body	`String`	Required	none
`connUrl`	body	`String`	Required	none
`notifyUrl`	body	`String?`	Optional	none
`connTimeout`	body	`Number?`	Optional	none
`connRequestTimeout`	body	`Number?`	Optional	none
`emvList`	body	`Object`	Required	none
`emvList.01`	body	`Array<Number>?`	Optional	none
`emvList.02`	body	`Array<Number>?`	Optional	none
`emvList.03`	body	`Array<Number>?`	Optional	none
`emvList.04`	body	`Array<Number>?`	Optional	none
`emvList.05`	body	`Array<Number>?`	Optional	none
`emvList.06`	body	`Array<Number>?`	Optional	none
`methodList`	body	`Object`	Required	none
`methodList.01`	body	`Array<String>?`	Optional	none
`methodList.02`	body	`Array<String>?`	Optional	none
`methodList.03`	body	`Array<String>?`	Optional	none
`methodList.04`	body	`Array<String>?`	Optional	none
`methodList.05`	body	`Array<String>?`	Optional	none
`methodList.06`	body	`Array<String>?`	Optional	none

Response Type

PboInfo

Name	Schema	Presence
`groupName`	`String`	Always
`messageFormat`	`String`	Always
`groupId`	`String`	Always
`supportUrl`	`String?`	Optional
`logo`	`String?`	Optional
`timeZone`	`String?`	Optional
`emailSender`	`String?`	Optional
`updatedAt`	`String`	Always

AcquirerProfile

Name	Schema	Presence
`profileName`	`String`	Always
`connRequestTimeout`	`Int`	Always
`connExtraParams`	`String`	Always
`groupId`	`String`	Always
`connMessageFormat`	`String`	Always
`connTimeout`	`Int`	Always
`connRetryCount`	`Int`	Always
`emvList`	`String`	Always
`connSync`	`Int`	Always
`profileId`	`Int`	Always
`connUrl`	`String`	Always
`notifyUrl`	`String`	Always
`currency`	`String`	Always
`methodList`	`String`	Always
`createdBy`	`String`	Always
`createdAt`	`String`	Always
`updatedAt`	`String`	Optional

EmvInfo

Name	Schema	Presence	Description
`params`	`Object`	Required	EMV parameters
`params.aid`	`String`	Optional	Application Identifier
`params.appVersion`	`String`	Optional	Application version
`params.clCVMLimit`	`Number`	Optional	Contactless CVM limit
`params.clFloorLimit`	`Number`	Optional	Contactless floor limit
`params.clTransLimit`	`Number`	Optional	Contactless transaction limit
`params.defaultDDOL`	`String`	Optional	Default DDOL
`params.defaultTDOL`	`String`	Optional	Default TDOL
`params.isNewCVMRuleForMC`	`Boolean`	Optional	Enable new MC CVM rules
`params.terminalRiskMgmtData`	`String`	Optional	Terminal Risk Management Data
`params.terminalTransactionQualifiers`	`String`	Optional	Terminal transaction qualifiers
`emvName`	`String`	Required	EMV configuration name
`paymentMethod`	`String`	Required	Payment method

Merchant

Name	Schema	Presence	Description
`mchName`	`String`	Optional	Merchant name
`mchId`	`String`	Required	Merchant unique ID generated by MineSec system
`providerReference`	`String`	Optional	PBO unique ID for the merchant (must be unique per merchant)
`contactName`	`String`	Optional	Contact name of merchant
`contactEmail`	`String`	Optional	Contact email of merchant
`contactAddress`	`String`	Optional	Contact address of merchant (will be presented in e-receipt if set)
`contactPhone`	`String`	Optional	Contact phone of merchant
`mcc`	`String`	Optional	Merchant category code (refer to ISO18245)
`activated`	`Boolean`	Optional	`true` - merchant is activated and allowed to do payment `false` - merchant is inactivated
`timeZone`	`String`	Optional	Timezone of merchant (if not provided, defaults to PBO's timezone)
`receiptLogo`	`String`	Optional	Merchant logo URL or a base64-encoded jpg/jpeg/png image
`supportedPaymentMethods`	`Array<PaymentMethodBinding>`	Optional	List of supported payment methods
`extParams`	`Object`	Optional	Extra parameters (e.g., MID/TID, SubMID, subTID, secret Token)
`terminalEmvParams`	`Object`	Optional	EMV parameters (won't impact settings for issued activation codes)

PaymentMethodBinding

Name	Schema	Presence	Description
`paymentMethod`	`String`	Always	Payment method
`mchId`	`String`	Always	Merchant unique ID (generated by MineSec)
`profileId`	`Int`	Always	Acquirer profile ID (generated by MineSec)

Device

Name	Schema	Presence	Description
`deviceType`	`String`	Optional	Device type
`deviceAdmin`	`String`	Optional	Device admin
`activateCodeAlias`	`String`	Optional	Activation code alias
`emvParams`	`String`	Optional	EMV parameters
`methodList`	`String`	Optional	List of payment methods
`extParams`	`String`	Optional	Extra parameters
`deviceId`	`String`	Required	Device identifier (in path)

OrderList

Name	Schema	Presence	Description
`tranId`	`String`	Optional	Transaction ID
`amount`	`Object`	Optional	Transaction amount information
`amount.currency`	`String`	Optional	Currency code
`amount.value`	`Int`	Optional	Amount value (in smallest unit)
`approvalCode`	`String`	Optional	Approval code
`batchNo`	`String`	Optional	Batch number
`cvmPerformed`	`String`	Optional	CVM method used: `NO_CVM`, `SIGNATURE`, `PIN`, `CDCVM`
`appName`	`String`	Optional	Application name
`linkedTranId`	`String`	Optional	Linked transaction ID (for refunds/voids)
`mchName`	`String`	Optional	Merchant name
`tsi`	`String`	Optional	Transaction Status Indicator
`acqTid`	`String`	Optional	Acquirer Terminal ID
`rrn`	`String`	Optional	Retrieval Reference Number
`tc`	`String`	Optional	Transaction Certificate
`tranStatus`	`String`	Optional	Transaction status: `PROCESSING`, `APPROVED`, `DECLINED`, `VOIDED`, `REVERSED`, `AUTH_ONLY`, `ADJUSTED`
`tranType`	`String`	Optional	Transaction type: `SALE`, `REFUND`, `AUTH`
`atc`	`String`	Optional	Application Transaction Counter
`tvr`	`String`	Optional	Terminal Verification Results
`trace`	`String`	Optional	Trace number
`acqMid`	`String`	Optional	Acquirer Merchant ID
`accountMasked`	`String`	Optional	Masked card number
`sdkId`	`String`	Optional	SDK identifier
`paymentMethod`	`String`	Optional	Payment method used (see Enums section for values)
`hostMessageFormat`	`String`	Optional	Host message format
`aid`	`String`	Optional	Application Identifier
`entryMode`	`String`	Optional	Entry mode

OrderDetail

Name	Schema	Presence	Description
`tranId`	`String`	Optional	Transaction ID
`approvalCode`	`String`	Optional	Approval code
`cvmPerformed`	`String`	Optional	CVM method used: `NO_CVM`, `SIGNATURE`, `PIN`, `CDCVM`
`tsi`	`String`	Optional	Transaction Status Indicator
`tranStatus`	`String`	Optional	Transaction status: `PROCESSING`, `APPROVED`, `DECLINED`, `VOIDED`, `REVERSED`, `AUTH_ONLY`, `ADJUSTED`
`tranType`	`String`	Optional	Transaction type: `SALE`, `REFUND`, `AUTH`
`atc`	`String`	Optional	Application Transaction Counter
`trace`	`String`	Optional	Trace number
`acqMid`	`String`	Optional	Acquirer Merchant ID
`callbackUrl`	`String`	Optional	Callback URL
`entryMode`	`String`	Optional	Entry mode
`amount`	`Object`	Optional	Transaction amount information
`amount.currency`	`String`	Optional	Currency code
`amount.value`	`Integer`	Optional	Amount value (in smallest unit)
`batchNo`	`String`	Optional	Batch number
`appName`	`String`	Optional	Application name
`linkedTranId`	`String`	Optional	Linked transaction ID (for refunds/voids)
`mchName`	`String`	Optional	Merchant name
`acqTid`	`String`	Optional	Acquirer Terminal ID
`rrn`	`String`	Optional	Retrieval Reference Number
`tc`	`String`	Optional	Transaction Certificate
`tvr`	`String`	Optional	Terminal Verification Results
`accountMasked`	`String`	Optional	Masked card number
`sdkId`	`String`	Optional	SDK identifier
`paymentMethod`	`String`	Optional	Payment method (see Enums section for values)
`hostMessageFormat`	`String`	Optional	Host message format
`actions`	`Array<Object>`	Optional	Transaction actions
`actions[].tranId`	`String`	Optional	Transaction ID
`actions[].actionType`	`String`	Optional	Action type
`actions[].reason`	`String`	Optional	Action reason
`actions[].amount`	`Object`	Optional	Action amount
`actions[].amount.currency`	`String`	Optional	Currency code
`actions[].amount.value`	`Integer`	Optional	Amount value
`actions[].trace`	`String`	Optional	Trace number
`actions[].actionStatus`	`String`	Optional	Action status
`actions[].hostRespCode`	`String`	Optional	Host response code
`actions[].actionId`	`String`	Optional	Action ID
`aid`	`String`	Optional	Application Identifier

SettleDetail

Name	Schema	Presence	Description
`paymentAmt`	`Int`	Optional	Total payment amount
`profileName`	`String`	Optional	Acquirer profile name
`profileMessage`	`String`	Optional	Profile message
`refundCount`	`Int`	Optional	Number of refund transactions
`uuid`	`String`	Optional	Unique settlement identifier
`acquirerMid`	`String`	Optional	Acquirer Merchant ID
`mchName`	`String`	Optional	Merchant name
`voidAmt`	`Int`	Optional	Total void amount
`batchId`	`String`	Optional	Batch identifier
`transactions`	`Array<Object>`	Optional	List of transactions in the settlement
`transactions[].amount`	`Int`	Optional	Transaction amount
`transactions[].transType`	`String`	Optional	Transaction type
`transactions[].count`	`Int`	Optional	Count of transactions
`transactions[].paymentMethod`	`String`	Optional	Payment method used
`createdAt`	`String`	Optional	Settlement creation timestamp
`successTime`	`String`	Optional	Settlement success timestamp
`currency`	`String`	Optional	Currency code
`acquirerTid`	`String`	Optional	Acquirer Terminal ID
`state`	`Int`	Optional	Settlement state: `0` - WAIT_FOR_SETTLE, `1` - SETTLED, `2` - SETTLE_FAILED
`acquirerRefNo`	`String`	Optional	Acquirer reference number
`acquirerCode`	`String`	Optional	Acquirer code
`paymentCount`	`Int`	Optional	Number of payment transactions
`refundAmt`	`Int`	Optional	Total refund amount
`voidCount`	`Int`	Optional	Number of void transactions

Common

Response<`T`>

Name	Schema	Presence	Description
`msg`	`String`	Always
`code`	`Int`	Always
`data`	`T?`	Optional	Only exist if success

Response List<`T`>

Name	Schema	Presence	Description
`msg`	`String`	Always
`code`	`Int`	Always
`data`	`T?`	Optional	Only exist if success
`total`	`Number`	Always	Total records count
`current`	`Number`	Always	Current page number
`records`	`Array<T>`	Always	Page records
`hasNext`	`Boolean`	Always	Has next page flag

Enums

PaymentMethod

Property	Value	Code
paymentMethod	VISA	01
paymentMethod	MASTERCARD	02
paymentMethod	UNIONPAY	03
paymentMethod	AMEX	04
paymentMethod	JCB	06
paymentMethod	DISCOVER	05
paymentMethod	DINERS	07
paymentMethod	ELO	08
paymentMethod	ALIPAY	A2
paymentMethod	WECHAT	A1
paymentMethod	VISA_QR	B1
paymentMethod	MASTERCARD_QR	B2
paymentMethod	UNIONPAY_QR	B3
paymentMethod	SHOPEE_PAY_QR	C1
paymentMethod	GRAB_PAY_QR	C8
paymentMethod	PAY_NOW	C2
paymentMethod	LINEPAY	C3
paymentMethod	PI	C4
paymentMethod	ESUNWALLET	C5
paymentMethod	TAIWANPAY	C6
paymentMethod	EASYWALLET	C7
paymentMethod	GAMA_PAY	C9
paymentMethod	ICASH_PAY	C10
paymentMethod	IPASSMONEY_PAY	C11
paymentMethod	JIEKOU_PAY	C12
paymentMethod	OUFUBAO	C13
paymentMethod	QUAN_PAY	C14
paymentMethod	QUAN_YIN_PAY	C15
paymentMethod	XIAOYOU_PAY	C16
paymentMethod	EZ_PAY	A3

Settlement Error Code

Data Model (MMS)

Request Type

OrderRequest

MerchantRequest

DeviceRequest

EmvRequest

AcqProfileRequest

Response Type

PboInfo

AcquirerProfile

EmvInfo

Merchant

PaymentMethodBinding

Device

OrderList

OrderDetail

SettleDetail

Common

Response<T>

Response List<T>

Enums

PaymentMethod

Response<`T`>

Response List<`T`>