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

# Introduction

> Welcome to WEpayments API - Your complete payment integration guide

## Environments

Our API is available in two independent environments: **Sandbox (Test)** and **Production (Real)**, below we will explain details about each of them.

### Sandbox (Testing Environment):

The sandbox environment is a space where you can test and validate API integration before starting real operations. The APIs available are identical to those in production, but some custom variables may differ, such as the go-live date for new features. We use this environment to launch new features early, giving you sufficient time to prepare for production.

**API**: [https://api.sandbox.wepayout.com.br](https://api.sandbox.wepayout.com.br)\
**Dashboard URL**: [https://app.sandbox.wepayout.co](https://app.sandbox.wepayout.co)

### Production (Real Environment):

The production environment is where you will make actual payments (payout) and charges (payin). Unlike the sandbox environment, all payments here are real and will be processed accordingly.

**API**: [https://api.wepayout.com.br](https://api.wepayout.com.br)\
**Dashboard URL**: [https://app.wepayout.co/](https://app.wepayout.co/)

## Authentication

<Tip>
  **Tutorial**: Follow this step-by-step guide to create your API key: [How to create an API key in the WEpayments system](https://support.wepayments.com.br/support/legal/api-authentication)
</Tip>

### Important information:

* The API-Key must be included in the authorization header as an RFC 6750 Bearer Token.
* For the API-Key to work in production, you must provide the IP addresses of your server.
* Your API-Key carries many privileges, so make sure to keep it secret! Do not include it in URLs or expose it on the front end of your application.
* The API-Key is unique for each environment, so you will have one in Sandbox and a different one in production.

| INFORMATION                   | DATA      |
| ----------------------------- | --------- |
| **Security Scheme Type**      | HTTP      |
| **HTTP Authorization Scheme** | bearer    |
| **Bearer Format**             | "API-Key" |

## Quick Navigation

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/authentication">
    Learn how to authenticate your API requests
  </Card>

  <Card title="Webhook Signature" icon="webhook" href="/concepts/webhooks">
    Learn how to verify webhook signatures
  </Card>

  <Card title="Going to Production" icon="rocket-launch" href="/going-to-production">
    Checklist for launching your integration
  </Card>

  <Card title="KYC" icon="user-check" href="/api-reference/kyc/list-kyc">
    Know Your Customer verification
  </Card>
</CardGroup>

## Integration Steps

<Steps>
  <Step title="Get Your API Keys">
    Follow the [tutorial](https://support.wepayments.com.br/support/legal/api-authentication) to create your API key in the WEpayments system.
  </Step>

  <Step title="Set Up Authentication">
    Configure your application to authenticate API requests using your API key as a Bearer token
  </Step>

  <Step title="Test in Sandbox">
    Use our sandbox environment to test your integration without processing real payments
  </Step>

  <Step title="Implement Webhooks">
    Set up webhook endpoints and verify signatures to receive real-time notifications
  </Step>

  <Step title="Go Live">
    Provide your production IP addresses and start accepting real payments
  </Step>
</Steps>

## API Basics

### Base URLs

**Sandbox**:

```
https://api.sandbox.wepayout.com.br
```

**Production**:

```
https://api.wepayout.com.br
```

### Authentication

All API requests require authentication using a Bearer token:

```bash theme={null}
Authorization: Bearer YOUR_API_KEY
```

### Request Format

All requests should use JSON format:

```bash theme={null}
Content-Type: application/json
```

## Your First API Call

Let's make a simple request to verify your setup:

<CodeGroup>
  ```bash cURL - Sandbox theme={null}
  curl https://api.sandbox.wepayout.com.br/v1/account/balance \
    -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
    -H "Content-Type: application/json"
  ```

  ```bash cURL - Production theme={null}
  curl https://api.wepayout.com.br/v1/account/balance \
    -H "Authorization: Bearer YOUR_PRODUCTION_API_KEY" \
    -H "Content-Type: application/json"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.sandbox.wepayout.com.br/v1/account/balance', {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  headers = {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
  }

  response = requests.get('https://api.sandbox.wepayout.com.br/v1/account/balance', headers=headers)
  print(response.json())
  ```
</CodeGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="Create Charge" icon="plus" href="/api-reference/cash-in/payin/create-charge">
    Start accepting payments (Payin)
  </Card>

  <Card title="Create Payment" icon="money-bill-transfer" href="/api-reference/cash-out/payout/create-payment">
    Make payouts (Payout)
  </Card>

  <Card title="List Banks" icon="building-columns" href="/api-reference/banks/list-institutions">
    Get list of supported banks
  </Card>

  <Card title="Account Balance" icon="wallet" href="/api-reference/account/get-balance">
    Check your account balance
  </Card>
</CardGroup>

## Need Help?

**24/7 Support Team**: Our Support, Performance & CX team is available for operational and technical assistance.

* 📚 **Help Center**: Access articles on panel usage, transactions, payments, withdrawals, reports, and more. [Visit Help Center](https://support.wepayments.com.br/)
* 💬 **Chat**: Click the chat icon in the bottom-right corner of any Help Center page
* 📱 **WhatsApp**: [+55 41 9266-7191](https://wa.me/5541926677191)
* 📧 **E-mail**: [cs@wepayments.com.br](mailto:cs@wepayments.com.br)

<Note>
  **Important**: Always start with the Sandbox environment to test your integration. Remember that API keys are unique for each environment.
</Note>