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

# Consultar Cobrança

> Retorna os dados completos de uma cobrança

## Descrição

Retorna os dados completos de uma cobrança, incluindo status, dados do pagador, PIX e taxa.

***

## Parâmetros de Path

**id** `string` *required*

UUID da cobrança, devolvido na criação

***

## Headers

**Authorization** `string` *required* (default: Bearer YOUR\_API\_KEY)

Bearer token de autenticação. Formato: `Bearer YOUR_API_KEY`

***

## Exemplo de Requisição

```bash cURL theme={null}
curl https://api.visepag.com/v1/payins/54e2b712-aca0-4230-b69a-d6dd8542c925 \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```javascript Node.js theme={null}
const response = await fetch(
  'https://api.visepag.com/v1/payins/54e2b712-aca0-4230-b69a-d6dd8542c925',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);
const charge = await response.json();
```

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

charge = requests.get(
    'https://api.visepag.com/v1/payins/54e2b712-aca0-4230-b69a-d6dd8542c925',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
).json()
```

***

## Resposta `200 OK`

**id** `string`

UUID da cobrança.

**status** `string`

Status atual: `creating`, `pending`, `paid`, `expired`, `failed` ou `review`.

**method** `string`

Método de pagamento: `pix`.

**amount** `integer`

Valor em centavos.

**platformFee** `integer`

Taxa da VisePag, em centavos.

**description** `string`

Descrição da cobrança.

**customerName** `string`

Nome do pagador.

**customerDocument** `string`

CPF ou CNPJ do pagador.

**customerEmail** `string | null`

E-mail do pagador, ou `null`.

**pixCopy** `string`

Código PIX copia-e-cola.

**pixQrCode** `string | null`

Imagem do QR Code (PNG em base64), ou `null`.

**createdAt** `string`

Data de criação em ISO 8601.

**expiresAt** `string | null`

Data de expiração em ISO 8601, ou `null`.

**paidAt** `string | null`

Data de pagamento em ISO 8601, ou `null`.

**currency** `string`

Sempre `"brl"`.

**livemode** `boolean`

Sempre `true`.

```json 200 theme={null}
{
  "id": "54e2b712-aca0-4230-b69a-d6dd8542c925",
  "status": "paid",
  "method": "pix",
  "amount": 1000,
  "platformFee": 70,
  "description": "Pedido #1234",
  "customerName": "João Silva",
  "customerDocument": "52998224725",
  "customerEmail": "joao@email.com",
  "pixCopy": "00020101021226...",
  "pixQrCode": "data:image/png;base64,iVBORw0KGgo...",
  "createdAt": "2026-03-05T18:14:48Z",
  "paidAt": "2026-03-05T18:16:22Z",
  "expiresAt": "2026-03-06T18:14:48Z",
  "currency": "brl",
  "livemode": true
}
```

***

## Erros

| Status | Código | Descrição |
| - | - | - |
| `404` | `charge_not_found` | Cobrança não encontrada, ou de outra empresa |
| `401` | `missing_authorization` | Header `Authorization` ausente |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.