Data Model
Field-level reference for every Host API message.
- Requests (MineSec → you): fields marked Yes are always sent. Other fields may be left out; null fields are never sent.
- Responses (you → MineSec): fields marked Yes must be returned.
- Accept and ignore fields you do not recognize. New optional fields may be added over time.
Card
Card transaction request
| Field | Type | Required | Description |
|---|---|---|---|
acptId | string | Yes | MineSec routing entry (acceptance) used for this request. |
actionType | ActionType | Yes | Action on the transaction. See ActionType. |
amountValue | string | Yes | Amount as a decimal string with the currency's ISO decimal places. |
batchId | string | Yes | MineSec batch ID. |
batchNo | string | Yes | Batch number. |
cardData | map<string,string> | EMV tags: map of tag (hex) to value (hex). | |
consumerDevice | ConsumerPaymentDevice | Form factor the card was presented on. | |
currency | string | Yes | ISO 4217 alpha-3 currency code. |
cvmPerformed | CvmPerformed | Yes | Cardholder verification performed. |
enbrTranId | string | Yes | MineSec transaction ID. Idempotency key for QR. |
entryMode | EntryMode | Yes | How the card was read. |
installment | Installment | Present only on tranType: SALE when the cardholder selected an installment plan; omitted otherwise. The older tranType: INSTALL never carries it. Carried unchanged on the reversal, void and batch upload of the sale, so externalPlanCode always matches the original sale even if the plan configuration later changes. | |
isReversal | boolean | true when this request reverses the original. | |
linkedEnbrTranId | string | enbrTranId of the original transaction. | |
mcc | string | Yes | Merchant category code. |
merchantAddress | string | Yes | Merchant address. |
merchantDevice | MerchantDevice | Yes | Acceptance device type. |
merchantName | string | Yes | Merchant name. |
orgApprovalCode | string | approvalCode of the original transaction. | |
orgAuthDate | string | When the original preauth (AUTH) was requested, the same value as that request's timestamp. Sent when the original transaction is a preauth. | |
orgRrn | string | rrn of the original transaction. | |
orgSaleDate | string | When the original sale (SALE, INSTALL or AUTH_COMP) was requested, the same value as that request's timestamp. Sent when the original transaction is a sale. | |
orgTrace | string | trace of the original transaction. | |
paymentMethod | PaymentMethod | Yes | Card scheme or wallet. |
pinBlock | PinBlock | Encrypted PIN block. Present when the cardholder entered a PIN. | |
posExtra | map<string,string> | Key-value data passed through from the POS, plus your own keys from the acceptance's extraParams. | |
posReference | string | Reference set by the POS application. | |
primaryMid | string | Yes | primaryMid of the acceptance. |
primaryTid | string | Yes | primaryTid of the acceptance. |
profileId | string | Yes | MineSec merchant profile ID. |
sdkId | string | ID of the SoftPOS App or Embedded Payment SDK installation that took the payment. | |
subMid | string | Sub-merchant ID, when configured. | |
subTid | string | Sub-terminal ID, when configured. | |
timestamp | string | Yes | Request time, ISO 8601 UTC. |
trace | string | Yes | Per-message sequence number (system trace audit number). |
track2Data | Track2Data | Encrypted Track2. Present when a Track2 key is set up for your host. | |
tranType | TranType | Yes | Transaction type. See TranType. |
Card transaction response
| Field | Type | Required | Description |
|---|---|---|---|
approvalCode | string | Authorization code from the issuer or host. | |
hostReferenceId | string | Your own reference for this message. | |
respCode | string | Yes | Result code. 00 = success. |
respMessage | string | Human-readable result. | |
rrn | string | Your host's retrieval reference number. | |
extra | map<string,string> | Host-specific key-value data. |
PinBlock
Encrypted PIN block. EMV tag 99 is never sent in cardData.
| Field | Type | Required | Description |
|---|---|---|---|
pinKsn | string | DUKPT KSN for the PIN block key (TDES: 20 hex, AES: 24 hex). Omitted when the PIN key is a static key. | |
data | string | Yes | Hex encrypted PIN block (ISO format-0 for TDES, format-4 for AES). |
Track2Data
Encrypted Track2 data. EMV tag 57 is never sent in cardData; read the PAN from here after decryption.
| Field | Type | Required | Description |
|---|---|---|---|
track2Ksn | string | Yes | DUKPT KSN for the Track2 data key. |
data | string | Yes | Hex encrypted Track2 data (DUKPT data-encryption). |
track2Length | integer | Yes | Number of hex characters of Track2 before encryption. The plaintext is zero-padded up to the cipher block size (8 bytes TDES, 16 bytes AES) before encryption, so after decrypting take the first track2Length hex characters and discard the rest. Counts hex characters, not bytes: 38 means 19 bytes of Track2. |
Installment
Resolved installment instruction. MineSec validates the selection against the merchant's configured plans before sending; the host must not calculate interest or amortization from it.
| Field | Type | Required | Description |
|---|---|---|---|
installmentCount | integer | Yes | Number of installments. For REVOLVING it applies to revolving.remainingAmount, excluding the initial payment. |
interestModel | InterestModel | Yes | Whether the plan charges interest. |
installmentType | InstallmentType | Yes | Regular or revolving. |
externalPlanCode | string | Acquirer-defined plan code, when the integration requires one. | |
revolving | Revolving | Present only when installmentType is REVOLVING. | |
issuerPreapprovalReference | string | Issuer preapproval reference, when required and available. |
Revolving
Split of the transaction amount for a REVOLVING installment: 0 < initialPaymentAmount < amountValue, and remainingAmount = amountValue - initialPaymentAmount.
| Field | Type | Required | Description |
|---|---|---|---|
initialPaymentAmount | Amount | Yes | Amount paid upfront. Same currency as the transaction; value uses the currency's ISO decimal fraction, as amountValue. |
remainingAmount | Amount | Yes | Amount spread over installmentCount. Same currency as the transaction; value uses the currency's ISO decimal fraction, as amountValue. |
Sign-on request
| Field | Type | Required | Description |
|---|---|---|---|
acptId | string | Yes | MineSec routing entry (acceptance) used for this request. |
primaryMid | string | Yes | primaryMid of the acceptance. |
primaryTid | string | Yes | primaryTid of the acceptance. |
profileId | string | Yes | MineSec merchant profile ID. |
subMid | string | Sub-merchant ID, when configured. | |
subTid | string | Sub-terminal ID, when configured. | |
timestamp | string | Yes | Request time, ISO 8601 UTC. |
trace | string | Yes | Per-message sequence number (system trace audit number). |
Sign-on response
| Field | Type | Required | Description |
|---|---|---|---|
hostReferenceId | string | Your own reference for this message. | |
respCode | string | Yes | Result code. 00 = success. |
respMessage | string | Human-readable result. | |
extra | map<string,string> | Host-specific key-value data. |
Sign-off request
| Field | Type | Required | Description |
|---|---|---|---|
acptId | string | Yes | MineSec routing entry (acceptance) used for this request. |
primaryMid | string | Yes | primaryMid of the acceptance. |
primaryTid | string | Yes | primaryTid of the acceptance. |
profileId | string | Yes | MineSec merchant profile ID. |
subMid | string | Sub-merchant ID, when configured. | |
subTid | string | Sub-terminal ID, when configured. | |
timestamp | string | Yes | Request time, ISO 8601 UTC. |
trace | string | Yes | Per-message sequence number (system trace audit number). |
Sign-off response
| Field | Type | Required | Description |
|---|---|---|---|
respCode | string | Yes | Result code. 00 = success. |
respMessage | string | Human-readable result. | |
extra | map<string,string> | Host-specific key-value data. |
Settlement request
| Field | Type | Required | Description |
|---|---|---|---|
acptId | string | Yes | MineSec routing entry (acceptance) used for this request. |
batchId | string | Yes | MineSec batch ID. |
batchNo | string | Yes | Batch number. |
isSecond | boolean | true for the settlement sent again after batch upload. | |
primaryMid | string | Yes | primaryMid of the acceptance. |
primaryTid | string | Yes | primaryTid of the acceptance. |
profileId | string | Yes | MineSec merchant profile ID. |
summary | array<Settlement summary> | Yes | Totals grouped by type, status and payment method. |
timestamp | string | Yes | Request time, ISO 8601 UTC. |
trace | string | Yes | Per-message sequence number (system trace audit number). |
Settlement summary
| Field | Type | Required | Description |
|---|---|---|---|
count | number | Yes | Number of transactions. |
paymentMethod | PaymentMethod | Card scheme or wallet. | |
total | Amount | Yes | Total amount. |
tranStatus | TranStatus | Yes | Transaction status. |
tranType | TranType | Yes | Transaction type. See TranType. |
Settlement response
| Field | Type | Required | Description |
|---|---|---|---|
hostReferenceId | string | Your own reference for this message. | |
respCode | string | Yes | Result code. 00 = success. |
respMessage | string | Human-readable result. | |
extra | map<string,string> | Host-specific key-value data. |
QR
QR payment request
Creates an MPQR order or charges a scanned CPQR code. consumerCode is required for CPQR.
| Field | Type | Required | Description |
|---|---|---|---|
enbrTranId | string | Yes | Idempotency key of the payment. |
srsTranId | string | MineSec order number of the transaction, generated by MineSec (for example M1866239185331064832). Use it with enbrTranId to look a transaction up with MineSec. | |
trace | string | Yes | Per-message sequence number. |
posReference | string | Reference set by the POS application. | |
extOrderId | string | The merchant's own order number. | |
pboId | string | Yes | Your account (PBO) ID at MineSec. |
isvId | string | isvId of the profile: the partner (ISV) that runs the merchant, when set. | |
profileId | string | Yes | MineSec merchant profile. |
providerMchId | string | providerMchId of the profile: the merchant ID in your own system, when set. | |
providerReference | string | providerReference of the profile: your own reference for the merchant. | |
shopId | string | shopId of the profile, when set. | |
shopName | string | shopName of the profile, when set. | |
acptId | string | Yes | The acceptance (routing entry) used. |
primaryMid | string | Yes | primaryMid of the acceptance. |
primaryTid | string | Yes | primaryTid of the acceptance. |
subMid | string | Wallet sub-merchant id. | |
subTid | string | Sub-terminal ID, when configured. | |
sdkId | string | ID of the SoftPOS App or Embedded Payment SDK installation that took the payment. | |
merchantDevice | MerchantDevice | Yes | Acceptance device type. |
qrMode | QrMode | Yes | Merchant-presented or consumer-presented. |
tranType | string | Yes | Only SALE is supported. |
amountValue | string | Yes | Same formatting as /transactions. |
currency | string | Yes | ISO 4217 alpha-3 currency code. |
paymentMethod | QrPaymentMethod | Yes | Card scheme or wallet. |
consumerCode | ConsumerCode | The scanned customer code. Required for CPQR. | |
qrExpirySeconds | integer | MPQR: requested validity. The host may shorten it with expiresAt; MineSec closes the order at whichever comes first. | |
notifyUrl | string | Where to send the notify for this transaction. Call it unchanged, never build it. Omitted when no notify is set up for the host. | |
merchantName | string | Yes | Merchant name. |
merchantAddress | string | Yes | Merchant address. |
merchantCity | string | Yes | merchantCity of the profile. EMVCo MPM tag 60. Sent as an empty string when the profile has none. |
merchantCountry | string | Yes | ISO 3166-1 alpha-2. EMVCo MPM tag 58. |
merchantPostalCode | string | merchantPostalCode of the profile, when set. | |
mcc | string | Yes | Merchant category code. |
batchId | string | For reference only. QR is normally host-captured. | |
batchNo | string | For reference only. | |
posExtra | map<string,string> | Your own keys from the acceptance's extraParams. | |
timestamp | string | Yes | Request time, ISO 8601 UTC. |
QR inquiry request
| Field | Type | Required | Description |
|---|---|---|---|
enbrTranId | string | Yes | The payment or the refund being queried. |
srsTranId | string | MineSec order number of the transaction, generated by MineSec (for example M1866239185331064832). Use it with enbrTranId to look a transaction up with MineSec. | |
trace | string | Yes | Per-message sequence number. |
posReference | string | Reference set by the POS application. | |
extOrderId | string | The merchant's own order number. | |
pboId | string | Yes | Your account (PBO) ID at MineSec. |
isvId | string | isvId of the profile: the partner (ISV) that runs the merchant, when set. | |
profileId | string | Yes | MineSec merchant profile. |
providerMchId | string | providerMchId of the profile: the merchant ID in your own system, when set. | |
providerReference | string | providerReference of the profile: your own reference for the merchant. | |
shopId | string | shopId of the profile, when set. | |
shopName | string | shopName of the profile, when set. | |
acptId | string | Yes | The acceptance (routing entry) used. |
primaryMid | string | Yes | primaryMid of the acceptance. |
primaryTid | string | Yes | primaryTid of the acceptance. |
subMid | string | Wallet sub-merchant id. | |
subTid | string | Sub-terminal ID, when configured. | |
sdkId | string | ID of the SoftPOS App or Embedded Payment SDK installation that took the payment. | |
inquiryType | QrInquiryType | Yes | Whether a payment or a refund is queried. |
rrn | string | rrn from the host's create response. Sent when known. | |
batchId | string | For reference only. QR is normally host-captured. | |
batchNo | string | For reference only. | |
timestamp | string | Yes | Request time, ISO 8601 UTC. |
QR cancellation request
| Field | Type | Required | Description |
|---|---|---|---|
enbrTranId | string | Yes | The payment being cancelled. |
enbrActionId | string | Yes | Tells two cancellation attempts on one payment apart. |
srsTranId | string | MineSec order number of the transaction, generated by MineSec (for example M1866239185331064832). Use it with enbrTranId to look a transaction up with MineSec. | |
trace | string | Yes | Per-message sequence number. |
posReference | string | Reference set by the POS application. | |
extOrderId | string | The merchant's own order number. | |
pboId | string | Yes | Your account (PBO) ID at MineSec. |
isvId | string | isvId of the profile: the partner (ISV) that runs the merchant, when set. | |
profileId | string | Yes | MineSec merchant profile. |
providerMchId | string | providerMchId of the profile: the merchant ID in your own system, when set. | |
providerReference | string | providerReference of the profile: your own reference for the merchant. | |
shopId | string | shopId of the profile, when set. | |
shopName | string | shopName of the profile, when set. | |
acptId | string | Yes | The acceptance (routing entry) used. |
primaryMid | string | Yes | primaryMid of the acceptance. |
primaryTid | string | Yes | primaryTid of the acceptance. |
subMid | string | Wallet sub-merchant id. | |
subTid | string | Sub-terminal ID, when configured. | |
sdkId | string | ID of the SoftPOS App or Embedded Payment SDK installation that took the payment. | |
reason | QrCancelReason | Yes | Why the payment is cancelled. |
rrn | string | rrn from the host's create response. Sent when known. | |
batchId | string | For reference only. QR is normally host-captured. | |
batchNo | string | For reference only. | |
timestamp | string | Yes | Request time, ISO 8601 UTC. |
QR refund request
| Field | Type | Required | Description |
|---|---|---|---|
enbrTranId | string | Yes | Idempotency key of the refund itself, not the original payment. |
srsTranId | string | MineSec order number of the transaction, generated by MineSec (for example M1866239185331064832). Use it with enbrTranId to look a transaction up with MineSec. | |
trace | string | Yes | Per-message sequence number. |
posReference | string | Reference set by the POS application. | |
extOrderId | string | The merchant's own order number. | |
pboId | string | Yes | Your account (PBO) ID at MineSec. |
isvId | string | isvId of the profile: the partner (ISV) that runs the merchant, when set. | |
profileId | string | Yes | MineSec merchant profile. |
providerMchId | string | providerMchId of the profile: the merchant ID in your own system, when set. | |
providerReference | string | providerReference of the profile: your own reference for the merchant. | |
shopId | string | shopId of the profile, when set. | |
shopName | string | shopName of the profile, when set. | |
acptId | string | Yes | The acceptance (routing entry) used. |
primaryMid | string | Yes | primaryMid of the acceptance. |
primaryTid | string | Yes | primaryTid of the acceptance. |
subMid | string | Wallet sub-merchant id. | |
subTid | string | Sub-terminal ID, when configured. | |
sdkId | string | ID of the SoftPOS App or Embedded Payment SDK installation that took the payment. | |
amountValue | string | Yes | Amount to refund. Same formatting as /transactions. |
currency | string | Yes | ISO 4217 alpha-3 currency code. |
notifyUrl | string | Where to send the notify for this transaction. Call it unchanged, never build it. Omitted when no notify is set up for the host. | |
linkedEnbrTranId | string | Yes | The original payment. |
orgRrn | string | Yes | rrn of the original payment. |
batchId | string | For reference only. QR is normally host-captured. | |
batchNo | string | For reference only. | |
timestamp | string | Yes | Request time, ISO 8601 UTC. |
QR result
Result of a QR payment or refund. Returned by every /qr-payments endpoint and sent as the notify body.
| Field | Type | Required | Description |
|---|---|---|---|
respCode | string | Yes | The host's own result code, kept for diagnostics. Must be 00 when status is PENDING or SUCCESS. |
respMessage | string | Human-readable result. Required when status is FAILED. | |
status | QrStatus | Yes | Outcome of the payment or refund. |
failureCode | QrFailureCode | Required when status is FAILED. | |
enbrTranId | string | Yes | Echo of the request. |
rrn | string | The host's own reference for this payment or refund, issued at create time. MineSec stores it, sends it back on every follow-up call and searches by it. Required when status is PENDING, SUCCESS or REVERSED, and the same value in every response for one payment. It may be absent only when the host holds no order: a payment rejected before an order was created, or a cancellation for a create the host never received. Put the wallet's own transaction id, if different, in extra.walletTransactionId. | |
approvalCode | string | Card scheme QR only. | |
networkMerchantId | string | The merchant id on the wallet or scheme side. | |
primaryMid | string | Echo of the request. Expected on a notify. | |
primaryTid | string | Echo of the request. Expected on a notify. | |
paymentMethod | string | Required when status is SUCCESS, and then concrete, never UNIFIED_QR. A QrPaymentMethod value. A wallet missing from that list is still accepted; ask MineSec to add it. | |
amountValue | string | Yes | Echo of the request. Checked by MineSec. |
currency | string | Yes | Echo of the request. Checked by MineSec. |
qrCode | QrCode | MPQR: the QR to display while status is PENDING. | |
expiresAt | string | MPQR: when the QR stops being payable. ISO 8601 UTC. | |
paidAt | string | When the payment succeeded. ISO 8601 UTC. | |
payer | Payer | Payer details, when available. | |
payerAmount | string | Cross-border wallets: what the payer was charged. | |
exchangeRate | string | Cross-border wallets: rate applied. | |
discountAmount | string | Discount applied by the wallet, if any. | |
settlementDate | string | Your settlement date for this payment. | |
settlementReference | string | Your settlement reference. | |
linkedEnbrTranId | string | Refunds: the original payment. | |
orgRrn | string | Refunds: rrn of the original payment. | |
refundedAt | string | Refunds: when the refund succeeded. ISO 8601 UTC. | |
refundedAmount | string | Refund inquiries: the amount refunded. | |
extra | map<string,string> | Host-specific values, stored with the transaction. walletTransactionId: the wallet or scheme transaction id (the number on the payer's receipt), when it differs from rrn. |
QR notify
The fields of the QR result plus the event. Sent once per final status, never for PENDING.
| Field | Type | Required | Description |
|---|---|---|---|
eventId | string | Yes | Unique per event. Repeated on a retry of the same event. |
eventType | QrEventType | Yes | Payment or refund. |
eventTime | string | Yes | ISO 8601 UTC. |
respCode | string | Yes | The host's own result code, kept for diagnostics. Must be 00 when status is PENDING or SUCCESS. |
respMessage | string | Human-readable result. Required when status is FAILED. | |
status | QrStatus | Yes | Outcome of the payment or refund. |
failureCode | QrFailureCode | Required when status is FAILED. | |
enbrTranId | string | Yes | Echo of the request. |
rrn | string | The host's own reference for this payment or refund, issued at create time. MineSec stores it, sends it back on every follow-up call and searches by it. Required when status is PENDING, SUCCESS or REVERSED, and the same value in every response for one payment. It may be absent only when the host holds no order: a payment rejected before an order was created, or a cancellation for a create the host never received. Put the wallet's own transaction id, if different, in extra.walletTransactionId. | |
approvalCode | string | Card scheme QR only. | |
networkMerchantId | string | The merchant id on the wallet or scheme side. | |
primaryMid | string | Echo of the request. Expected on a notify. | |
primaryTid | string | Echo of the request. Expected on a notify. | |
paymentMethod | string | Required when status is SUCCESS, and then concrete, never UNIFIED_QR. A QrPaymentMethod value. A wallet missing from that list is still accepted; ask MineSec to add it. | |
amountValue | string | Yes | Echo of the request. Checked by MineSec. |
currency | string | Yes | Echo of the request. Checked by MineSec. |
qrCode | QrCode | MPQR: the QR to display while status is PENDING. | |
expiresAt | string | MPQR: when the QR stops being payable. ISO 8601 UTC. | |
paidAt | string | When the payment succeeded. ISO 8601 UTC. | |
payer | Payer | Payer details, when available. | |
payerAmount | string | Cross-border wallets: what the payer was charged. | |
exchangeRate | string | Cross-border wallets: rate applied. | |
discountAmount | string | Discount applied by the wallet, if any. | |
settlementDate | string | Your settlement date for this payment. | |
settlementReference | string | Your settlement reference. | |
linkedEnbrTranId | string | Refunds: the original payment. | |
orgRrn | string | Refunds: rrn of the original payment. | |
refundedAt | string | Refunds: when the refund succeeded. ISO 8601 UTC. | |
refundedAmount | string | Refund inquiries: the amount refunded. | |
extra | map<string,string> | Host-specific values, stored with the transaction. walletTransactionId: the wallet or scheme transaction id (the number on the payer's receipt), when it differs from rrn. |
QR notify acknowledgement
| Field | Type | Required | Description |
|---|---|---|---|
respCode | string | Yes | Result code. 00 = success. |
respMessage | string | Human-readable result. |
ConsumerCode
The customer's code scanned by the merchant.
| Field | Type | Required | Description |
|---|---|---|---|
value | string | Yes | The scanned content. A one-time payment token. |
format | QrConsumerCodeFormat | Yes | Encoding of the code. |
scanMethod | QrScanMethod | How the code was captured. |
QrCode
The QR to display.
| Field | Type | Required | Description |
|---|---|---|---|
content | string | Yes | The payload to render as a QR. |
format | QrCodeFormat | Yes | Encoding of the code. |
reference | string | Reference carried inside the QR, e.g. the EMVCo reference label seen on the payer's statement. |
Payer
| Field | Type | Required | Description |
|---|---|---|---|
id | string | The wallet's opaque user id. | |
institution | string | The payer's bank or wallet, for national schemes. | |
maskedAccount | string | Masked payer account. | |
fundingSource | string | e.g. BALANCE, CARD. |
Common
Amount
| Field | Type | Required | Description |
|---|---|---|---|
currency | string | Yes | ISO 4217 alpha-3 currency code. |
value | string | Yes | Amount as a decimal string. |
Enums
TranType
SALE, REFUND, AUTH, AUTH_COMP, DEFERRED_AUTH, INSTALL
The Host API sends SALE, REFUND, AUTH, AUTH_COMP and INSTALL.
ActionType
NEW, ADJUST, VOID, AUTH_COMP, LINK_REFUND, CONFIRM, MERCHANT_PRESENT_QR, CONSUMER_PRESENT_QR, NOTIFIED, INQUIRY, CLOSE, INCREMENTAL_AUTH
On /transactions the Host API sends NEW, VOID, AUTH_COMP and LINK_REFUND. See Transaction types.
TranStatus
PROCESSING, APPROVED, DECLINED, VOIDED, REVERSED, AUTH_ONLY, ADJUSTED
PaymentMethod
VISA, MASTERCARD, UNIONPAY, AMEX, JCB, DISCOVER, DINERS, MAESTRO, HIMYAN, NAPS, MY_DEBIT, ELO, CPACE, NAPAS, TROY, TAKAPAY, SADEEQ, UNKNOWN
EntryMode
NFC, SWIPE, CHIP, FALLBACK, MANUAL_KEYED, MERCHANT_PRESENT, CONSUMER_PRESENT, RETRIEVE, UNKNOWN
CvmPerformed
NO_CVM, SIGNATURE, PIN, OFFLINE_PIN, CDCVM
MerchantDevice
SOFTPOS, TERMINAL, MPOS, OTHER
ConsumerPaymentDevice
Card, MobilePhone, Tablet, MiniCard, Watch, MobileTag, KeyFob, Case, Other
InstallmentType
REGULAR, REVOLVING
InterestModel
WITH_INTEREST, NO_INTEREST
QrMode
MPQR: merchant presented, the host returns a QR to display. CPQR: consumer presented, the merchant scans the customer's code and the host charges it.
MPQR, CPQR
QrStatus
The only field MineSec uses for the outcome. CLOSED: cancelled or expired before any money moved. REVERSED: charged, then returned by a cancellation.
PENDING, SUCCESS, FAILED, CLOSED, REVERSED
QrPaymentMethod
Payment methods accepted on the QR endpoints. UNIFIED_QR is the aggregated code: the host identifies the wallet and returns the concrete method on SUCCESS.
ALIPAY, WECHAT, VISA_QR, MASTERCARD_QR, UNIONPAY_QR, SHOPEE_PAY_QR, GRAB_PAY_QR, ALIPAY_PLUS_QR, DUIT_NOW_QR, PAY_NOW, PH_QR, JCB_EMV_QR, LINEPAY_QR, EZ_PAY, PI_QR, ESUNWALLET_QR, TAIWANPAY_QR, EASYWALLET_QR, JKOPAY_QR, IPASSMONEY_PAY_QR, ICASH_PAY_QR, PLUSPAY_QR, PXPAYPLUS_QR, GAMA_PAY_QR, OPAY_QR, LINEPAYMONEY_QR, PAYPAY_QR, BCCARD_QR, NETS_QR, NTTDATA_QR, UCARD, CUP, SMARTPAY, BONUSPAY_QR, CASHLEZ_QR, UNIFIED_QR
QrConsumerCodeFormat
How the scanned consumer code is encoded.
BARCODE_NUMERIC, QR_TEXT, EMV_CPM_BASE64
QrScanMethod
How the merchant captured the consumer code.
CAMERA, SCANNER
QrCodeFormat
How qrCode.content is to be rendered.
EMVCO_MPM, URL, RAW
QrInquiryType
Whether enbrTranId names a payment or a refund.
PAYMENT, REFUND
QrCancelReason
TIMEOUT: MineSec got no final status in time. MERCHANT_VOID: the merchant voids a paid transaction.
USER_CANCELLED, TIMEOUT, MERCHANT_VOID
QrEventType
Whether the notify reports a payment or a refund.
PAYMENT, REFUND
QrFailureCode
Why a payment or refund is FAILED. Use one of the listed codes where one fits: CODE_EXPIRED, CODE_INVALID, INSUFFICIENT_FUNDS, USER_CANCELLED, RISK_REJECTED, LIMIT_EXCEEDED, UNSUPPORTED_WALLET, DUPLICATE, SYSTEM_ERROR. UNSUPPORTED_WALLET: the host cannot place a UNIFIED_QR consumer code, or the merchant does not accept its wallet. A code outside the list is accepted and treated as a generic failure.