Como funciona

Imagem ilustrando o fluxo de iniciação de pagamento. Descrição em texto na sequência.

1 - Tenha em mão as informações do seu cliente

Valor do pagamento, banco a ser iniciado, tipo de documento (PF ou PJ) e o número do documento.
Você pode consultar a lista atualizada de bancos habilitados, no endpoint: Consultar lista de instituições (GET).

2 - Confirme a iniciação (Post)

Para confirmar a iniciação você também precisará enviar uma url de retorno, ao final do pagamento no banco, o app bancário redirecionará o usuário para essa url.

3 - Receba a url para direcionar seu usuário para o app do banco

Você receberá em sua API uma url, essa url será usada por seu cliente para acessar seu app bancário, já levando para uma página de autenticação.

4 - Seu usuário irá acessar o link, autenticar no banco e finalizar o pagamento

O usuário acessará seu banco utilizando o link e após autenticado ele confirmará o pagamento!

5 - Após pagar, o usuário volta automaticamente para seu app

Após finalizar o pagamento no banco, o usuário é redirecionado para a url de retorno que você mandou anteriormente, ou seja, retorna para seu app!

📘
Recomendamos criar uma Iniciação de Pagamento assim que souber o valor a ser cobrado (por exemplo, quando o cliente inicia o processo de checkout), e então complementar as informações no momento da confirmação, ou utilizando o método update.
Fazendo isso, você tem algumas vantagens:

Fica mais fácil rastrear as tentativas malsucedidas de pagamento de uma compra, pois todas as tentativas de confirmação estarão atreladas a apenas uma Iniciação de Pagamento.

Fica mais fácil identificar mudanças no pagamento ou pagamentos não finalizados (por exemplo, se o cliente altera o valor do carrinho de compras, ou até mesmo se ele abandona sem confirmar o pagamento), pois você terá o registro da criação da iniciação desde o início do fluxo.

Portanto, se o processo de checkout for interrompido e depois retomado, tente reaproveitar a iniciação ao invés de criar outra. Cada iniciação tem um ID único que você pode usar para consulta se precisar dela novamente. Você pode armazenar esse ID na sessão do cliente para facilitar a recuperação.

🚧
É obrigatório seguir o Manual de experiência do usuário do Open Banking para o desenvolvimento de telas e fluxos para seu usuário final. Manual de experiência do Usuário do Open Banking