Consultar Pix

Consulta um Pix especifico pelo identificador end-to-end ou lista os Pix recebidos em um periodo.

O endToEndId (e2eid) e um identificador unico de 32 caracteres gerado pelo PSP do pagador. Ele e retornado no webhook ou na consulta de cobrancas concluidas.

Consultar Pix por E2EID

GET/pix/{e2eid}

Consulta os detalhes de um Pix recebido especifico pelo seu identificador end-to-end (e2eid).

Base URL: https://api.pix.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2

Parametros de Rota

Nome	Tipo	Descricao
`e2eid`	string	Identificador end-to-end do Pix (32 caracteres)

Exemplo de Response

{
  "endToEndId": "E12345678202501151030abcdef123456",
  "txid": "fc9a43e0b7e14b5a8c3d2f1e0a9b8c7d",
  "valor": "150.00",
  "componentesValor": {
    "original": {
      "valor": "150.00"
    }
  },
  "chave": "sua-chave-pix@example.com",
  "horario": "2025-01-15T10: 35: 22.000Z",
  "infoPagador": "Pagamento referente ao pedido #12345",
  "devolucoes": []
}

Exemplos de Codigo

curl -X GET https://api.pix.basspago.com.br/pix/E12345678202501151030abcdef123456 \
  --cert ./client.crt \
  --key ./client.key \
  -H "Authorization: Bearer {access_token}"

Listar Pix Recebidos

GET/pix

Lista os Pix recebidos dentro do periodo informado. Permite filtrar por txid, CPF ou CNPJ.

Base URL: https://api.pix.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2

Parametros de Query

Nome	Tipo	Obrigatorio	Descricao
`inicio`	string	Obrigatorio	Data/hora de inicio do periodo de consulta (formato RFC 3339, ex: 2025-01-01T00:00:00Z)
`fim`	string	Obrigatorio	Data/hora de fim do periodo de consulta (formato RFC 3339, ex: 2025-01-31T23:59:59Z)
`txid`	string	Opcional	Filtrar por identificador de transacao
`cpf`	string	Opcional	Filtrar por CPF do pagador
`cnpj`	string	Opcional	Filtrar por CNPJ do pagador
`txIdPresente`	boolean	Opcional	Filtra por presenca de txid
`devolucaoPresente`	boolean	Opcional	Filtra por presenca de devolucao
`paginacao.paginaAtual`	integer	Opcional	Pagina atual (default 0)
`paginacao.itensPorPagina`	integer	Opcional	Itens por pagina (1-1000, default 100)

Exemplo de Response

{
  "parametros": {
    "inicio": "2025-01-01T00: 00:00Z",
    "fim": "2025-01-31T23: 59:59Z",
    "paginacao": {
      "paginaAtual": 0,
      "itensPorPagina": 100,
      "quantidadeDePaginas": 1,
      "quantidadeTotalDeItens": 2
    }
  },
  "pix": [
    {
      "endToEndId": "E12345678202501151030abcdef123456",
      "txid": "fc9a43e0b7e14b5a8c3d2f1e0a9b8c7d",
      "valor": "150.00",
      "chave": "sua-chave-pix@example.com",
      "horario": "2025-01-15T10: 35: 22.000Z",
      "infoPagador": "Pagamento referente ao pedido #12345",
      "devolucoes": []
    },
    {
      "endToEndId": "E98765432202501161400fedcba654321",
      "txid": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
      "valor": "75.50",
      "chave": "sua-chave-pix@example.com",
      "horario": "2025-01-16T14: 05: 10.000Z",
      "infoPagador": "Pagamento referente ao pedido #12346",
      "devolucoes": []
    }
  ]
}

Exemplos de Codigo

curl -X GET "https://api.pix.basspago.com.br/pix?inicio=2025-01-01T00:00:00Z&fim=2025-01-31T23:59:59Z" \
  --cert ./client.crt \
  --key ./client.key \
  -H "Authorization: Bearer {access_token}"