Payloads/objetos
Nesta seção, vamos detalhar os diferentes tipos de payloads que são utilizados no fluxo de pagamento integrado entre nossa plataforma e sua aplicação. Os payloads desempenham um papel fundamental na comunicação entre os sistemas, permitindo a troca de informações essenciais para processar e gerenciar os pagamentos de forma eficiente.
Cada payload possui um propósito específico e é acionado em momentos-chave do processo de pagamento. Ao compreender como cada payload é utilizado e o que se espera como resposta, você poderá integrá-los de maneira adequada em sua aplicação, garantindo uma melhor performance e experiência de pagamento para os consumidores finais.
Abaixo, detalharemos cada tipo de payload, explicando sua função, estrutura e o papel que desempenha no fluxo de pagamento integrado. Este conhecimento será fundamental para o desenvolvimento e implementação bem-sucedidos da integração de pagamentos em sua aplicação.
Estrutura da URL base de Payload + Headers
Ao realizar o cadastro na plataforma da integração, obrigatoriamente será solicitado uma URL base, ela servirá de base para as requisições feitas para o integrador.
Importante: a URL deve ter o SSL instalado e com o 'https' corretamente
Estrutura : {URLBase}/{metodo}
Headers
Ao realizar um POST para a URL, os headers configurados pelo integrador serão automaticamente incluídos na requisição. Esses headers consistem em pares de 'Chave' e 'Valor' e são essenciais para identificar a requisição e acionar os procedimentos correspondentes na integração. Por exemplo, ao integrar com múltiplos lojistas, você pode personalizar os headers da seguinte forma:
| Chave | Valor |
|---|---|
| Store_id | 123XYZ456 |
| Store_name | Loja de Teste |
O exemplo acima é uma boa prática de utilização, os headers não estão limitados ao exemplo.
Payment Details
Quando é utilizado?
Quando o usuário seleciona a opção de pagamento no Checkout.
Acesse a documentação do payment details aqui
Payment
Quando é utilizado?
Quando o usuário fecha o pedido utilizando o pagamento customizado no checkout.
Acesse a documentação do payment aqui
Authorize
Quando é utilizado?
Quando o usuário deseja que o pedido seja processado em Two-steps, onde a transação deverá ser primeiro Autorizada e, após o Antifraude aprovar, a transação seja Capturada junto a aplicação do terceiro.
Acesse a documentação do authorize aqui
Capture
Quando é utilizado?
Quando o usuário deseja que o pedido Aprovado pós-Antifraude seja Capturado junto a aplicação do terceiro.
Acesse a documentação do capture aqui
Chargeback
Quando é utilizado?
Quando o usuário deseja que o estorno parcial ou total do seu pedido seja realizado.
Este processo é feito via API Pública,usando uma aplicação externa para solicitar o estorno, por meio do endpoint POST https://api.fbits.net/pedidos/estorno/{pedidoId}
Acesse a documentação do chargebackaqui
Card
Quando é utilizado?
Quando o usuário exclui o cartão salvo que está sendo apresentado na opção de pagamento customizado no Checkout.
Para isso, será necessário criar o botão de "excluir" via front-end vinculado ao cartão salvo, permitindo ao usuário excluir, caso seja estratégico para o lojista.
Acesse a documentação do cardaqui
Updated 9 months ago