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 |
| Flutter | ecrlib package | Cross-platform mobile |
| .NET / WPF | ECR.dll (P/Invoke) | Windows desktop POS |
| C/C++ | SBCoreECR.h / EcrApi.h | Embedded / native Windows |
| REST API | Cloud Middleware | Any language via HTTP |
Step 2: Connect to Terminal
Ensure the Nami payment terminal is powered on and connected to the same network (TCP/IP) or paired (Bluetooth). Default TCP port: 8888.
Step 3: Register ECR
Send a Register request (txnType = 17) with your Cash Register Number.
Register Request:
txnType: 17
cashRegisterNumber: "ECR001"
Expected: Success response confirming registration
Step 4: Start Session
Send a Start Session request (txnType = 18) to begin the transaction session.
Step 5: Perform a Purchase
Purchase Request:
txnType: 0
amount: "100" (SAR 1.00 - amount in halalas)
ecrRefNo: "REF001"
date: "130623193000" (ddMMyyHHmmss)
Step 6: Parse the Response
Use the SDK's parse function to extract the response code, approval code, and receipt data from the pipe-delimited response string.
Updated 4 days ago