Payments
Custom Terminal apps
In a nutshell
How to build a custom Android app that accepts payments on Paystack Terminal.
Copy linkBuild against the Paystack terminal app
- Build your app for Android.
- Target the Paystack terminal app package name
com.paystack.poswhen constructing intents. - Use
Intent.ACTION_VIEWas the action for supported operations.
Copy linkChoose the terminal operation
- Pass the right extra key for the operation you want:
com.paystack.pos.TRANSACTto initiate a transactioncom.paystack.pos.PARAMETERSto fetch terminal detailscom.paystack.pos.SETTINGSto open terminal settings
- Use
startActivityForResult-style handling for operations that return a result.
Copy linkCreate the transaction request
- Build a
TransactionRequestobject. - Set
amountin kobo. - Add
offlineReferenceif the payment is for a previously created invoice. - Add
supplementaryReceiptDatawhen you want receipt text, an image URL, or barcode/QR data printed with the receipt. - Add
metadatawhen you need extra transaction context.
Copy linkLaunch the payment flow
- Attach the
TransactionRequestto the transaction intent. - Start the Paystack terminal activity.
- Let the Paystack terminal app collect the payment.
- Parse the returned
TransactionResponsefrom the result payload when the transaction completes.
Copy linkFetch terminal details when needed
- Build a parameters intent with
com.paystack.pos.PARAMETERS. - Start the intent and parse the returned
PaystackIntentResponse. - Read the terminal identifier and serial number from the parsed parameters response.
Copy linkOpen settings for administrative actions
- Send an intent with
com.paystack.pos.SETTINGS. - Launch it with
startActivitybecause the settings operation does not return a result.
Copy linkPrepare the app for deployment
- Enable HTTPS in your app.
- Keep payload sizes within Android intent limits.
- Generate your APK after testing.
- Indicate deployment interest to Paystack, complete the preliminary scan, and submit the APK.
- Paystack reviews the APK for security and deploys it to the store. Wait for this before rolling out to your devices.
This flow is suited to businesses that want branded on-device experiences instead of relying only on server-pushed terminal requests.
Was this page helpful?