You are here: API Foundations > Error Handling

Error Handling

Exceptions are handled using fault elements and the Error object. Although the term "error" refers to anything that goes wrong, we make a finer distinction between errors and faults.

An error is a problem that occurs when some part of the call failed, but not all of it. In these cases, some processing is done, and error codes are returned indicating what didn't work.
A fault is a call-level problem; when a fault occurs, nothing is processed because the entire call was invalid.

Errors are handled as follows:

If any of the parameters are invalid, appropriate fault codes will be returned, along with the field names resulting in the fault. For example, if a required field was not passed, the field name along with the required field code will be returned. Another examples: If a string value does not match a value defined in the system, such as the payment term string, an error is returned.
If credit card processing fails, a separate fault is returned, indicating that there was a credit card processing failure and providing the details of the failure.

Errors

Faults

Open topic with navigation