Mobile SDK Error Handling
While utilizing the Payrix Mobile SDK, you may encounter various errors that interrupt your payment acceptance workflow. To better understand what each error means and error handling steps (where applicable), view the tables below to troubleshoot your error.
If you are still experiencing issues after following the error handling suggestions provided, please contact Payrix Support.
Login Errors
Error | Description | Handling Steps |
---|---|---|
“Unexpected Credentials Error” | When user tries to login and username or password is incorrect. | Provide correct username and password. |
“Authentication Failed - No Merchant(s) located for this user.” | When user tries to login, login is successful but the retrieving merchant has any error. | Check if the provided user has merchant associated or not |
“Login Successful” | If Username and password is correct as well as merchant retrieve is success then this message comes | N/A |
“Unexpected Error retrieving Merchant.” | Trying to retrieve a single merchant but having issue | N/A |
“Merchant retrieval successful” | Trying to retrieve a single merchant and success | N/A |
“Payrix Session Time Out - Please Log In” | Failed Request: Session Timed Out | Login Again |
Connect Device Errors
Error | Description | Handling Steps |
---|---|---|
“Scan Timeout” | Doing Scan for BLE devices specially BBPoS and no device fond nearby | Card Reader Error: - Verify Device is On Verify Correct Device is Selected in Settings. Otherwise, Device may be faulty |
“Bluetooth pairing failed with incorrect passkey” |
| N/A |
“Bluetooth pairing error, the reader already paired with another mobile device.” |
| N/A |
“Bluetooth pairing error, the reader has removed this device pairing information. Forget the reader in iOS Settings.” | Trying to connect the OTA reader but it can not connect because of an error. | Go to: |
Transactions Response Errors
Error | Action Message | Info Message |
---|---|---|
| “Card Action Message” | App Should immediately display to user to do that action. |
| “Info Message” | App Should Display the informative message, but not required. |
| “Reserved” | App should Display Field for PIN Entry. |
| “App Selection Needed” | App should Display List of Apps to Display. |
| “Send Final EMV Data” | App should Catch and use EMV Data as desired. |
| “Error Occurred” | App Should Display the error and end processing the transaction. |
| “Transaction Complete” | The transaction ended and the PayResponse object contains the completed transaction data. |
| “Simulation Finished” | Finished a Simulation of App Selection. |
Refund and Transaction History Response Errors
Error | Action Message | Info Message |
---|---|---|
| “Transaction Complete” | Refund Request Completed Successfully |
| “Refund Declined” | Refund Declined by Payrix Platform |
| “Reversal Declined” | Reversal Declined by Payrix Platform |
| “Not Refund Eligible” | The transaction does not meet the criteria for a Refund |
| “Refund Eligible” | The transaction does meet the criteria for a Refund |
| “Invalid Amt Requested” | The amount requested is either zero or greater than amount available |
| “Device RevAuth Failed” | Device Reverse Auth Declined by Payrix Platform |
| “Device RevAuth Success” | Device Reverse Auth Approved |
| “Unexpected Error” | An unexpected error occured |
OTA Errors
Error | Code | Message |
---|---|---|
| N/A | OTA setup error. |
| N/A | OTA update requires battery level at 50% or above. |
| N/A | Device communication error. |
| -> | Server communication error. |
1003 | Sign data was not found because of CMAC or hash invalid. | |
3101 | SDK version too low | |
3102 | API version too old | |
3103 | Target Firmware version too old | |
3104 | SDK version too low - Missing BL/FW Version | |
3201 | Action not permitted: Bulk operation is restricted | |
3202 | Login not match with device | |
3203 | Action not permitted: Set Target operation is restricted | |
3301 | Missing session token / session expired | |
3302 | Session token invalid | |
3303 | Session token info not match | |
3401 | Terminal not found | |
3402 | Key Profile not found | |
3403 | Working Key not found | |
3404 | Key generation failed | |
3405 | Load key failed - Incorrect key profile | |
3406 | Key generation failed - Key block hsm value is null. | |
3406 | Not supported Order Type | |
3407 | Current Firmware version does not support config OTA | |
3408 | Current Key Profile does not compatible with target Firmware | |
3409 | Current Firmware does not compatible with target Key Profile | |
9020 | Data not found | |
0999 | Unknown error | |
| N/A | OTA operation failed. |
| N/A | Remote update has been stopped. |
| N/A | No update is available. |
| N/A | Invalid controller state, the OTA API is busy. |
| N/A | The input firmware hex is not compatible with the device. |
| N/A | The input config hex is not compatible with the device. |
Bluetooth Errors - Android
Error | Code | Description |
---|---|---|
| 3006 |
|
3008 |
| |
3010 |
| |
3011 | Incorrect Bluetooth device type | |
3018 |
| |
3020 | Bond failure | |
User cancel during pairing | ||
Incorrect pairing code | ||
Time-out before entering pairing code | ||
3021 | Cannot discover the BLE service UUID | |
3022 | Cannot get the BLE read characteristic UUID | |
3023 | Cannot get the BLE read characteristic descriptor | |
3024 | Gatt cannot set the BLE write descriptor | |
3025 |
| |
3026 | Fail to get the | |
3027 | Fail to get inputStream after BLE connected | |
3028 | Initialize command no response. | |
3029 |
| |
3036 | Start BLE scan error. | |
3035 | Enable |
Bluetooth Errors - iOS
Error | Description |
---|---|
| Failed to start Bluetooth functions. |
| Bluetooth already connected. |
| Bluetooth pairing error code. |
| Bluetooth pairing failed with incorrect passkey. |
| Bluetooth pairing error, this error will be triggered when a Bluetooth device paired in iPhone A, then try to pair the device in another iPhone B |