API REFERENCE
In-App Integration
Applies to in-person POS payments
This API initiates a payment flow in the merchant's own application (App), launching the payment application through App-to-App integration to perform authorization or a one-time payment.
-
The merchant must develop and deploy an application (APK) and install it on the POS device.
-
When a transaction is initiated, the merchant application calls the payment application through App-to-App integration to complete the payment flow.
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 merchant-developed application (Merchant App) and the payment application (Payment App).
Through App-to-App integration, the merchant application can directly launch the payment application on the POS device to perform payment operations.
1. Query devices
Retrieve the merchant's POS device list and status information, such as device numbers and serial numbers.
Before initiating a transaction, you must query devices to identify the target terminal.
2. Initiate a transaction
Use the merchant application (Merchant App) to launch the Switchio Pay payment application through App-to-App integration and complete authorization or a one-time payment.
3. Map online transaction orders using trade_id
After calling Get trade_id to obtain the transaction's trade_id, the merchant's cloud service can use this trade_id to map the transaction to its own order system and make subsequent cloud API calls, such as increasing or decreasing authorization, querying, reversal, or refund.
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:
Refunds and payment cancellation
For refunds (including partial refunds) and payment cancellation, refer to the following API documentation:
- Query Transaction Status
- Reversal > Applies to scenarios where the transaction has completed but has not yet been cleared.
- Refund
