Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/own-pay/OwnPay-Documentation/llms.txt

Use this file to discover all available pages before exploring further.

OwnPay’s SMS gateway feature turns Android smartphones into real-time payment verification agents. When a customer makes a transfer through a mobile wallet such as bKash, Nagad, or Rocket, the wallet provider sends an SMS confirmation to the registered phone number. A paired Android device running the OwnPay Companion App intercepts that SMS, forwards it to the OwnPay server, and the platform’s parsing engine extracts the transaction details to automatically confirm the matching pending payment. This eliminates the need for manual payment approval on every wallet transfer. In the OwnPay admin dashboard, expand the MOBILE & SMS section in the left sidebar and click Paired Devices. The device management dashboard opens with connection KPI cards and the devices table.

​
Device Requirements

Before pairing, ensure your Android device has the OwnPay Companion App installed, SMS read permission granted to the app, and the app excluded from battery optimisation so its background service is not paused by the OS.
If the Android companion app is subject to battery optimisation, the OS may pause its background service on an idle device. This leads to SMS forwarding delays and missed payment verifications. Exclude the app from battery optimisation in the device’s power management settings before pairing.

​
Dashboard Overview

The Paired Devices dashboard provides three KPI summary cards at the top of the page:
CardDescription
Total DevicesThe lifetime count of mobile devices that have been paired with this brand.
ActiveDevices currently authorised and sending SMS data to the server.
RevokedDevices whose session keys have been manually invalidated by an administrator.

​
Pairing a New Device

1

Open the pairing wizard

On the Paired Devices page, click the Pair New Device button to expand the pairing wizard panel.
2

Generate a pairing code

Click Generate Pairing Code. OwnPay creates a cryptographically secure 6-digit numeric token (e.g. 240977). This code is valid for 5 minutes — the countdown timer is displayed next to the code.
3

Open the OwnPay Companion App on your Android device

Ensure SMS permission is enabled on the device. Open the OwnPay Companion App and tap Pair with Admin.
4

Enter the pairing code in the app

Type the 6-digit code displayed in the admin panel into the pairing code field in the Companion App, then tap Confirm.
5

Verify the device appears in the table

Return to the admin panel. The Connected Devices table will refresh and your device will appear with an Active status badge. The Paired column shows the date and time of successful pairing.
Pairing codes expire after 5 minutes. If the countdown reaches zero before the code is entered in the Companion App, click Generate Pairing Code again to create a fresh token. Never share pairing codes in public channels or unsecured messages — they represent a temporary authentication credential for your payment system.

​
Connected Devices Table

The devices table provides live status for every paired handset:
ColumnDescription
DeviceThe device name and hardware fingerprint registered during pairing.
PlatformAndroid OS version and SDK level (e.g. Android 13, SDK 33).
StatusActive (online and forwarding SMS), Offline (not responding to heartbeat pings), or Revoked (session invalidated).
Last SeenTimestamp of the most recent heartbeat ping received from the device.
PairedDate and time the device was successfully paired.
ActionsRevoke permanently disables this device’s authentication credentials.

​
Device Status Indicators

The device is online, has SMS permission enabled, and is actively forwarding incoming messages to the OwnPay server. The Last Seen timestamp will update every few minutes as the app sends regular heartbeat pings.

​
Revoking a Lost or Unused Device

If a paired device is lost, stolen, decommissioned, or replaced:
1

Locate the device in the table

Find the device entry in the Connected Devices table using its name or hardware fingerprint.
2

Click Revoke

Click the Revoke button under the Actions column for that device.
3

Confirm the revocation

Confirm the prompt. The device’s status immediately changes to Revoked, and its server-side JWT token is deleted. Even if the physical device still has the Companion App installed, it can no longer communicate with the OwnPay server.
4

Pair a replacement device if needed

If you are replacing the device, generate a new pairing code and follow the pairing steps above for the replacement handset.
Give each device a descriptive name in the Companion App before pairing — for example, “bKash Phone - Office” or “Nagad Device 2”. Recognisable names make it much easier to manage multiple devices and quickly identify which one to revoke in an emergency.

​
Unpairing vs. Revoking

ActionEffectReversible?
Revoke (from admin panel)Deletes the device’s server-side JWT token immediately. The device cannot forward SMS until re-paired.Yes — re-pair the device with a new pairing code.
Uninstall app (from device)Removes the Companion App from the handset but does not immediately revoke the server token.Revoke from admin panel to clean up the entry.

Build docs developers (and LLMs) love

Get started for freeTalk to us