Documentation/API Reference

API REFERENCE

Cloud Integration

Applies to in-person POS payments

This API sends payment or authorization instructions to a POS device through the cloud.

Before calling this API, ensure that the POS device is online and available so that instructions can be delivered and processed successfully.

Tip

Authorization transactions initiated through a POS terminal are valid for 5 days. Authorization orders expire automatically after 5 days.

Integration overview

This section describes the core interactions and basic workflow between the cloud system and POS terminal.


1. Query devices

Retrieve the merchant's POS device list and status information, such as device numbers and serial numbers.
Before initiating a transaction, query devices to identify the target terminal.


2. Initiate a transaction

Send a transaction instruction through the cloud to the specified POS device to initiate payment or authorization.
The POS terminal displays the payment screen and guides the user through the transaction.


3. Cancel a transaction

Send a cancellation instruction to the POS terminal to stop the transaction currently in progress.
This closes the payment screen on the terminal so that the system can initiate a new transaction request.

Applies to scenarios where the transaction has not yet completed.


4. Reverse a transaction

Send a reversal instruction to the POS terminal to reverse a completed transaction.
The POS terminal displays the reversal result to the user.

Applies to scenarios where the transaction has completed but has not yet been cleared.


Authorization workflow

For operations after authorization, such as amount adjustments and final capture, we strongly recommend using the APIs rather than operating directly on the POS terminal.
This improves system consistency, control, and transaction traceability.

The following APIs are available:

  • Increase authorization
  • Decrease authorization
  • Authorization capture

Refunds and payment cancellation

For refunds (including partial refunds) and payment cancellation, refer to the following API documentation: