Pagamentos

Listar

Listar pagamentos Pix iniciados e confirmados

Consulta os pagamentos Pix no contexto da conta autenticada. A resposta é paginada: array pagamentos + metadados de página.

Endpoint

GET /api/v2/pix/pagamentos

Scope: pix.read

Headers

HeaderObrigatórioDescrição
AuthorizationSimBearer {{access_token}}
AcceptSimapplication/json

Envelope da resposta (200)

CampoTipoDescrição
pagamentosarrayLista de pagamentos (PagamentoResource)
correlationIdstringID de correlação da requisição
currentPageintegerPágina atual
lastPageintegerÚltima página
perPageintegerItens por página
fromintegerÍndice do primeiro item da página
tointegerÍndice do último item da página
totalintegerTotal de registros

Item em pagamentos

Mesmo resource da iniciação/confirmação, com campos de erro quando aplicável:

CampoTipoDescrição
idUUIDIdentificador do pagamento
endToEndIdstring | omitidoEnd-to-end
chavestring | omitidoChave Pix do recebedor
valornumberValor
txidstringConciliação
erro_codigostring | omitidoCódigo de erro (quando houver falha)
erro_descricaostring | omitidoDescrição do erro
statusstring"0" INICIADO · "9" CONFIRMADO · "-1" ERRO
tipointeger0 manu · 1 dict · 2 qres · 3 qrdn · 8 paut
id_reqstring | nullID no PSP (após confirmação)
recebedor / pagadorobject | arrayPessoas/contas; na listagem podem vir como []
dataHoraCriacao / dataHoraAtualizacaodatetimeISO 8601
tipo_transacaointeger-1 débito (cash-out) · 1 crédito (contraparte / espelho)
rec_statusstring | nullPix Automático, quando aplicável

Exemplo (resumo)

{
  "pagamentos": [
    {
      "id": "38cdf7dc-1af9-4536-be5c-4f3263eee3c9",
      "endToEndId": "E38297374202606291452SRRBZF9DR3X",
      "chave": "51e09faa-ca26-4c24-81f5-7518197648d4",
      "valor": 2.22,
      "txid": "15lmIhGUAZoXfPn3pNBLCEzc9e",
      "erro_codigo": "000",
      "erro_descricao": "Ocorreu um erro inesperado ao efetuar transferencia.",
      "status": "-1",
      "tipo": 3,
      "id_req": null,
      "recebedor": [],
      "pagador": [],
      "dataHoraAtualizacao": "2026-06-29T18:15:06.000000Z",
      "dataHoraCriacao": "2026-06-29T14:52:46.000000Z",
      "tipo_transacao": -1,
      "rec_status": null
    },
    {
      "id": "ce8cd106-b413-45d3-9835-6cc701176088",
      "endToEndId": "E3829737420260629145447088689815",
      "chave": "51e09faa-ca26-4c24-81f5-7518197648d4",
      "valor": 2.22,
      "txid": "15lmIhGUAZoXfPn3pNBLCEzc9e",
      "status": "9",
      "tipo": 3,
      "id_req": "71de3c09-8be0-48b2-883a-d6b0a31ce0ae",
      "recebedor": [],
      "pagador": [],
      "dataHoraAtualizacao": "2026-06-29T14:54:47.000000Z",
      "dataHoraCriacao": "2026-06-29T14:54:45.000000Z",
      "tipo_transacao": -1,
      "rec_status": null
    }
  ],
  "correlationId": "ca387ccd-4904-4eb0-8b5e-c304776b6592",
  "currentPage": 1,
  "lastPage": 6,
  "perPage": 10,
  "from": 1,
  "to": 10,
  "total": 55
}

Exemplo de requisição

curl --location 'https://api-h.nuvende.com.br/api/v2/pix/pagamentos' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}'

Próximos passos

2025 © Nuvende - CNPJ 38.297.374/0001-93