Payment App: Difference between revisions

From wizarPOS
No edit summary
 
(32 intermediate revisions by the same user not shown)
Line 4: Line 4:
===User Guide===
===User Guide===
* [https://ftp.wizarpos.com/payment/PaymentInterfaceAppUserGuide.pdf PaymentInterfaceAppUserGuide.pdf]
* [https://ftp.wizarpos.com/payment/PaymentInterfaceAppUserGuide.pdf PaymentInterfaceAppUserGuide.pdf]
===Demonstration steps(Connect terminal to PC)===
===Demonstration steps(Connect terminal to PC, test through by serial port)===
* Install Payment Apps, apps can install through by ADB, or push through by TMS.
* Install Payment Apps, apps can install through by ADB, or push through by TMS.
* Set protocal type in Payment app, refer to PaymentInterfaceAppUserGuide.pdf
* Set protocal type in Payment app, refer to PaymentInterfaceAppUserGuide.pdf
Line 11: Line 11:
* Send handshake command data through by serial port tool, refer to [https://ftp.wizarpos.com/advanceSDK/test.txt TestData]
* Send handshake command data through by serial port tool, refer to [https://ftp.wizarpos.com/advanceSDK/test.txt TestData]
* Send Transaction command data through by serial port tool, refer to [https://ftp.wizarpos.com/advanceSDK/test.txt TestData]
* Send Transaction command data through by serial port tool, refer to [https://ftp.wizarpos.com/advanceSDK/test.txt TestData]
===Debug tools in Windows===
===Debug tools in Windows===
* Serial port tool-- Download from Microsoft Store
* Serial port tool-- Download from Microsoft Store
Line 17: Line 18:
===Protocol===
===Protocol===
Please refer to the protocol which communicate with payment app.
Please refer to the protocol which communicate with payment app.
* [https://ftp.wizarpos.com/advanceSDK/PaymentApp/WIZARPOSPaymentAppIntegrationProtocol2.0.8.pdf WIZARPOSPaymentAppIntegrationProtocol2.0.8.pdf]
* [https://ftp.wizarpos.com/payment/WIZARPOSPaymentAppIntegrationProtocolV2.2.2.6.pdf WIZARPOSPaymentAppIntegrationProtocolV2.2.2.6.pdf]
 
===Payment Apps===
===Payment Apps===
The two payment apps need install to terminal firstly.
The two payment apps need install to terminal firstly.
* [https://ftp.wizarpos.com/payment/PayWizard_Demo_V2.0.0_2508081.apk PayWizard_Demo_V2.0.0_2508081.apk]
* [https://ftp.wizarpos.com/payment/PayWizard_Demo_V2.1.9_2601061.apk PayWizard_Demo_V2.1.9_2601061.apk]
* [https://ftp.wizarpos.com/payment/OPC_V1.9.0-global-release.apk OPC_V1.9.0-global-release.apk]
* [https://ftp.wizarpos.com/payment/OPC_V2.2.5-global-release.apk OPC_V2.2.5-global-release.apk]


=== Local Integration ===
=== Local Integration ===
Suitable for scenarios where no application development on the POS terminal is needed. Instead, the Vendor Machine communicates directly with the Payment App. In this case, communication between the POS terminal and the Vendor Machine supports serial port, MDB (Multi-Drop Bus), and Socket protocols.  
Suitable for scenarios where no application development on the POS terminal is needed. Instead, the Vendor Machine communicates directly with the OPC. In this case, communication between the POS terminal and the Vendor Machine supports serial port, MDB (Multi-Drop Bus), and Socket protocols.  
* Reference for data packaging and unpacking of VM:[https://ftp.wizarpos.com/advanceSDK/PaymentApp/Serial&SocketDemo240910.zip Serial&SocketDemo240910.zip]
* Reference for data packaging and unpacking of VM:[https://ftp.wizarpos.com/advanceSDK/PaymentApp/Serial&SocketDemo240910.zip Serial&SocketDemo240910.zip]
* See also, [https://smartpossdk.gitbook.io/paywizard-open-api/semi-integration/local-integration local-integration]
* See also, [https://smartpossdk.gitbook.io/paywizard-open-api/semi-integration/local-integration local-integration]


===Internal Integration===
===Internal Integration===
It is suitable for developing applications on the terminal. When this application uses the payment function, it only calls the payment AIDL interface provided by the payment application. Other functions of the application are implemented by the application itself.  
It is suitable for developing normal applications on the terminal. It can call the AIDL interface provided by the OPC application to do different transaction. It communicate with the Vendor Machine.
* Reference for calling payment AIDL interface:[https://github.com/SmartPOSSamples/PayMentAIDLDemo PayMentAIDLDemo]
* Reference for calling payment AIDL interface:[https://github.com/SmartPOSSamples/PayMentAIDLDemo PayMentAIDLDemo-guide to call OPC aidl interface]
* See also, [https://smartpossdk.gitbook.io/paywizard-open-api/semi-integration/internal-integration internal-integration]
* See also, [https://smartpossdk.gitbook.io/paywizard-open-api/semi-integration/internal-integration internal-integration]


===Cloud Mode===
* Integrate flow, please refer to https://smartpossdk.gitbook.io/paywizard-open-api/cloud-api/quick-start-cloud-api
* [https://github.com/SmartPOSSamples/PaywizardCloudAPIDemo.git A simple android demo which access the cloud API to do transaction. Actually, users can develop any http project to access Cloud API, the demo is only a reference].
* [https://github.com/SmartPOSSamples/PaywizardDemo A simple java demo which access the cloud API to do transaction. Actually, users can develop any http project to access Cloud API, the demo is only a reference].
===Best practice for payment in D22(D3)/Q3(Q2)===
* Install [https://ftp.wizarpos.com/payment/AccessoryAgentHostService-master-release-v1.0.30-r20251208115422-q1_platform.apk the new accessory agent] on D22(D3)/Q3(Q2)
* Install initconnectionmode on D22/Q3, configure master and slave. This step is usually pre-initialized at the factory and does not require further configuration by the customer.
* Install OPC on D22/Q3
* Set OPC to DEFAULT on D22, and set the payment packet name to com.wizarpos.opc
* Set OPC to USB ACCESSORY on Q3, and set the payment packet name to com.wizarpos.paywizard.demo
===Payment App development===
===Payment App development===
It is suitable for developing payment application on the terminal. This payment application interacts with the bank and provides the AIDL interface of the payment function to the terminal payment OPC call. Please contact sales for guidance from the development team.[https://ftp.wizarpos.com/advanceSDK/PaymentApp/AIDLServiceDemo240910(ProvidedAIDLtoOPC).zip A simple service demo which provided AIDL interface].
It is suitable for developing payment application on the terminal. This payment application interacts with the bank and provides the AIDL interface of the payment function to the terminal payment OPC call. Please contact sales for guidance from the development team.
 
[https://ftp.wizarpos.com/advanceSDK/PaymentApp/AIDLServiceDemo240910(ProvidedAIDLtoOPC).zip A simple service demo which provided AIDL interface].
 
[https://ftp.wizarpos.com/advanceSDK/PaymentApp/IntegrationdocwithOPC.zip IntegrationdocwithOPC.zip(include above demo and the protocal document)].


==Others==
==Others==
Line 40: Line 57:


==FAQ==
==FAQ==
*Simple prototype file, generally, configure this file in TMS, [https://ftp.wizarpos.com/payment/opc-v1.7.0-config-simplify-20250814.xml Parameters-Prototype xml file:opc-v1.7.0-config-simplify-20250814.xml]. Package name of the payment app is "com.wizarpos.paywizard.demo"
*Simple prototype file, generally, configure this file in TMS, [https://ftp.wizarpos.com/payment/opc-v2.2.5-config-simple-20251217.xml Parameters-Prototype xml file:opc-v2.2.5-config-simple-20251217.xml]. Package name of the payment app is "com.wizarpos.paywizard.demo"
*Full prototype file, don't use this file, just for a reference, [https://ftp.wizarpos.com/payment/opc-v1.7.0-config-20250814.xml Parameters-Prototype xml file:opc-v1.7.0-config-20250814.xml]
*Full prototype file, don't use this file, just for a reference, [https://ftp.wizarpos.com/payment/opc-v2.2.5-config-all-20251216.xml Parameters-Prototype xml file:opc-v2.2.5-config-all-20251216.xml]
*To configure app paramter, pelase read this "Configure a Parameter File with a Template" chapter of the [https://smartpossdk.gitbook.io/cloudpossdk/faq/tms-wizarview/accept-tms-file-downloads spec], please use prototype file- opc-v1.7.0-config-simplify-20250814.xml, package name which accept the parameter is "com.wizarpos.opc".
*To configure app paramter, pelase read this "Configure a Parameter File with a Template" chapter of the [https://smartpossdk.gitbook.io/cloudpossdk/faq/tms-wizarview/accept-tms-file-downloads spec], please use prototype file- opc-v1.7.0-config-simplify-20250814.xml, package name which accept the parameter is "com.wizarpos.opc".
*[https://smartpossdk.gitbook.io/cloudpossdk/faq/advance-sdk/learn-kiosk-mode learn-kiosk-mode]
*[https://smartpossdk.gitbook.io/cloudpossdk/faq/advance-sdk/learn-kiosk-mode learn-kiosk-mode]
Line 54: Line 71:
*[https://smartpossdk.gitbook.io/cloudpossdk/faq/tms-wizarview/apply-wizarview-account Apply TMS Account]
*[https://smartpossdk.gitbook.io/cloudpossdk/faq/tms-wizarview/apply-wizarview-account Apply TMS Account]
*[https://ftp.wizarpos.com/device/TMSManual.pdf TMS Manual]
*[https://ftp.wizarpos.com/device/TMSManual.pdf TMS Manual]
==[[Chinese Document]]==
==[[Chinese Document]]==

Latest revision as of 06:24, 6 January 2026

Quick Start

Demo Video

User Guide

Demonstration steps(Connect terminal to PC, test through by serial port)

  • Install Payment Apps, apps can install through by ADB, or push through by TMS.
  • Set protocal type in Payment app, refer to PaymentInterfaceAppUserGuide.pdf
  • Connect terminal to PC
  • Start serial port tool in PC
  • Send handshake command data through by serial port tool, refer to TestData
  • Send Transaction command data through by serial port tool, refer to TestData

Debug tools in Windows

Develop resource

Protocol

Please refer to the protocol which communicate with payment app.

Payment Apps

The two payment apps need install to terminal firstly.

Local Integration

Suitable for scenarios where no application development on the POS terminal is needed. Instead, the Vendor Machine communicates directly with the OPC. In this case, communication between the POS terminal and the Vendor Machine supports serial port, MDB (Multi-Drop Bus), and Socket protocols.

Internal Integration

It is suitable for developing normal applications on the terminal. It can call the AIDL interface provided by the OPC application to do different transaction. It communicate with the Vendor Machine.

Cloud Mode

Best practice for payment in D22(D3)/Q3(Q2)

  • Install the new accessory agent on D22(D3)/Q3(Q2)
  • Install initconnectionmode on D22/Q3, configure master and slave. This step is usually pre-initialized at the factory and does not require further configuration by the customer.
  • Install OPC on D22/Q3
  • Set OPC to DEFAULT on D22, and set the payment packet name to com.wizarpos.opc
  • Set OPC to USB ACCESSORY on Q3, and set the payment packet name to com.wizarpos.paywizard.demo

Payment App development

It is suitable for developing payment application on the terminal. This payment application interacts with the bank and provides the AIDL interface of the payment function to the terminal payment OPC call. Please contact sales for guidance from the development team.

A simple service demo which provided AIDL interface.

IntegrationdocwithOPC.zip(include above demo and the protocal document).

Others

FAQ

Chinese Document