SDK API

View all API objects, methods, attributes and responses embedded within Smart Terminal SDK

Overview

Introduction

The initialization process prepares the POS system for secure communication with the Smart Terminal by setting up essential SDK components, such as IReader for terminal interaction and ICodecManager for data encoding and decoding.

SoftSpaceSDK

Class representing the entry point of this SDK, all features are provided through this class.

                // To get a SoftspaceSDK instance
val sdk = SoftSpaceSDK()
Overview
ApicodecApiusbReader

ICodecManager

ICodecManager is responsible for encoding and decoding data between the POS application and the Smart Terminal. It converts request objects into a byte format for sending, and converts received byte responses back into readable data. This ensures smooth communication between systems using the correct format.

Overview
ApiencodeRequestApidecodeResponseApiencodeRequestAsStringApiformatResponseAsStringApiverifyResponseEnumReaderTag

IReader

The IReader component of the Smart Terminal SDK serves as the primary communication interface between the POS application and the Smart Terminal. It is responsible for establishing and monitoring the connection to the reader device, sending transaction requests, and receiving responses. This enables the POS to interact with the terminal smoothly and reliably throughout the payment process.

Overview
ApiconnectApisendRequestApireceiveResponseApiobserveConnectionApiclear

Core Modules

Card Payment

This section documents the integration message for Card Payment.

Overview
ObjectCardSaleRequestObjectHashMap

QR Payment

This section documents the integration message for QR Payment.

Overview
ObjectQRPaymentRequestObjectHashMap

QR Inquiry

This section documents the integration message for QR Inquiry.

Overview
ObjectQRInquiryPaymentRequestObjectHashMap

Void

This section documents the integration message for Void.

Overview
ObjectVoidRequestObjectHashMap

Cancel

This section documents the integration message for Cancel.

Overview
ObjectCancelRequestObjectHashMap

Transaction Status

This section documents the integration message for Transaction Status.

Overview
ObjectTransactionStatusRequestObjectHashMap

Settlement Info

This section documents the integration message for Settlement Info.

Overview
ObjectSettlementInfoRequestObjectHashMap

Settlement

This section documents the integration message for Settlement.

Overview
ObjectSettlementRequestObjectHashMap

Send E-Receipt

This section documents the integration message for Send e-Receipt.

Overview
ObjectSendEReceiptRequestObjectHashMap

Membership Info

This section documents the integration message for Membership Info.

Overview
ObjectMembershipInfoRequestObjectHashMap

Top Up

This section documents the integration message for Top Up.

Overview
ObjectTopUpRequestObjectHashMap

Card Refund

This section documents the integration message for Card Refund.

Overview
ObjectRefundRequestObjectHashMap

QR Refund

This section documents the integration message for QR Refund.

Overview
ObjectQRRefundRequestObjectHashMap

Bill Payment

This section documents the integration message for Bill Payment.

Overview
ObjectBillPaymentRequestObjectHashMap