Eagle · Pagamentos
Link de Pagamento

Visão Geral

Geração e gerenciamento de links de pagamento

Links de pagamento permitem cobrar um pagador por uma URL, aceitando um ou mais métodos de pagamento (cartão e/ou PIX).

Endpoints

OperaçãoMétodo e rota
Criar linkPOST /api/v1/link-payment
Listar linksGET /api/v1/link-payment
Consultar linkGET /api/v1/link-payment/{linkPaymentUuid}
Verificar linkGET /api/v1/link-payment/check/{linkPaymentUuid}/{verificationCode}
Confirmar pagamentoPUT /api/v1/link-payment/confirm-payment/{linkPaymentUuid}
Cancelar linkPUT /api/v1/link-payment/{linkPaymentUuid}/cancel

O lojista cria o link e o envia ao pagador. O pagador valida a cobrança com o código de verificação e confirma o pagamento. Enquanto não confirmado, o link pode ser cancelado.

StatusCódigoSignificado
CREATED1Link gerado, aguardando pagamento
EXPIRED2Prazo de expiração atingido sem pagamento
PAID3Pagamento confirmado
CANCELED4Link cancelado via PUT /{linkPaymentUuid}/cancel

Próximos passos

On this page