Skip to content

Synqpay Errors

General

You may encounter various errors when interacting with the device. The following errors were returned from the device. This means the device successfully received the JSON-RPC request but encountered an issue processing it. Causes might include invalid parameters, a method not found, or execution errors related to the requested operation.

The error object contains information on an error when the client tries to request a resource, and an error occurs while trying to process the request. For example: 

1
2
3
4
5
6
7
8
{
    "jsonrpc": "2.0",
    "id": "1234",
    "error": {
        "code": 102,
        "message": "payment method is missing"
    }
}

The 'error' object has the following attributes:

  • code int
    The error code relating to the incident

  • message string
    The error message relating to the incident

  • data var
    Additional info regarding the thrown error. This value is populated only if supported by a specific error. The data type of data is specified per error.

JSON-RPC Errors

The following errors are JSON-RPC reserved errors that were implemented in Synqpay. Those errors shouldn't be returned while on production.

code Description
-32700 Parse Error - The JSON or JSON-RPC request is invalid; this can be due to syntax errors.
-32600 Invalid request - probably parameter structure
-32601 Method not found

Application Errors

Each method document specifies the reason for the returned error.

GeneralError (100)

data: null

Internal Error occurred

How to recover

Contact developer center support and make sure logs are uploaded

IllegalRequest (101)

data: string

An illegal request was made. Each IllegalRequest will include the reason in the error data field. The enum in data specifies the error reason, as defined in the request throwing the error.

How to recover

Check your device configuration.

MissingParam (102)

data: null

One of the REQUIRED parameters is missing. This error shouldn't be returned while in production.

How to recover

Check parameter properties.

InvalidParam (103)

data: null

When a parameter is supplied and does not meet the expected type/length / accepted characters or value. This error shouldn't be returned while in production.

How to recover

Check parameter properties.

IllegalState (201)

data: null

Illegal state during the request

How to recover

Use getStatus to check on the device status and see what the current state is; the client can also poll for the state

ScreenNotReady (202)

data: null

The device is not on an idle screen and can't process the request.

How to recover

Ensure the device is turned on and the application Idle screen is in the foreground.

InsufficientBattery (203)

data: null

This error indicates that the device's battery level is too low to perform the requested operation.

How to recover

Connect the device to a power source and ensure the battery is sufficiently charged before retrying the operation.

PaymentMethodDisabled (300)

data: null

The specified payment method is disabled.

How to recover

Check your device configuration.

HostNotReady (301)

data: null

The host is not ready to execute a transaction.

How to recover

Perform a settlement to update the host parameters

TransactionNotFound (302)

data: null

The queried or referred transaction wasn't found on the device.

How to recover

Check the value of the lookup.

TransactionAlreadyExist (303)

data: null

Usually, when requesting a new transaction with a referenceId that already exists on the device

How to recover

Use getTransaction to query for the transaction, or if this is a new transaction, generate a new referenceId

IllegalTransactionStatus (304)

data: null

When requesting an operation on an existing transaction (Void or Capture), the original transaction is not in the correct status.

How to recover

Use getTransaction to query for the original transaction and check its current status.

HostDisabled (401)

data: null

The specified host is disabled.

How to recover

Check your device configuration.

SettlementNotFound (401)

data: null

The queried settlement wasn't found on the device.

How to recover

Check the value of the lookup.