Link de Pagamento
Consultar e Listar
Consulta, verificação e listagem de links de pagamento
Consultar link
GET /api/v1/link-payment/{linkPaymentUuid}Retorna um link de pagamento pelo seu UUID (estrutura LinkPaymentResponseDTO — ver
Criar link).
| Parâmetro | Tipo | Exemplo |
|---|---|---|
linkPaymentUuid | string | a1b2c3d4-e5f6-4789-9abc-def012345678 |
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.
| Parâmetro | Tipo | Exemplo |
|---|---|---|
linkPaymentUuid | string | a1b2c3d4-e5f6-4789-9abc-def012345678 |
verificationCode | string | 123456 |
Erros: 400 código inválido · 404 link não encontrado · 500 erro interno.
Listar links
GET /api/v1/link-paymentLista 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 | CONFIRMED | Status do link |
paymentMethod | não | 1 | Método de pagamento |
registrationNumber | não | 12345678900 | CPF/CNPJ do pagador |
userReference | não | USR-001 | Referência do integrador |
Erros: 400 parâmetros inválidos (ex.: datas ausentes) · 500 erro interno.