Error codes

All API errors are returned in JSON format. Special attribute "code" contains a code with a business error if there is any. When an error is generic or unexpected this attribute will contain a common code from a table in the next section.

Example:

{
	"status": 400,                                  <--- same with HTTP code
	"timestamp": "2020-02-04T18:08:53.13536+03:00",
	"serviceName": "service-1",
	"code": "BadRequest",                          <--- this is error code
	"details": "Cannot find all required params in JSON req"
}

Generic HTTP codes

Common errors without a link to specific business error:

Code

Description

HTTP code

BadRequest

Problem with request data

400

Unauthorized

Invalid credentials

401

Forbidden

Access to a resource is forbidden

403

NotFound

Resource not found

404

ServiceUnavailable

Problem on backend

503

Unknown

Reserved code for unusual situations

ANY

Generic processing codes

Code

Description

HTTP code

FeatureNotSupported

Requested feature is not supported or disabled

400

UnsupportedNetwork

Provided Network code is not known or network is disabled by a merchant

400

AssetNotSupported

Provided token code is not known or the network is disabled by a merchant

400

InvalidDltAddress

Blockchain address provided has incorrect format

400

TransactionHashNotFound

The transaction hash provided is not found in the blockchain

400

BlockchainNotAvailable

The blockchain network is not available or a timeout on the RPC call occurred

400

BlockchainError

The blockchain interaction has failed for some reason, retry the call

400

InvalidDestination

Merhant wallet smart contract has an invalid address, contact support

400

Invoicing

Code

Description

HTTP code

InvoiceExpiresAtInvalid

The Invoice expire date is invalid

400

InvoiceAmountInvalid

The invoice amount cannot be parsed due to the value or token code error

400

InvoiceDuplicateAmounts

Aux amounts has duplicates values

400

InvoiceAmountNotSupported

Provided token code is not known or the network is disabled by a merchant

400

InvoiceInconsistentAsset

Aux amounts attribute has token codes from the different networks

400

InvoiceNotFound

Invoice not found

400

InvoiceMetadataSizeExceeded

Metadata attribute is too big

400

CompensationDisabled

The gas compensation feature is disabled by a merchant

400

Last updated