API Reference

Rotas

Rotas da Api Flashlink.

A seguir, apresentamos a funcionalidade geral de cada rota da API Flashlink. Para cada rota, há um link que direciona à documentação detalhada de como utilizá-la.

1. Gerar o Link de Pagamento:

Para iniciar, será necessário gerar um Flashlink. Utilize a rota /v1/flashlink/{cnpj:string} para criar um link para a tela de checkout de pagamento, onde o seu cliente fará o pagamento através do cartão de crédito. Esta rota permite que você especifique o valor a ser cobrado, a quantidade de parcelas e outros parâmetros necessários. Para mais detalhes, confira a documentação da rota de geração de link.

2. Consulta por Token:

Para realizar uma consulta específica utilizando o token de um Flashlink, utilize a rota /v1/flashlink/bytoken/{token:string}. Essa rota oferece informações detalhadas sobre o link associado ao token, incluindo o status do pagamento, valor e outros detalhes relevantes. Para mais detalhes, confira a documentação da rota de consulta por Token.

3. Consultar Link por Token e Email do Pagador:

Para realizar uma consulta específica utilizando o token de um Flashlink e o email cadastrado na compra, utilize a rota /v1/flashlink/bytokenandemail/{token:string}/{email:string}. Como o Flashlink pode ser pago mais de uma vez, de acordo com o número de vezes informado na rota de geração de link, esta rota é útil para visualizar os dados de um link de pagamento específico de um comprador. Isso é feito utilizando o token e o e-mail do pagador. Para mais detalhes, confira a documentação da rota de consulta de link por Token e Email.

4. Cancelar Flashlink:

Esta rota permite efetuar o cancelamento de uma transação associada a um Flashlink específico. O cancelamento é possível somente se a transação tiver sido efetuada no mesmo dia do pedido de cancelamento. Utilize a rota /v1/flashlink/cancelar/{token:string}/{tid:string}/{valor:string} para realizar essa operação. Para mais detalhes, confira a documentação da rota de Cancelar Flashlink.