> ## 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.
# Referência
> Gere um QRCode Pix e um código copia-e-cola para o seu cliente
## Estrutura
Uma cobrança via QRCode Pix é representada em nossa API pela seguinte estrutura:
```json 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"
}
}
```
## Atributos:
```json json {2} theme={null}
{
"id": "ch_83940c67-4ee2-4087-b484-4e0f101754e2"
}
```
`id` : string.
Identificador único da cobrança.
```json json {2} theme={null}
{
"externalID": "seu id interno" // OU NULL
}
```
`id` : string.
Identificador único da cobrança.
```json json {2} theme={null}
{
"amount": 200
}
```
`amount` : number.
Valor da cobrança em centavos (ex: 200 = R\$ 2,00)
```json json {2} theme={null}
{
"status": "PAID"
}
```
`status` : string.
Status da cobrança. Pode ser `PENDING`, `EXPIRED`, `FAILED`, `PAID`, `REFUNDED`.
| Status | Descrição |
| ---------- | ------------------------------------------------ |
| `PENDING` | **A cobrança está com o pagamento pendente** |
| `EXPIRED` | **O tempo limite de pagamento foi excedido** |
| `FAILED` | **A cobrança teve falha** |
| `PAID` | **A cobrança foi paga com sucesso pelo cliente** |
| `REFUNDED` | **O valor foi devolvido ao cliente** |
```json json {2} theme={null}
{
"brCode": "..."
}
```
`brCode` : string.
Código PIX (copia-e-cola) para pagamento.
```json json {2} theme={null}
{
"brCodeImageUrl": "https://api.aobapay.com/v1/qrcode/ch_abb6bc4f-f55d-45ff-8be2-8fdbde0cb8b8"
}
```
`brCodeBase64` : string.
Código PIX no formato Base64 (útil para exibição em imagens).
```json json {2} theme={null}
{
"fee": 78
}
```
`platformFee` : number.
Taxa da plataforma em centavos. Exemplo: `80` significa R\$ 0,80.
```json json {2} theme={null}
{
"comment": "Pagamento ABC"
}
```
`description` : string.
Comentario da cobrança.
```json json {2} theme={null}
{
"createdAt": "2025-09-22 14:41:20"
}
```
`createdAt` : date-time.
Data e hora da criação da cobrança.
```json json {2} theme={null}
{
"updatedAt": "2025-09-22 14:41:20"
}
```
`updatedAt` : date-time.
Última atualização da cobrança.
```json json {2} theme={null}
{
"expiresAt": "2025-09-22 14:46:20"
}
```
`expiresAt` : date-time.
Data e hora de expiração do QRCode.