> For the complete documentation index, see [llms.txt](https://ninjapay.gitbook.io/ninjapay-api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ninjapay.gitbook.io/ninjapay-api-docs/coming-soon/api-reference-pro/error-handling.md).

# Error Handling

### Understanding r**esponse codes**

Ninjapay uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the `2xx`range indicate success, in the `4xx`range indicate an error that failed given the information provided (usually a required parameter was omitted or incorrectly sent), in the `5xx`range indicate an error with Ninjapay's servers.

| Status Code         | Meaning                                                                             | HTTP Response                                |
| ------------------- | ----------------------------------------------------------------------------------- | -------------------------------------------- |
| 200 - OK            | Everything worked as expected                                                       | { data: { ... } }                            |
| 201 - OK            | Entity created with success                                                         | { data: object }                             |
| 400 - Bad Request   | The request was unacceptable, often due to incorrect or missing required parameter. | { success: false, message: 'Error details' } |
| 404 - Not Found     | The requested resource doesn't exist                                                | { success: false, message: 'Error details' } |
| 500 - Server Errors | Something went wrong with Ninjapay's servers                                        | { success: false, message: 'Error details' } |

Our official API libraries raise exceptions when errors are thrown. We recommend writing code that gracefully handles all the possible API exceptions.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ninjapay.gitbook.io/ninjapay-api-docs/coming-soon/api-reference-pro/error-handling.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.