Consultar e Listar

Consultar pagamento por ID

GET /api/v1/payments/{id}

Retorna os dados de uma transação a partir do seu identificador único — o campo id devolvido em Criar pagamento.

Requer autenticação mTLS. Veja Autenticação.

Parâmetros de rota

Parâmetro	Tipo	Obrigatório	Exemplo
`id`	string (uuid)	sim	`8f14e45f-ceea-467e-9a9f-1d1a3c1e5b3a`

`200 OK`

{
  "id": "8f14e45f-ceea-467e-9a9f-1d1a3c1e5b3a",
  "codigo": "0",
  "mensagem": "Transacao autorizada",
  "codigoAutorizacao": "00",
  "mensagemAutorizador": "Transacao aprovada",
  "status": "CON",
  "identicadorPagamentoAdquirente": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2",
  "identificadorPagamento": "PAG-20250723-0001",
  "bandeiraCartao": "1",
  "codigoAdquirente": "1",
  "nomeAdquirente": "Rede",
  "dataAutorizacao": "23/07/2026T14:35",
  "numeroAutorizacao": "123456",
  "merchantUsn": "123456789012",
  "esitefUsn": "123456789012345",
  "sitefUsn": "123456",
  "hostUsn": "123456789012345",
  "valor": 150.00,
  "tipoPagamento": "C",
  "emissor": "VISA",
  "authorizerMerchantId": "0001234567",
  "terminalId": "12345678",
  "dataPagamento": "23/07/2026T14:35",
  "parcelas": [
    {
      "id": "3f2a1b4c-5d6e-4f70-8a91-b2c3d4e5f607",
      "transacaoCartaoId": "8f14e45f-ceea-467e-9a9f-1d1a3c1e5b3a",
      "numeroParcela": 1,
      "valorParcela": 50.00,
      "dataVencimento": "2026-08-23"
    },
    {
      "id": "4a3b2c1d-6e5f-4a70-9b81-c2d3e4f5a607",
      "transacaoCartaoId": "8f14e45f-ceea-467e-9a9f-1d1a3c1e5b3a",
      "numeroParcela": 2,
      "valorParcela": 50.00,
      "dataVencimento": "2026-09-23"
    },
    {
      "id": "5b4c3d2e-7f6a-4b80-8c91-d3e4f5a6b708",
      "transacaoCartaoId": "8f14e45f-ceea-467e-9a9f-1d1a3c1e5b3a",
      "numeroParcela": 3,
      "valorParcela": 50.00,
      "dataVencimento": "2026-10-23"
    }
  ]
}

Campos do pagamento

Campo	Tipo	Descrição
`id`	string (uuid)	Identificador da transação
`codigo`	string	Código de resposta. Diferente de `0` significa falha
`mensagem`	string	Mensagem de resposta. Diferente de `Transacao autorizada` significa falha
`codigoAutorizacao`	string	Código de resposta do autorizador
`mensagemAutorizador`	string	Mensagem de resposta do autorizador
`status`	enum	Status da transação — ver Status de transação
`identicadorPagamentoAdquirente`	string	Identificador da transação na adquirente (nit)
`identificadorPagamento`	string	Código de pedido enviado na criação (order_id)
`cupomCliente`	string	Cupom fiscal via cliente (customer_receipt)
`cupomEstabelecimento`	string	Cupom fiscal via estabelecimento (merchant_receipt)
`merchantAdviceCode`	string	Advice code retornado em caso de recusa — ação recomendada pelo autorizador/bandeira
`bandeiraCartao`	string	Código da bandeira utilizada na transação
`codigoAdquirente`	string	Código da adquirente (acquirer_id)
`nomeAdquirente`	string	Nome da adquirente (acquirer_name)
`dataAutorizacao`	string	Data retornada pelo autorizador, `DD/MM/AAAA'T'HH:mm`
`numeroAutorizacao`	string	Número de autorização da transação
`merchantUsn`	string	Número sequencial único enviado pela loja
`esitefUsn`	string	Número sequencial único da transação no e-SiTef
`sitefUsn`	string	Número sequencial único da transação no SiTef
`hostUsn`	string	NSU da autorizadora (host_usn)
`valor`	number	Valor da transação
`tipoPagamento`	enum	`B` boleto, `C` crédito, `D` débito, `P` private label, `T` transferência, `G` gift, `O` outros, `W` boleto NR
`emissor`	string	Código da bandeira retornado pelo autorizador (issuer)
`authorizerMerchantId`	string	Código de afiliação do lojista na autorizadora
`terminalId`	string	Código do terminal utilizado na transação
`dataPagamento`	string	Data de efetivação no formato `DD/MM/AAAA'T'HH:mm`
`recorrenciaId`	string	TID da bandeira da primeira transação da recorrência. Só retornado em recorrências
`parcelas`	array	Parcelas geradas para a transação

