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

# API Overview

This guide provides an introduction to WEpayments APIs, including available endpoints, authentication methods, and environment information for developers integrating with the platform.

## What can you do with WEpayments APIs?

WEpayments APIs enable you to integrate your system directly with our payment platform, automating operations without manual Dashboard access.

| **Operation**            | **What you can do**                                                                   |
| :----------------------- | :------------------------------------------------------------------------------------ |
| **Payin (receiving)**    | Create charges via PIX, boleto, and credit card; check charge status; request refunds |
| **Payout (sending)**     | Create single or mass payments; check payment status; validate beneficiary data       |
| **Statements & Reports** | Retrieve balance information; download transaction statements; reconcile operations   |
| **KYC & Compliance**     | Submit documents; check compliance status; request Smart User Limits                  |
| **Data Collect**         | Generate self-onboarding links for beneficiaries; validate PIX keys                   |
| **Settlements**          | Request withdrawals; transfer balance between wallets                                 |

## API authentication overview

WEpayments APIs use **API keys** for authentication.

| **Aspect**                    | **Details**                                 |
| :---------------------------- | :------------------------------------------ |
| **Authentication method**     | API key (bearer token)                      |
| **Key generation**            | Via Dashboard (Settings > Access Control)   |
| **IP whitelisting**           | Required – only allowed IPs can use the key |
| **Two-factor authentication** | Required to generate and delete API keys    |

> 💡 API keys are generated per user. Each key inherits the permissions assigned to that user.

## API environments

| **Environment** | **Purpose**             | **Base URL**                    |
| :-------------- | :---------------------- | :------------------------------ |
| **Sandbox**     | Testing and development | Contact support for sandbox URL |
| **Production**  | Live operations         | Provided during onboarding      |

> 💡 We recommend testing all integrations in the sandbox environment before moving to production.

## Available API endpoints (overview)

| **Category**     | **Example endpoints**                                           |
| :--------------- | :-------------------------------------------------------------- |
| **Payin**        | Create charge, get charge status, cancel charge, request refund |
| **Payout**       | Create payment, get payment status, validate beneficiary        |
| **Data Collect** | Create collection request, get status, validate PIX key         |
| **Statements**   | Get balance, get statement, download reports                    |
| **Compliance**   | Submit KYC documents, check request status                      |
| **Settlements**  | Create settlement, get settlement status                        |

> 💡 For complete API documentation, including request/response examples and error codes, please refer to our **API Documentation** (separate document).

## Rate limits

| **Limit**               | **Description**                                     |
| :---------------------- | :-------------------------------------------------- |
| **Requests per second** | Contact support for your contract-specific limits   |
| **Bulk operations**     | Mass payments are supported with appropriate limits |

## Best practices for API integration

| **Practice**                     | **Why it helps**                                                        |
| :------------------------------- | :---------------------------------------------------------------------- |
| **Use a dedicated API user**     | Create a specific user for API integration, not shared with human users |
| **Store API keys securely**      | Keys are only shown once – store them in a secure vault                 |
| **Whitelist only necessary IPs** | Minimizes security risks                                                |
| **Test in sandbox first**        | Validate integration before going live                                  |
| **Handle errors gracefully**     | Implement retry logic for transient failures                            |
| **Monitor API usage**            | Track usage to avoid hitting limits                                     |

## Error handling

| **HTTP Status** | **Description**   | **What to do**                    |
| :-------------- | :---------------- | :-------------------------------- |
| **200**         | Success           | Process response normally         |
| **400**         | Bad request       | Check request parameters          |
| **401**         | Unauthorized      | Check API key and IP whitelist    |
| **403**         | Forbidden         | Check user permissions            |
| **404**         | Not found         | Verify endpoint URL               |
| **429**         | Too many requests | Implement rate limiting / backoff |
| **500**         | Server error      | Retry with exponential backoff    |

## Support and resources

| **Resource**            | **Where to find**                                                     |
| :---------------------- | :-------------------------------------------------------------------- |
| **API Documentation**   | Provided during onboarding / upon request                             |
| **Sandbox environment** | Contact support for access                                            |
| **Technical support**   | [cs@wepayments.com.br](mailto:cs@wepayments.com.br) or Dashboard chat |