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

# Comece aqui

> Veja como é simples integrar com a gente 🚀

# Bem-vindo à API AobaPay

Aqui você encontra tudo o que precisa para integrar de forma rápida, simples e segura.

***

## <Icon icon="Share" type="solid" /> Quem somos

A **AobaPay** nasceu da nossa necessidade de simplificar cobranças.
Percebemos que muitos gateways do mercado são cheios de barreiras:

* Documentações extensas e pouco objetivas
* Diversas formas diferentes de executar a mesma operação
* Até exigência de treinamentos para conseguir integrar

Com a AobaPay, eliminamos essa complexidade. Nossa proposta é transformar a burocracia dos meios de pagamento em uma API clara e intuitiva.

### Exemplo rápido

```php theme={null}
<?php

use AobaPay\Client\Client;

$payment = (new Client($_ENV('AOBAPAY_API')))
    ->charge()
    ->create(
        amount: 200
    );
```

***

## <Icon icon="laptop" type="solid" /> API descomplicada

Nossa API segue dois princípios:

1. **Idempotência**
   A mesma requisição pode ser executada várias vezes sem efeitos colaterais.

   ```php theme={null}
   $payment->charge()->create(...);
   ```

2. **Consistência**
   Todas as respostas seguem um padrão único: erro ou dados de retorno.
   Isso facilita a integração em linguagens fortemente tipadas e simplifica o tratamento de respostas.

   ```json theme={null}
    {
        "error": null,
        "status": 200,
        "data": {
            "id": "ch_83940c67-4ee2-4087-b484-4e0f101754e2",
            "externalID": "pedido-123",
            "brCode": "00020001021226810014br.gov.bcb.pix255..",
            "brCodeImageUrl": "https://api.aobapay.com/v1/qrcode/ch_abb6bc4f-f55d-45ff-8be2-8fdbde0cb8b8",
            "amount": 200,
            "comment": "Pagamento abc",
            "expiration": 300,
            "fee": 78,
            "expiresAt": "2025-09-22 14:46:20",
            "status": "PENDING",
            "customer": {
                "id": "cus_3d4c48ff-291c-4266-a1ee-ba523479d886",
                "name": "Brendo",
                "document": "123.456.789-01",
                "email": "brendo@aobapay.com",
                "phone": "15997886622"
            },
            "createdAt": "2025-09-22 14:41:20",
            "updatedAt": "2025-09-22 14:41:20"
        }
    }
   ```

***

## <Icon icon="cloud" type="solid" /> Suporte

Ficou com dúvidas? Nossa equipe está pronta para ajudar:

<Icon icon="envelope" type="solid" /> [contato@aobapay.com](mailto:contato@aobapay.com)