Minu · Cartões
Link de Pagamento

Consultar e Listar

Consulta, verificação e listagem de links de pagamento

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

Retorna um link de pagamento pelo seu UUID (estrutura LinkPaymentResponseDTO — ver Criar link).

ParâmetroTipoExemplo
linkPaymentUuidstringa1b2c3d4-e5f6-4789-9abc-def012345678

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


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

Valida um link usando o código de verificação.

ParâmetroTipoExemplo
linkPaymentUuidstringa1b2c3d4-e5f6-4789-9abc-def012345678
verificationCodestring123456

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


GET /api/v1/link-payment

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

Query params

ParâmetroObrigatórioExemploDescrição
startDatesim2024-01-01T00:00:00Início do período
endDatesim2024-12-31T00:00:00Fim do período
paymentReceiptnãoREC123456Comprovante de pagamento
statusnãoCONFIRMEDStatus do link
paymentMethodnão1Método de pagamento
registrationNumbernão12345678900CPF/CNPJ do pagador
userReferencenãoUSR-001Referência do integrador

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

On this page