Link de Pagamento
Confirmar e Cancelar
Confirma o pagamento de um link ou cancela o link
Confirmar pagamento do link
PUT /api/v1/link-payment/confirm-payment/{linkPaymentUuid}Confirma o pagamento de um link enviando os dados do pagamento com cartão.
Requer autenticação mTLS. Veja Autenticação.
Parâmetros de rota
| Parâmetro | Tipo | Exemplo |
|---|---|---|
linkPaymentUuid | string | a1b2c3d4-e5f6-4789-9abc-def012345678 |
Body
{
"identificacaoPagamento": "PAG-20250723-0003",
"numeroParcelas": 1,
"tipoParcelamento": "3",
"bandeiraCartao": "1",
"valor": 150.75,
"dataExpiracao": "12/28",
"codigoSeguranca": "123",
"numeroCartao": "4111111111111111"
}Campos
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
identificacaoPagamento | string | sim | Identificação única do pagamento, gerada pelo sistema de origem |
numeroParcelas | integer | sim | Número de parcelas (mínimo 1) |
tipoParcelamento | enum | sim | Tipo de parcelamento. Valores: 3, 4, 6, 7 |
bandeiraCartao | string | sim | Código numérico da bandeira do cartão (ex.: 1) |
valor | number | sim | Valor total da transação |
dataExpiracao | string | não | Validade do cartão no formato MM/AA (ex.: 12/28) |
codigoSeguranca | string | não | CVV/CVC do cartão |
numeroCartao | string | condicional | Número do cartão. Obrigatório quando não for pagamento via token |
token | string | condicional | Token do cartão tokenizado. Obrigatório quando for pagamento via token (dispensa numeroCartao) |
Erros: 400 dados de pagamento ausentes/mal formatados · 404 link não encontrado ·
409 link já confirmado, cancelado ou expirado · 500 erro interno.
Cancelar link
PUT /api/v1/link-payment/{linkPaymentUuid}/cancelCancela um link de pagamento.
Parâmetros de rota
| Parâmetro | Tipo | Exemplo |
|---|---|---|
linkPaymentUuid | string | a1b2c3d4-e5f6-4789-9abc-def012345678 |
Erros: 404 link não encontrado · 409 link já cancelado ou confirmado ·
500 erro interno.