# API Reference

### Welcome to the OneKey Payments API Reference

This reference provides detailed, technical documentation for every OneKey Payments API endpoint.\
While the API Guide explains the *concepts*, this site is your complete resource for the *specifications* you'll need to code your integration.

Here you will find all the technical information for each of our products, including:

* Crucial **security aspects** and authentication methods.
* A complete list of **endpoints** and their **URLs**.
* Detailed **schemas**, accepted **values**, and **full example requests** and **responses**.
* Guidance on handling **API errors**.

### Exploring the API Reference

When you select an endpoint, it loads in the main panel within an **interactive component**.\
This tool enables you to see every aspect of the API call, including:

* The specific URL and HTTP method.
* All potential request parameters (both required and optional), with details on their data format and accepted values.
* Complete descriptions of successful responses and all potential error responses, along with their data schemas.
* Automatically generated code snippets in various programming languages (like cURL, Python, etc.) that you can copy directly into your project.
* Key information on security and authentication.

Any doubt you may have do not hesitate to contact our Technical Account Management team!