Sign in

Payments

Custom Terminal apps

View as Markdown

In a nutshell

How to build a custom Android app that accepts payments on Paystack Terminal.

Copy linkBuild against the Paystack terminal app

  1. Build your app for Android.
  2. Target the Paystack terminal app package name com.paystack.pos when constructing intents.
  3. Use Intent.ACTION_VIEW as the action for supported operations.

Copy linkChoose the terminal operation

  1. Pass the right extra key for the operation you want:
    • com.paystack.pos.TRANSACT to initiate a transaction
    • com.paystack.pos.PARAMETERS to fetch terminal details
    • com.paystack.pos.SETTINGS to open terminal settings
  2. Use startActivityForResult-style handling for operations that return a result.

Copy linkCreate the transaction request

  1. Build a TransactionRequest object.
  2. Set amount in kobo.
  3. Add offlineReference if the payment is for a previously created invoice.
  4. Add supplementaryReceiptData when you want receipt text, an image URL, or barcode/QR data printed with the receipt.
  5. Add metadata when you need extra transaction context.

Copy linkLaunch the payment flow

  1. Attach the TransactionRequest to the transaction intent.
  2. Start the Paystack terminal activity.
  3. Let the Paystack terminal app collect the payment.
  4. Parse the returned TransactionResponse from the result payload when the transaction completes.

Copy linkFetch terminal details when needed

  1. Build a parameters intent with com.paystack.pos.PARAMETERS.
  2. Start the intent and parse the returned PaystackIntentResponse.
  3. Read the terminal identifier and serial number from the parsed parameters response.

Copy linkOpen settings for administrative actions

  1. Send an intent with com.paystack.pos.SETTINGS.
  2. Launch it with startActivity because the settings operation does not return a result.

Copy linkPrepare the app for deployment

  1. Enable HTTPS in your app.
  2. Keep payload sizes within Android intent limits.
  3. Generate your APK after testing.
  4. Indicate deployment interest to Paystack, complete the preliminary scan, and submit the APK.
  5. 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?