Getting Started
This page will help you get started with Nami Docs. You'll be up and running in a jiffy!
Get up and running with NamiPay terminal integration in under 15 minutes.
Step 1: Choose Your Platform
| Platform | Package | Use Case |
|---|---|---|
| Android | SkyBandSDK-release.aar | Mobile POS apps |
| iOS | NamiECRSDK.framework | iPad / iPhone POS |
| React Native | ecrlib package | Cross-platform mobile |
| Flutter | ecrlib package | Cross-platform mobile |
| .Net | ECR.dll (P/Invoke) | Windows desktop POS |
| C | SBCoreECR.h / EcrApi.h | Embedded / native Windows |
| REST API - Local | Installer Package | Any language via API Calls |
| REST API - Cloud | Cloud Middleware | Any language via API Calls |
Step 2: Connect to Terminal*
Ensure the Nami payment terminal is powered on and
- connected to the same network for TCP/IP or a reachable network if the Nami terminal and the customer device are in different networks
- paired via the device settings for Bluetooth
- connected via a data cable (Micro-USB/Type C to Type A) for Serial/COM
- connected to WiFi for Cloud middleware with the ECR Adapter application installed.
Step 3: Register Terminal
Send a Register request (txnType = 17) with your Cash Register Number
Register Request:
txnType: 17
cashRegisterNumber: "12345678"
Expected: Success response confirming registration
Step 4: Start Session*
Send a Start Session request (txnType = 18) to begin the transaction session.
Register Request:
txnType: 18
cashRegisterNumber: "12345678"
Expected: Success response confirming session start
Step 5: Perform a Purchase
Send a Purchase request (txnType = 0) alongwith the ECR Reference number and the amount will pop-up on the terminal
Purchase Request:
txnType: 0
amount: "100" (SAR 1.00 - amount in halalas)
ecrRefNo: "12345678900001"
date: "130623193000" (ddMMyyHHmmss)
Step 6: Parse the Response
Once the payment is done, the terminal will send the response. Use the SDK's parse function to extract the response code, approval code, and receipt data from the semi-colon delimited response string.
*This step is not applicable for Local and Cloud Middleware Integration
Bluetooth Connection
Step 1: Power On Terminal
- Ensure the payment terminal is switched on.
- Confirm the terminal display is active.
- Verify Bluetooth is enabled on the terminal.
Updated about 1 month ago
