PayExplorer Connect SDK provides APIs for integrating payment terminal capabilities into your application, including financial transactions, device interaction, and transaction support.
Documentation Reading Route · Platforms · Capabilities and Relationships · Terminal Access Methods · Integration Guides
Use this index to choose documentation for the current question or integration activity. It is a reading route, not a required implementation sequence. For an existing project, go directly to the topic you need. Read only the relevant platform tab or section; a navigation group does not require reading every linked page.
| Documentation topic | Read when needed |
|---|---|
| Platform and architecture | Check Platforms. Read Solution Overview when you need to understand the SDK architecture and the roles of the application and payment terminal. |
| Capabilities and terminal strategy | Check Capabilities and Relationships and Terminal Access Methods. Consult Terminal Configuration or the relevant business guide when choosing a strategy. |
| Terminal and project preparation | Read Terminal Preparation for the payment terminal and Add SDK Dependency for the application's SDK source, version, build configuration, and required iOS startup. |
| Terminal configuration and iOS startup | For iOS, complete iOS SDK Initialization in the dependency guide. See Terminal Configuration and Selection for terminal setup, and Service Routing when multiple providers or per-request targets are involved. |
| Capability implementation | Use Accepting a Payment as an example of the common Exchange flow, then follow the relevant business guides and consult API Reference for request and response details. Check exact declarations against the SDK version in the project. |
| Validation and troubleshooting | Use Go-Live Checklist, then Error Codes, FAQ, or related capability pages for the issue encountered. |
Use AI-Assisted Development for Skill installation or usage questions. Troubleshooting resources are available throughout integration.
| Platform | SDK Guide |
|---|---|
| Android | Android tab in Add SDK Dependency |
| Windows | Windows tab in Add SDK Dependency |
| iOS | iOS tab in Add SDK Dependency |
“Supported” means the SDK provides the capability. See the feature documentation for terminal requirements and applicable conditions.
Overview: Financial Services.
| Feature and Documentation | Purpose | Android | Windows | iOS |
|---|---|---|---|---|
| Payment | Initiate a payment | Supported | Supported | Supported |
| Refund | Return funds from an original transaction | Supported | Supported | Supported |
| Reversal | Reverse a completed transaction | Supported | Supported | Supported |
| Pre-Authorization | Reserve an authorized amount | Supported | Supported | Supported |
| Pre-Auth Completion | Complete an existing pre-authorization | Supported | Supported | Supported |
| Authorization Adjustment | Adjust a pre-authorized amount | Supported | Supported | Supported |
| Reconciliation | Reconcile transactions and settle the terminal | Supported | Supported | Supported |
| Balance Inquiry | Query an account or card balance | Supported | Supported | Supported |
| Feature and Documentation | Purpose | Android | Windows | iOS |
|---|---|---|---|---|
| Display | Display text, images, and other content | Supported | Supported | Supported |
| Print text or images | Supported | Supported | Supported | |
| NFC Tag | Process tag data | Supported | Supported | Supported |
| Transmit | Forward ECR messages | Supported | Supported | Supported |
| Feature and Documentation | Purpose | Android | Windows | iOS |
|---|---|---|---|---|
| Abort | Abort an ongoing transaction | Supported | Supported | Supported |
| Message Status | Query a transaction result or processing status | Supported | Supported | Supported |
| Event Notification | Receive transaction progress events | Supported | Supported | Supported |
| Reprint | Reprint a transaction receipt | Supported | No dedicated API | Supported |
| Transaction or Capability | Related Capabilities or Records | Relationship |
|---|---|---|
| Financial Transaction Capabilities | Event Notification, Abort, Message Status | Transaction progress and exception handling |
| Pre-Authorization | Pre-Auth Completion, Authorization Adjustment, Reversal | Follow-up operations |
| Pre-Auth Completion, Authorization Adjustment | Original pre-authorization transaction | Original transaction reference |
| Refund, Reversal, Reprint | Original transaction | Original transaction reference |
| Mode | Android | Windows | iOS |
|---|---|---|---|
| Same device | Supported | Not supported | Not supported |
| Separate devices | Supported | Supported | Supported |
Choose one access mode. Same device means the business application runs directly on the payment terminal; separate devices means it runs on another device.
| Method | Android | Windows | iOS |
|---|---|---|---|
| LAN | Supported | Supported | Supported |
| USB | Supported | Supported | Not supported |
| UART | Supported | Supported | Not supported |
| Bluetooth | Supported | Not supported | Not supported |
For separate-device access, one or more supported communication methods can be enabled.
See Terminal Configuration and Selection for terminal selection and management, and Service Routing for selecting among multiple terminals and services.
