# Listar cobranças PIX

Consulte suas cobranças com paginação.

GET`/payment-pix/list`

Try it

## Parâmetros de consulta

[page](#request-page)integer

Número da página. Padrão 1.

[pageSize](#request-pageSize)integer

Quantidade de itens. Padrão 50, máximo 100.

## Autorização

[X-API-Key](#auth-X-API-Key)stringrequired

Chave VibeCash com permissão para esta operação.

## Resposta

200 application/json

[success](#response-success)booleanrequired

Indica se a operação foi concluída pela API.

[message](#response-message)stringrequired

Mensagem da operação.

[data](#response-data)objectrequired

Dados retornados pela operação.

Show child attributes[items](#response-data-items)array

Itens da consulta.

[total](#response-data-total)integer

Quantidade de itens, quando a rota oferece paginação.

[page](#response-data-page)integer

Página atual.

[pageSize](#response-data-pageSize)integer

Itens por página.

[requestId](#response-requestId)string

Identificador da requisição.

Uma cobrança criada ainda precisa ser paga. O vencimento efetivo só aparece quando informado pelo provedor. Split, emissão fiscal e subcontas não estão habilitados nesta conexão.

## Erros

As falhas retornam o envelope com `success: false`. Consulte [erros e códigos HTTP](/docs/api-reference/guides/errors) para interpretar validação, permissão, conflito e saldo insuficiente.

## Exemplo de requisição

```bash
curl --request GET \
  --url 'https://seu-dominio/v1/payment-pix/list' \
  --header 'X-API-Key: tp_live_SUA_CHAVE'
```

## Exemplo de resposta

```json
{
  "success": true,
  "message": "Operação concluída",
  "data": {
    "items": [
      {
        "id": "pay_exemplo",
        "amount": 5,
        "feeAmount": 0.1,
        "netAmount": 4.9,
        "recipientAmount": 4.9,
        "totalDebit": 0,
        "status": "PENDING",
        "createdAt": "2026-11-10T15:00:00.000Z",
        "copyPaste": "000201...CODIGO_PIX",
        "qrCodeBase64": "data:image/png;base64,..."
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 50,
    "pages": 1
  },
  "requestId": "req_exemplo"
}
```
