Payments API Errors
This section provides an overview of potential error responses in Orbital Payments API.
Find detailed insights into specific issues within error responses, find exactly what went wrong.
404 Not Found: means that the server couldn't find the requested resource. This happens if the payment or endpoint you're trying to reach doesn't exist or it's returned when the URL is incorrect.
422 Unprocessable Entity: this is returned when the server understood the request, but the data sent is invalid or incomplete. This usually happens if the required fields are missing or the data format is incorrect.
Errors adhere to the sample JSON format below:
{
"status": "fail",
"data": {
"type": "vendor_error",
"title": "Trade was not executed. Try again.",
"status": 400
},
"message": null
}
Below is the definition of the error fields above
status : Represents the status of the executed request
message: Represents the definition of the error in the response
data: Represents an object that describes the error during the transaction execution
type: Represent the type of error
title: Represents a detailed description of the error
status: A numeric value that represents the status code for type of error
Some message definition in error responses with status code 400.
| title | action required |
|---|---|
| Your request parameters didn't validate. | Check and verify all parameters in request are valid. Example: - Check the wallet address is supported by the transaction. - Check target currency and other relevant fields |
| not_supported currency_error | Change “currency” field to support Expected 'ETH' |
| not_supported_target_currency_error invalid targetCurrency | This target currency is not supported. Change it to Expected 'BTC' |
| balance_too_low | Insufficient balance for the transaction. Please fund the MID. |
| duplicate_external_id | A duplicate external ID was found. Change it. |
| missing_cashier_amount_in_request | The cashier amount is missing from this request. Either cashier amount and cashier currency or target amount and target currency are required. |
| payment_not_found_error | The specified payment could not be found. |
| identical_target_and_cashier_currency | Target and cashier currencies are identical. |
| Trade was not executed. Try again | Source Amount does not meet the minimum threshold for transaction |
For assistance, contact Orbital support.