Link de Pagamentos

Visão GeralCopied!

O Link de Pagamentos é uma funcionalidade que facilita a experiência do usuário final na hora de pagar uma cobrança PIX. Ao gerar um PIX In (cobrança PIX), a API cria uma transação identificada por um transactionId e retorna diversas informações, entre elas o paymentLink. Esse link é, na prática, uma URL formatada de forma padronizada que redireciona para uma página de checkout, onde são exibidos os detalhes da transação, permitindo que o usuário finalize o pagamento sem que seja necessário o desenvolvimento de uma interface personalizada por você.

Exemplo de URL:

Essa abordagem simplifica a integração, pois você só precisará direcionar o usuário para o link gerado, enquanto toda a apresentação dos dados e o processo de pagamento ficam sob responsabilidade da plataforma Fire Banking.

Benefícios do Link de PagamentosCopied!

• Checkout Simplificado:
  O usuário final é direcionado para uma página de pagamento que já exibe todos os detalhes da transação, sem necessidade de desenvolver um frontend customizado.

• Redução de Esforço no Desenvolvimento:
  Como a apresentação dos dados e a interface de pagamento são gerenciadas pela Fire Banking, você não precisa se preocupar em implementar e manter essas partes.

• Flexibilidade para Futuras Integrações:
  Embora atualmente a integração seja apenas com PIX, futuramente será possível gerar cobranças com outros métodos de pagamento, como Boleto ou Cartão, utilizando a mesma lógica do link de pagamentos.

Fluxo de Uso do Link de PagamentosCopied!

1. Geração do PIX In

Ao realizar uma chamada para a API de criação de cobrança PIX (PIX In), você envia os dados necessários para a transação. A resposta da API inclui, entre outras informações, o transactionId e o paymentLink.

Exemplo de Requisição e Resposta

Requisição:

{
    "type":"PIX",
    "payer": {
        "fullName":"John Marvin",
        "document":"12312312387",
        "contact":{
            "phone":"+5537988996655",
            "mail":"[email protected]"
        },
        "address":{
            "zipCode":"60000000",
            "street":"Street Name",
            "neighboor":"Neighboor Name",
            "number":"123",
            "city":"City Name",
            "state":"State Name",
            "country":"Country Name"
        }
    },
    "transaction":{
        "value":100,
        "description":"Description",
        "dueDate":"2021-01-01",
        "externalId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
}

Resposta:

{
    "transactionId":"cd722e93-032f-45e1-b638-87a2490dcea7",
    "status":"WAITING_PAYMENT",
    "pixQrCode":"iVBORw0KGgoAAAANSUhEUgAABbQAAAW0CAYAAAAeooXXAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAIABJREFUeJzs2kGu5DqSRNFmI/a/ZfbwVw7+Q2XLM2UWfs4CBKdIKQIXOvfe+z8AAAAAABDuf98eAAAAAAAA...",
    "pixCode":"00020101021226880014br.gov.bcb.pix2566qrcode-h.firebanking.com.br/QR/cob/EEA7B851BBAFFB546073CE80810F56AA0F95204000053039865802BR5925VICTOR NERY TEIXEIRA CONS6009Sao Paulo610905726-10062070503***630498E0",
    "generateTime":"2024-04-14T02:58:04.997Z",
    "paymentLink":"https://pay.firebanking.com.br/cd722e93-032f-45e1-b638-87a2490dcea7"
}

2. Utilizando o Payment Link

Após a geração da transação, o campo paymentLink contém a URL do checkout, que segue o padrão:

https://pay.firebanking.com.br/<transactionId>

Como Utilizar:

• Direcionamento do Usuário:
  Após receber a resposta da API, basta redirecionar o usuário final para a URL contida no paymentLink. Esse redirecionamento pode ser feito por meio de um link clicável, botão ou qualquer outro método adequado à experiência do seu aplicativo.

• Exibição dos Detalhes da Transação:
  Ao acessar o link, o usuário visualizará uma página com os detalhes da cobrança, incluindo o valor, a descrição, data de vencimento e outras informações relevantes, além das opções para efetuar o pagamento.

• Processamento de Pagamento:
  O usuário final realiza o pagamento através da interface do checkout, sem necessidade de ações adicionais por parte do cliente.

3. Futuras Possibilidades

Atualmente, o Link de Pagamentos é utilizado apenas para cobranças PIX. No entanto, a plataforma está evoluindo e, em breve, será possível gerar cobranças utilizando outros métodos de pagamento, como:

• Boleto Bancário

• Cartão de Crédito/Débito

A lógica do link permanecerá similar, permitindo que o usuário final seja direcionado para um checkout unificado, independente do método de pagamento escolhido.

Considerações TécnicasCopied!

• Formato da URL:
  A URL do paymentLink é construída de forma simples, combinando a URL base https://pay.firebanking.com.br/ com o transactionId. Essa abordagem garante que cada transação possua um link único e facilmente identificável.

• Integração Transparente:
  Ao utilizar o paymentLink, não há necessidade de desenvolver uma interface própria para exibir os detalhes da cobrança ou o QR Code, pois tudo isso é gerenciado pela plataforma da Fire Banking.

• Segurança e Validação:
  A transação é identificada pelo transactionId, garantindo que o link seja exclusivo e que os dados exibidos estejam corretos e seguros para o processo de pagamento.

Resumo do FluxoCopied!

1. Geração do PIX In:
   Faça a requisição para criar a cobrança PIX e receba o transactionId e o paymentLink.

2. Redirecionamento do Usuário:
   Utilize o paymentLink para direcionar o usuário final ao checkout.

3. Finalização do Pagamento:
   O usuário visualiza os detalhes da transação e conclui o pagamento através da interface do checkout.

Para mais detalhes sobre os possíveis erros e parâmetros, acesse a referência completa da API.