Errors

API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a transaction failed, etc.). Codes in the 5xx range indicate an error with backend servers (these are rare).

Some 4xx errors that could be handled programmatically (e.g., an invalid account number) include an error code that briefly explains the error reported.

HTTP status code summary

HTTP Status Code	Description
200	Everything worked as expected.
201	A new resource was created.
400	The request was unacceptable, often due to missing a required parameter.
401	No valid authentication headers were present.
402	The parameters were valid but the request failed.
403	You are not allowed to access this resource.
404	The requested resource doesn’t exist.
405	The request method is not allowed for invoked endpoint.
500	Something went wrong on server end. (These are rare.)

Error Types

Type	Description
api_error	API errors cover any other type of problem (e.g., a temporary problem with backend or 3rd Party’s servers), and are extremely uncommon.
authentication_error	Failure to properly authenticate yourself in the request.
two_factor_authentication_error	User is not two factor authenticated.
authorization_error	Trying to access restricted resource.
invalid_request_error	This arise when your request has invalid parameters.

Handling Errors

Our API raise exceptions for many reasons, such as a failed transfer, invalid parameters, authentication errors, and network unavailability. We recommend writing code that gracefully handles all possible API exceptions.

Attribute	Description
code	For some errors that could be handled programmatically. A short string indicating the error code reported. See Error Codes section.
message	A human-readable message providing more details about the error.
param	If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

Error Codes

Some 4xx errors that could be handled programmatically (e.g., request contains invalid parameter) include an error code—a short string with a brief explanation—as a value for code. Below is a list of possible error codes that can be returned.

Code	Description
_required	One or more required parameters are missing.
_empty	One or more required fields contain empty value.
_invalid	One or more required values are invalid.
unique	The parameter has failed unique constraint check.
_missingHeader	One or more required headers are missing or empty.
not_found	Resource could not be found.
_sameAsCurrentPassword	New password is same as current password.
_invalidConfirmPassword	Password and confirm password do not match.
not_found	Resource could not be found.