Payment Api
1.1 Setup Details
The HTTP communication protocol was used to communicate between terminal and third party’s device.
1.1.1 URL
The terminal URL is http://[terminal_ip_address]:8888. The IP address can be obtained from the terminal. And the IP address change according to network.
1.1.2 Listener
The listener only active at main page. If the terminal at different page, the terminal won’t listen to incoming message.
1.2 Message Format
POST request method was used this communication.
1.2.1 Header
Content-Type: application/json
1.2.2 Example Request Body
{"TransactionType":"1","TransactionAmount":"1.00"}
1.2.3 Example Response Body
{"ResponseCode":"00","ResponseDescription":"Approved","TransactionType":"1","TransactionAmount":"1.00","TransactionMID":"000000000000001","TransactionTID":"00000001","TransactionSTN":"000001","TransactionRRN":"123456789012","TransactionBatchNo":"000001","TransactionApplicationLabel":"Visa Cerdit","TransactionCardNo":"412345******9999","TransactionEntryType":"wave","TransactionARQC":"8989898989","TransactionTVR":"0000000000","TransactionAID":"00000000003101","TransactionCVM":"000000","TransactionTSI":"00","TransactionApprovalCode":"123456","TransactionInvoice":"000001","TransactionSchemeID":"01","TransactionDateTime":"20220501110023"}
1.2.4 Type of Transaction
| Transaction Type | Value |
|---|---|
| Sale | 1 |
| Void | 2 |
| Settlement | 3 |
| Pre-Authorization | 4 |
| Sale Complete | 5 |
| Pre-Authorization Cancel | 6 |
| E-Wallet Sale | 7 |
| E-Wallet Void | 8 |
| E-Wallet Settlement | 9 |
| Void Sale Complete | 10 |
1.2.5 Request Body and Response Body Key Value
| Type of Sale | Request | Response |
|---|---|---|
| Sale | TransactionType TransactionAmount | ResponseCode ResponseDescription TransactionType TransactionAmount TransactionMID TransactionTID TransactionSTN TransactionRRN TransactionBatchNo TransactionApplicationLabel TransactionCardNo TransactionEntryType TransactionARQC TransactionTVR TransactionAID TransactionCVM TransactionTSI TransactionApprovalCode TransactionInvoice TransactionSchemeID TransactionDateTime |
| Void | TransactionType TransactionInvoice | ResponseCode ResponseDescription TransactionType TransactionAmount TransactionMID TransactionTID TransactionSTN TransactionRRN TransactionBatchNo TransactionApplicationLabel TransactionCardNo TransactionEntryType TransactionARQC TransactionTVR TransactionAID TransactionCVM TransactionTSI TransactionApprovalCode TransactionInvoice TransactionSchemeID TransactionDateTime |
| Settlement | TransactionType | ResponseCode ResponseDescription TransactionType SettlementAmount SettlementCount SettlementSaleAmount SettlementSaleCount SettlementVoidAmount SettlementVoidCount SettlementMID SettlementTID SettlementSTN SettlementRRN SettlementBatchNo SettlementDateTime |
| PreAuth | TransactionType TransactionAmount | ResponseCode ResponseDescription TransactionType TransactionAmount TransactionMID TransactionTID TransactionSTN TransactionRRN TransactionBatchNo TransactionApplicationLabel TransactionCardNo TransactionEntryType TransactionARQC TransactionTVR TransactionAID TransactionCVM TransactionTSI TransactionApprovalCode TransactionInvoice TransactionSchemeID TransactionDateTime |
| Sale Complete | TransactionType TransactionAmount TransactionRRN TransactionApprovalCode TransactionInvoice | ResponseCode ResponseDescription TransactionType TransactionAmount TransactionMID TransactionTID TransactionSTN TransactionRRN TransactionBatchNo TransactionApplicationLabel TransactionCardNo TransactionEntryType TransactionARQC TransactionTVR TransactionAID TransactionCVM TransactionTSI TransactionApprovalCode TransactionInvoice TransactionSchemeID TransactionDateTime |
| Void Sale Complete | TransactionType TransactionInvoice | ResponseCode ResponseDescription TransactionType TransactionAmount TransactionMID TransactionTID TransactionSTN TransactionRRN TransactionBatchNo TransactionApplicationLabel TransactionCardNo TransactionEntryType TransactionARQC TransactionTVR TransactionAID TransactionCVM TransactionTSI TransactionApprovalCode TransactionInvoice TransactionSchemeID TransactionDateTime |
| Perauth Cancel | TransactionType TransactionInvoice | ResponseCode ResponseDescription TransactionType TransactionAmount TransactionMID TransactionTID TransactionSTN TransactionRRN TransactionBatchNo TransactionApplicationLabel TransactionCardNo TransactionEntryType TransactionARQC TransactionTVR TransactionAID TransactionCVM TransactionTSI TransactionApprovalCode TransactionInvoice TransactionSchemeID TransactionDateTime |
| Ewallet Sale | TransactionType TransactionAmount | ResponseCode ResponseDescription TransactionType TransactionAmount TransactionId TransactionRefId TransactionEWallet TransactionDateTime |
| Ewallet Void | TransactionType TransactionRefId | ResponseCode ResponseDescription TransactionType TransactionAmount TransactionId TransactionRefId TransactionEWallet TransactionDateTime |
| Ewallet Settlement | TransactionType | ResponseCode ResponseDescription TransactionType SettlementAmount SettlementCount SettlementSaleAmount SettlementSaleCount SettlementVoidAmount SettlementVoidCount SettlementMID SettlementTID SettlementDateTime |
1.2.6 CURL Example
curl --location --request POST 'http://115.132.150.54:8888'
--header 'Content-Type: application/json'
--data-raw '{"TransactionType":"1","TransactionAmount":"1.00"}'