> ## Documentation Index
> Fetch the complete documentation index at: https://docs.en.amplopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Overview of the Gateway API

Welcome to the AmploPay API documentation.

The Gateway API lets you integrate payments and financial management into your application, including Pix, boleto, card, and crypto payments, subscriptions, withdrawals, transfers, balance queries, transaction queries, and webhooks.

<Info>
  This documentation covers only the Gateway. The sub/acquirer documentation rendered through Swagger/Scalar is not included here.
</Info>

## Base URL

Use the base URL below for all requests:

```text theme={null}
https://app.amplopay.com/api/v1
```

All requests must use HTTPS.

## REST format

The API follows REST principles and uses standard HTTP status codes to indicate success or failure.

| Code                        | Meaning                          |
| --------------------------- | -------------------------------- |
| `200 OK`                    | Request succeeded                |
| `201 Created`               | Resource created successfully    |
| `400 Bad Request`           | Invalid data or validation error |
| `401 Unauthorized`          | Missing or invalid credentials   |
| `404 Not Found`             | Resource not found               |
| `500 Internal Server Error` | Internal server error            |

## Best practices

* Use webhooks to track status changes.
* Avoid frequent polling on query endpoints.
* Never expose private keys in source code, frontend code, or repositories.
* Use `callbackUrl` per operation when you need specific URLs for notifications.