> For the complete documentation index, see [llms.txt](https://apidocs.onekeypayments.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.onekeypayments.com/guides/readme.md).

# Welcome to OneKey Payments

We're excited to introduce our **newly redesigned documentation**, built to help you integrate with OneKey Payments more effectively and efficiently.\
Whether you're a onboarding or a long-time merchant, this guide is your central resource for understanding how our platform works.

### How to navigate this Guide

We've structured the guide to follow a logical path from initial setup to advanced features. Based on the main sections in the navigation panel, here’s a quick overview of what you'll find:

* **Getting started**: This is your essential first stop. It covers the basics of starting your onboarding, authentication, environments, and the fundamental concepts you'll need to start making calls.
* **Deposits**: This section covers everything related to receiving payments. You'll find detailed explanations on:
  * Our payment method Coverage and available Solutions.
  * Step-by-step guides to Create deposits and understanding the payment Status flow.
  * Information on Refunding a deposit.
* **Cashouts**: Here you'll learn how to send payouts.&#x20;
  * This section includes guides on Countries validations.
  * How to Create cashouts.
  * And the Status flow for payouts.
* **Platforms Booster**: For our partners offering platform based services, this section details the
  * Onboarding process
  * and how to Manage Submerchants payments

We recommend starting with the <a href="/pages/ym38tpTXOsvSnMAmZ6nz" class="button primary">Getting started</a> section and then moving on to the product you wish to integrate first.

{% hint style="success" %}

#### &#x20;Navigation tips

Through out this site you will find a lot of <a href="/pages/qdVxN6LTNHI3fDD9NZ1T" class="button secondary" data-icon="arrow-pointer">Buttons</a> pointing you to useful resources!
{% endhint %}
