Error Schema
| Property | Type | Description |
|---|---|---|
| error_type | string | Broad categorization of the error. Safe for programmatic use. |
| error_code | string | The particular error code. Safe for programmatic use. |
| error_message | string | A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use. |
Connection Errors
Errors related to a particular Connection.
PRODUCT_NOT_READY
Returned when a data request has been made for an endpoint that is not yet ready.
{
"error_type": "CONNECTION_ERROR",
"error_code": "PRODUCT_NOT_READY",
"error_message": "the requested product is not yet ready. please try the request again later",
}
PRODUCT_NOT_ALLOWED
Returned when a data request has been made for an endpoint that has not been activated for your account.
{
"error_type": "CONNECTION_ERROR",
"error_code": "PRODUCT_NOT_ALLOWED",
"error_message": "You do not have access to use this endpoint",
}
INVALID_CREDENTIALS
Returned when a data request has made with an invalid access_token or HTTP Basic Authentication credentials
{
"error_type": "CONNECTION_ERROR",
"error_code": "INVALID_CREDENTIALS",
"error_message": "Invalid credentials to access this connection.",
}
CONNECTION_DISABLED
Returned when a request has been made for a connection that has been temporarily disabled. You may use Fetch a Connection Status to see a list of reasons why a connection is disabled and notify the merchants accordingly.
{
"error_type": "CONNECTION_ERROR",
"error_code": "CONNECTION_DISABLED",
"error_message": "This connection was disabled because of a problem. Please contact support@rutterapi.com for assistance.",
}
NEEDS_UPDATE
Returned when a request has been made for a connection that needs re-authentication.
{
"error_type": "CONNECTION_ERROR",
"error_code": "NEEDS_UPDATE",
"error_message": "The merchant needs to re-authenticate this connection. Please use the update_url value to re-establish the connection.",
}
API Request Errors
MISSING_ACCESS_TOKEN
Returned when a data request has been made without access_token. To obtain access_token, please use Exchange Tokens to exchange your public_token with access_token.
{
"error_type": "INVALID_REQUEST",
"error_code": "MISSING_ACCESS_TOKEN",
"error_message": "Missing access_token in query"
}
INVALID_CURSOR
Returned when a data request has been made with a malformed pagination cursor.
{
"error_type": "INVALID_REQUEST",
"error_code": "INVALID_CURSOR",
"error_message": "Invalid cursor format",
}