Campos de `parcelas[]`

Campo	Tipo	Descrição
`id`	string (uuid)	Identificador da parcela
`transacaoCartaoId`	string (uuid)	Identificador da transação a que a parcela pertence
`numeroParcela`	integer	Número da parcela na sequência
`valorParcela`	number	Valor da parcela
`dataVencimento`	string (date)	Data de vencimento da parcela

Erros: 401 não autorizado · 404 pagamento não encontrado · 500 erro interno.

Listar pagamentos

GET /api/v1/payments

Retorna uma lista paginada de todas as transações de pagamento cadastradas.

Query params

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
`page`	integer	não	`0`	Página desejada, começando em `0`
`size`	integer	não	`20`	Quantidade de itens por página (mínimo `1`)
`sort`	array	não	`dataPagamento,desc`	Campo e direção de ordenação; pode repetir

`200 OK`

{
  "content": [
    {
      "id": "8f14e45f-ceea-467e-9a9f-1d1a3c1e5b3a",
      "codigo": "0",
      "mensagem": "Transacao autorizada",
      "codigoAutorizacao": "00",
      "mensagemAutorizador": "Transacao aprovada",
      "status": "CON",
      "identicadorPagamentoAdquirente": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2",
      "identificadorPagamento": "PAG-20250723-0001",
      "bandeiraCartao": "1",
      "codigoAdquirente": "1",
      "nomeAdquirente": "Rede",
      "dataAutorizacao": "23/07/2026T14:35",
      "numeroAutorizacao": "123456",
      "merchantUsn": "123456789012",
      "esitefUsn": "123456789012345",
      "sitefUsn": "123456",
      "hostUsn": "123456789012345",
      "valor": 150.00,
      "tipoPagamento": "C",
      "emissor": "VISA",
      "authorizerMerchantId": "0001234567",
      "terminalId": "12345678",
      "dataPagamento": "23/07/2026T14:35",
      "parcelas": [
        {
          "id": "3f2a1b4c-5d6e-4f70-8a91-b2c3d4e5f607",
          "transacaoCartaoId": "8f14e45f-ceea-467e-9a9f-1d1a3c1e5b3a",
          "numeroParcela": 1,
          "valorParcela": 50.00,
          "dataVencimento": "2026-08-23"
        }
      ]
    }
  ],
  "number": 0,
  "size": 20,
  "numberOfElements": 1,
  "totalElements": 1,
  "totalPages": 1,
  "first": true,
  "last": true,
  "empty": false
}

Cada item de content é um pagamento com os campos descritos em Campos do pagamento, acima.

Campos da paginação

Campo	Tipo	Descrição
`content`	array	Pagamentos da página atual
`number`	integer	Índice da página atual (base `0`)
`size`	integer	Tamanho da página solicitado
`numberOfElements`	integer	Quantidade de itens na página atual
`totalElements`	integer	Total de pagamentos encontrados
`totalPages`	integer	Total de páginas
`first` / `last`	boolean	Indicam se é a primeira / última página
`empty`	boolean	Indica se a página não possui itens

Erros: 401 não autorizado · 500 erro interno.

Consultar e Listar

On this page