Terminal — Card Settlement

Sends a card settlement event to the RM Terminal. The terminal settles all pending card transactions in its batch.

When to Use

▾

Use this endpoint when:

• End-of-day card batch settlement
• Closing the daily card transaction batch on the terminal

How to Use

▾

Endpoint

POST/v3/payment/terminal/quickpay

Step 1: Authenticate

▾

Obtain a valid accessToken.

Step 2: Send the Event

▾

POST with type: "SETTLEMENT" and the terminal ID.

Step 3: Verify the Summary

▾

The response summary object contains the batch number, transaction count, and total sales amount.

---

Request Parameters

▾

terminalIdSTRINGrequired

RM Terminal ID

typeSTRINGrequired

Event type. Set to "SETTLEMENT".

dataOBJECT

Request data

receiptTypeINTEGER

Receipt setting: 1 = Print both copies, 2 = Print customer copy only, 3 = Do not print

Response Parameters

▾

codeSTRING

"SUCCESS" if the event was sent to terminal, otherwise an error code.

errorOBJECT

Error details

codeSTRING

Error code if the request failed.

messageSTRING

Error message if the request failed.

debugSTRING

Debug message (sandbox only).

summaryOBJECT

Settlement summary

batchNoSTRING

Terminal settlement sequence number

currencyTypeSTRING

Settlement currency type (currently supported MYR only)

noOfTransactionsINTEGER

Count of settled transactions

settlementAtSTRING

Date and time of settlement

totalSalesAmountINTEGER

Total sales amount in cents

transactions[*]OBJECT

transactions[*] details

amountINTEGER

Transaction amount in cents

currencyTypeINTEGER

Transaction currency type

transactionAtSTRING

Transaction date and time

transactionIdSTRING

Transaction ID

typeSTRING

Transaction type