Card Payment Settlement

Trigger card settlement on the RM Terminal from a POS system. Settles all pending card transactions in the open batch.

When to Use

▾

Use this endpoint when:

• End-of-day batch settlement from your POS app
• Closing the daily card batch on the connected terminal

How to Use

▾

Method: POST URL: https://open.revenuemonster.my/v3/event/terminal Sandbox URL: https://sb-open.revenuemonster.my/v3/event/terminal

Step 1: Identify the Terminal

▾

Use the terminalId of the RM Terminal performing the settlement.

Step 2: Send the Settlement Event

▾

POST with type: "SETTLEMENT" and the desired receiptType.

Step 3: Read the Settlement Summary

▾

The response summary contains batch number, transaction count, and total sales. transactions lists each settled record.

---

Request Parameters

▾

terminalIdSTRINGrequired

Terminal ID

Example: "1582107209454501456"

typeSTRINGrequired

Request type

Example: "SETTLEMENT"

dataSTRINGrequired

(Refer data )

Example: {}

receiptTypeINTEGERrequired

1 : Print Settlement summary and Settlement detail 3 : Perform settlement in the background without receipt

Example: 3

Example Request

JSON

1curl --location --request POST "https://sb-open.revenuemonster.my/v3/event/terminal" \
2--header "Content-Type: application/json" \
3--header "Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjIwMTgtMDMtMTMiLCJ0eXAiOiJKV1QifQ.eyJhdWQiOlsiYXBpX2NsaWVudEBFaGNLQzA5QmRYUm9RMnhwWlc1MEVNV1Z4NF9UbE5MZEZRIl0sImV4cCI6MTU4NjMzNzc1OCwiaWF0IjoxNTgzNzQ1NzU4LCJpc3MiOiJodHRwczovL3NiLW9hdXRoLnJldmVudWVtb25zdGVyLm15IiwianRpIjoiRWh3S0VFOUJkWFJvUVdOalpYTnpWRzlyWlc0UXlKSG9qb2VNcHYwViIsIm5iZiI6MTU4Mzc0NTc1OCwic3ViIjoiRWhRS0NFMWxjbU5vWVc1MEVKWFZ6ZDN3cmFxVE9SSVFDZ1JWYzJWeUVJeUpxSXp2eU1QVmNRIn0.FfBkCb7fjCKJdcy_DS06dKgEtcAvukPio0HyDRtH2UovhZsLFSqD_8oo21u094XSor_mqFg4hqXmLaHjX-h92Wz3kHl7OwiKQb16x8Rnl5OdyPHtMqIZqP8ab8Ch0RHEZ33VchK1zBTnG6Xosrb1B44tWqJ0_kdTtbRZN4rG821C8i4sb6sx8GaxgluJ5q7CEifMTBFJam_Jub9LfAfukq8YyIl0Bykp7B3A_su2QoELL9L_ElJdV9FuwFPHcKr9bxLvVSrEdyrFg7IBm_tJHxSl8gTh3j4b6lWZrBCfMSLraXaYRNzz1ddbVnwYD4aRuSyRmQeMYTUj0cInktnKUA" \
4--header "X-Signature: sha256 GohuT2QTUXJV3MZh2OoEE9qW9wcfakOU9iVLmkTjM12NQuV6IcWMRQDz9NdxAOVIrh5MssfYCLDlafb2illXxgQMpmZkZ38NT6NQsMeMfGbHBS1Kc+BUtU7o1TMLUzk55J1tA6f0Z95oEuBlCeLm6VsgCG30wFm5YmgssJ0weIwMcW355r2sFl7QcKOuRqynoGtmmr/aGfOk1HjiFLoFzSd38O7rRjwGrekYwuYUD1N/Wp5GFXRjtaaPkzAERPbXEmnh/taLME8VeAhky6dAVGZE6gHKnP5WvvVjUE+KLtj3D32YIHzxhzEW9x3JEObqgvm5Q2oRZNxoh6/MvqwkVA==" \
5--header "X-Nonce-Str: bfdgdjgtjhmnbmmjmdfdghghffj" \
6--header "X-Timestamp: 1546850694" \
7--data-raw {
8  "terminalId": "1554193032595276913",
9  "type": "SETTLEMENT",
10   "data": {
11      "receiptType": 3
12  }
13}

Response Parameters

▾

summaryOBJECT

(Refer summary)

Example: {}

batchNoSTRINGrequired

Sequence no. of the terminal settlement

Example: "000311"

currencyTypeSTRINGrequired

Current only support Ringgit Malaysia

Example: "MYR"

noOfTransactionsINTEGERrequired

Count of settled transactions

Example: 2

settlementAtDATETIMErequired

Date and time of the settlement

Example: "2021-02-17T18:06:47Z"

totalSalesAmountINTEGERrequired

Balance in cents

Example: 0

transactionsARRAY

(Refer to transaction)

Example: []

Transaction object transaction:

amountINTEGERrequired

Amount in cent

Example: 10

currencyTypeSTRINGrequired

Current only support Ringgit Malaysia

Example: "MYR"

transactionAtDATETIMErequired

Date time of transaction on terminal

Example: "2021-02-16T17:44:02Z"

transactionIdSTRINGrequired

Transaction ID (from RM server)

Example: "210217174359100325085446"

typeSTRINGrequired

Transaction type SALE or VOID

Example: "SALE"

Example Response

JSON

1{
2"summary": {
3  "batchNo": "000311",
4  "currencyType": "MYR",
5  "id": "001778",
6  "noOfTransactions": 2,
7  "settlementAt": "2021-02-17T18:06:47Z",
8  "totalSalesAmount": 0
9},
10"transactions": [
11  {
12    "amount": 10,
13    "currencyType": "MYR",
14    "transactionAt": "2021-02-16T17:44:02Z",
15    "transactionId": "210217174359100325085446",
16    "type": "SALE"
17  },
18  {
19    "amount": 10,
20    "currencyType": "MYR",
21    "transactionAt": "2021-02-16T17:44:29Z",
22    "transactionId": "210217174359100325085446",
23    "type": "VOID"
24  }
25]
26}