FAQ
Configuration
What are public keys and private keys ?
You can create the keys using the Security section, public keys are the keys that you are going to share with us and private keys are going to be used in generating the JWT to communicate with StreamPay when using any function like purchase, refund, etc.
Which package name should I share ?
You need to share the package name for the Android project with the StreamPay team
How can I change the environment ?
You can define the environment in StreamPay project
val streampay = StreamPay(this, jwt, Locale.getDefault(), Environments.SANDBOX)What are the different environments ?
We have three main environments:
SandBox : where you integrate the SDK on Sandbox Environment.
Testing : we will test your app with Payment and get it approved
Production: here you can go live.
What are the requirements to run SDK on Android ?
You need to have an NFC on your device.
You need to allow location
Login
What is JWT ?
JSON Web Tokens are an open, industry-standard RFC 7519 method for representing claims securely between two parties.
How can I get the client UUID?
StreamPay Team will send you a client UUID once we have received the public key and the android package name.
When do I need to logout ?
When StreamPay service is no longer needed.
For example, when the users log out from your app, they need to log out from StreamPay service as well so they can not use the service when they are logged out.
Transactions
What is reconciliation ?
Payment reconciliation is an accounting process that verifies account balances to ensure all sets of records are true, consistent, and up-to-date. Businesses can reconcile their accounts daily, weekly, or monthly.
What is a customer reference number ?
A customer reference number is a number that identifies your customer ID, so you can assign any number you want as a customer reference number, also it is optional so you can leave it empty if you wish.
You can use the customer reference number in Purchase and Refund.
How can I make a purchase ?
You can just call purchase and our StreamPOS UI will show up to make a payment.
How can I disable the UI of the receipt ?
We have a feature to enable or disable the receipt UI and all our functions, just set enableReceiptUi to false.
Where can I see my transactions ?
You can see all transactions in the client dashboard, and also you can list them using the API here
How can I get the reconciliation data ?
You can get all the reconciliation data when you make a reconciliation we will return all the data, you can find it here.
How can I know the version of the payment plugin ?
Go to Settings - > Apps - > Payment Plugin -> Version
When should the developer mode be turned off?
Whenever the SDK environment is in production, if the developer mode is not off then you can not communicate with StreamPay to make any transactions.
Can the user refund more than the paid amount in the transaction?
Yes since the terminal is not connected to any device.
Can the user issue more than one refund per transaction?
No, the user can not exceed the paid amount.
What's the difference between Refund and Reverse
Refund, you can do it anytime, also you can do a partial refund and you can do it more than once.
Reverse, it can be done only after the purchase within 60 seconds, and the whole amount will be reversed.
TRSMs and POS Terminals
How can I create terminals?
There are two ways to create a terminal :
Client Dashboard Go to the TRSMs page and create a new one then create a new merchant, now you can go to terminals and create new terminals.
Use create terminal API here.
Can I disconnect the terminal and link it to another device?
Yes since the terminal is not connected to any device.
Can I connect one terminal to two devices at the same time?
No, only one terminal can connect to one device at the same time.
How do I assign a terminal to my merchant?
Your backend can return JSON Web Token based on the user, so every token will contain a different terminal ID. For more information, you can see how the JWT can be generated here.
For example, every user in your app will have a terminal id linked to that user, so when the user login to your app, your backend will send JWT for that user to login to our StreamPOS SDK.
Figure 1.0
Last updated