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

# 🔑 API Integration

The **PayKilla API** lets you automate everything you can do from the merchant dashboard:

* generate deposit addresses for your customers;
* track incoming payments and confirmations;
* create invoices and payment links;
* send withdrawals to external wallets;
* convert between supported currencies;
* get real-time balances and transaction history.

This page gives a high-level overview of how the API works and what you need before sending your first request.

### What you can build with the API

Typical use cases:

* **Crypto checkout** – accept payments in crypto and confirm orders automatically.
* **Top-up & internal balance** – let users replenish your in-app balance in crypto.
* **Automated payouts** – pay users, partners or employees from your PayKilla balance.
* **Treasury tools** – monitor all project balances and move funds between wallets.

For UI-level guides, see the merchant dashboard documentation. This section focuses only on the **HTTP API**.

### API design

* **Protocol:** HTTPS, REST-style endpoints.
* **Format:** JSON for both requests and responses.
* **Encoding:** UTF-8.
* **Errors:** returned with an HTTP status code and JSON body with details (see Error handling).

Example response:

```json
{
  "success": true,
  "data": {
    "address": "TQGwVTnXc09hN1qDfDrscbXJH67xbpQaY9",
    "ticker": "USDTTRC20"
  }
}
```