Consultar e Listar

Consultar link

GET /api/v1/link-payment/{linkPaymentUuid}

Retorna um link de pagamento pelo seu UUID.

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

Parâmetro	Tipo	Exemplo
`linkPaymentUuid`	string	`a1b2c3d4-e5f6-7890-abcd-ef1234567890`

`200 OK`

Exemplo de link já pago com cartão:

{
  "linkPaymentId": 1001,
  "linkPaymentUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "clienteId": 3001,
  "nomePagador": "Joao da Silva",
  "numeroInscricao": "12345678900",
  "isEstrangeiro": false,
  "valor": 150.75,
  "numeroParcelas": 3,
  "status": { "code": 3, "description": "PAID" },
  "urlPagamento": "https://pagamento.exemplo.com/link/a1b2c3d4",
  "descricao": "Pagamento referente a mensalidade de julho",
  "tokenVerificacao": 482913,
  "opcoesParcelamento": [
    { "numberInstallments": 1, "amountInstallment": 150.75 },
    { "numberInstallments": 2, "amountInstallment": 75.38 },
    { "numberInstallments": 3, "amountInstallment": 50.25 }
  ],
  "userReference": "PEDIDO-2026-0001",
  "comprovantePagamento": "https://pagamento.exemplo.com/comprovante/9988",
  "identificadorTransacao": "TXN-2026-998877",
  "metodoPagamento": { "code": 1, "description": "Cartão de Crédito" },
  "dataCriacao": "2026-08-01T14:30:00",
  "metodosPagamentoAceitos": [
    { "code": 1, "description": "Cartão de Crédito" },
    { "code": 2, "description": "Pix" }
  ],
  "diasExpiracao": 7
}

Campos do link

Campo	Tipo	Descrição
`linkPaymentId`	integer	Identificador interno do link
`linkPaymentUuid`	string	UUID público do link (usado nas demais chamadas)
`clienteId`	integer	Identificador do cliente vinculado ao link
`nomePagador`	string	Nome do pagador
`numeroInscricao`	string	CPF, CNPJ ou documento estrangeiro do pagador
`isEstrangeiro`	boolean	Indica se o pagador é estrangeiro
`valor`	number	Valor total da cobrança
`numeroParcelas`	integer	Número de parcelas do pagamento
`status`	object	Status atual do link — `{ code, description }`
`urlPagamento`	string	URL para o pagador realizar o pagamento
`descricao`	string	Descrição ou motivo do pagamento
`tokenVerificacao`	integer	Token de verificação do link
`opcoesParcelamento`	array	Opções de parcelamento — `{ numberInstallments, amountInstallment }`
`userReference`	string	Referência de controle do integrador
`comprovantePagamento`	string	Comprovante do pagamento. Preenchido após o pagamento
`identificadorTransacao`	string	Identificador da transação de pagamento. Preenchido após o pagamento
`metodoPagamento`	object	Método efetivamente usado — `{ code, description }`. Preenchido após o pagamento
`dataCriacao`	string	Data/hora de criação do link
`metodosPagamentoAceitos`	array	Métodos aceitos — `{ code, description }`: `1` Cartão de Crédito, `2` Pix
`diasExpiracao`	integer	Dias até a expiração do link

Campos de `opcoesParcelamento[]`

Campo	Tipo	Descrição
`numberInstallments`	integer	Quantidade de parcelas
`amountInstallment`	number	Valor de cada parcela

Erros: 404 link não encontrado · 500 erro interno.

Verificar link

GET /api/v1/link-payment/check/{linkPaymentUuid}/{verificationCode}

Valida um link usando o código de verificação e retorna os dados do link.

Parâmetro	Tipo	Exemplo
`linkPaymentUuid`	string	`a1b2c3d4-e5f6-7890-abcd-ef1234567890`
`verificationCode`	string	`482913` (valor de `tokenVerificacao`)

`200 OK`

Exemplo de link ainda pendente:

{
  "linkPaymentId": 1001,
  "linkPaymentUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "clienteId": 3001,
  "nomePagador": "Joao da Silva",
  "numeroInscricao": "12345678900",
  "isEstrangeiro": false,
  "valor": 150.75,
  "numeroParcelas": 3,
  "status": { "code": 1, "description": "CREATED" },
  "urlPagamento": "https://pagamento.exemplo.com/link/a1b2c3d4",
  "descricao": "Pagamento referente a mensalidade de julho",
  "tokenVerificacao": 482913,
  "opcoesParcelamento": [
    { "numberInstallments": 1, "amountInstallment": 150.75 },
    { "numberInstallments": 2, "amountInstallment": 75.38 },
    { "numberInstallments": 3, "amountInstallment": 50.25 }
  ],
  "userReference": "PEDIDO-2026-0001",
  "comprovantePagamento": null,
  "identificadorTransacao": null,
  "metodoPagamento": null,
  "dataCriacao": "2026-08-01T14:30:00",
  "metodosPagamentoAceitos": [
    { "code": 1, "description": "Cartão de Crédito" },
    { "code": 2, "description": "Pix" }
  ],
  "diasExpiracao": 7
}

Os campos são os descritos em Campos do link, acima.

Erros: 400 código inválido · 404 link não encontrado · 500 erro interno.

Listar links

GET /api/v1/link-payment

Lista links de pagamento por período, com filtros opcionais.

Query params

Parâmetro	Obrigatório	Exemplo	Descrição
`startDate`	sim	`2024-01-01T00:00:00`	Início do período
`endDate`	sim	`2024-12-31T00:00:00`	Fim do período
`paymentReceipt`	não	`REC123456`	Comprovante de pagamento
`status`	não	`PAGO`	Filtra pelo status interno do link: `ATIVO`, `EXPIRADO`, `PAGO` ou `CANCELADO` — não pelo rótulo em inglês devolvido no corpo (ver Status do link)
`paymentMethod`	não	`1`	Método de pagamento: `1` Cartão de Crédito, `2` Pix
`registrationNumber`	não	`12345678900`	CPF/CNPJ do pagador
`userReference`	não	`USR-001`	Referência do integrador

`200 OK`

A resposta é uma lista de links:

[
  {
    "linkPaymentId": 1001,
    "linkPaymentUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "clienteId": 3001,
    "nomePagador": "Joao da Silva",
    "numeroInscricao": "12345678900",
    "isEstrangeiro": false,
    "valor": 150.75,
    "numeroParcelas": 3,
    "status": { "code": 3, "description": "PAID" },
    "urlPagamento": "https://pagamento.exemplo.com/link/a1b2c3d4",
    "descricao": "Pagamento referente a mensalidade de julho",
    "tokenVerificacao": 482913,
    "opcoesParcelamento": [
      { "numberInstallments": 1, "amountInstallment": 150.75 },
      { "numberInstallments": 2, "amountInstallment": 75.38 },
      { "numberInstallments": 3, "amountInstallment": 50.25 }
    ],
    "userReference": "PEDIDO-2026-0001",
    "comprovantePagamento": "https://pagamento.exemplo.com/comprovante/9988",
    "identificadorTransacao": "TXN-2026-998877",
    "metodoPagamento": { "code": 1, "description": "Cartão de Crédito" },
    "dataCriacao": "2026-08-01T14:30:00",
    "metodosPagamentoAceitos": [
      { "code": 1, "description": "Cartão de Crédito" },
      { "code": 2, "description": "Pix" }
    ],
    "diasExpiracao": 7
  }
]

Cada item da lista tem os campos descritos em Campos do link, acima.

Erros: 400 parâmetros inválidos (ex.: datas ausentes) · 500 erro interno.

Consultar e Listar

On this page