# About Reefpay APIs

## What the API provides

The Reefpay API gives you programmatic access to every capability of the platform.

* **Payments**: Create sales, authorizations, captures, voids, and refunds for credit cards and bank accounts.
* **Tokenization**: Store and manage payment methods securely.
* **Account management**: Create and manage clients, integrations (processor connections), and persons.
* **Reporting**: Query transactions, list batches, and export settlement data.
* **Security**: Retrieve encryption keys, manage passwords, and verify multi-factor authentication challenges.


All endpoints live under a single base URL and use a consistent request/response format.

| Environment | Base URL |
|  --- | --- |
| Sandbox | `https://api.dev.paradisegateway.net` |
| Production | `https://api.paradisegateway.net` |


## How the API is organized

The API is organized around resources. Each resource has a predictable URL pattern and supports standard HTTP methods.

| Resource | Base path | Operations |
|  --- | --- | --- |
| Authentication | `/v1/auth/keys` | Retrieve API key and encryption keys |
| Transactions | `/v1/transactions` | Create, list, retrieve, update, capture, cancel |
| Payment tokens | `/v1/payment_tokens` | Create, list, retrieve, update, delete |
| Clients | `/v1/clients` | Create, list, retrieve, update, delete |
| Integrations | `/v1/integrations` | Create, list, retrieve, update, delete |
| Users | `/v1/users` | Create, list, retrieve, update, delete |
| Batches | `/v1/batches` | List batches, update batch status |
| MFA | `/v1/mfa` | Create challenges, verify codes |
| Passwords | `/v1/users/me/passwords` | Change password |


## Authentication overview

The API uses an API key for authentication. Include the API key in the `APIKEY` header.

## Further reading

* [Quickstart](/docs/get-started/quickstart)
* [About Reefpay](/docs/get-started)
* [About best practices for integration](/docs/get-started/integration-best-practices)