Minha primeira requisição

Passo 1 - Artefatos Lina Iniciação Pagamentos

Entre em contato com [email protected] e solicite credenciais e artefatos para realização de testes na nossa Plataforma. Serão compartilhados:

• Postman Collection - possui todos os endpoints listados na nossa documentação de APIs ;
• Postman Environment - contém todas as variáveis de ambiente necessárias para a realização das chamadas. Importante: neste artefato, estão contidas as credenciais de cliente;
• Swagger OAS 3.0 - também será compartilhada a última versão das definições de API do nosso Produto, que será sempre a versão corrente da nossa documentação

Passo 2 - Carregando Collection e Environment para a primeira chamada

Clique no botão "importar" no canto esquerdo superior da aplicação Postman e importe ambos os arquivos (Collection e Environment) para a aplicação.

Clique no canto direito da aplicação e selecione o Environment enviado e previamente carregado na aplicação:

Com o Environment carregado e a Postman Collection à esquerda, podemos realizar a primeira chamada para validar o funcionamento das credenciais enviadas:

Ao acessar a collection, clique na aba Authorization ou Autorização, role ao final da página e clique no botão laranja. Caso tenha sucesso na chamada, a tela a seguir será exibida. Ao final, clique em Use Token ou Utilizar Token para confirmar e autenticar todas as chamadas subsequentes que serão realizadas a seguir.

📘

Postman Collection - Autenticação

Todas as chamadas da postman collection serão autenticadas com o token obtido através dos passos acima. Não é necessário realizar a autenticação para cada uma das chamadas, já que o refresh também é realizado por essa funcionalidade.

Passo 3 - Iniciando uma Solicitação de Pagamento

A Postman Collection enviada possui uma pasta de "Porta HPP", deve ser realizada a chamada do método "POST" -
"/payments - Create Payment", informando no body as informações do detalhes do pagamento. Os campos obrigatórios podem ser consultado no detalhamento da API.

🚧

URL de redirecionamento

A URL de redirecionamento informada nesta chamada redirectUri é uma URL onde o sistema irá retornar após a realização do pagamento e conterá a informação do paymentLinkId para consultar o Status do pagamento.

Após a realização da chamada é retornado a URL de redirecionamento para o Portal de Iniciação, além do Id de consulta do "Payment Request".

Passo 4 - Copie a URL e abra no navegador

Copie a URL gerada e abra no browser do navegador, será observado os detalhes do pagamento que foi iniciado via a API.

Passo 5 - Confirme o CPF/CNPJ e selecione a Instituição Detentora

Clique em Seguir com o mesmo CPF/CNPJ, irá para a tela da seleção da Instituição detentora de conta para realização do pagamento. Vamos utilizar a Mock Bank.

📘

Ambiente de Homologação

No ambiente de homologação utilizamos a Instituição detentora de contas do Mock Bank. O CPF que ela aceita para realização de testes é o "76109277673"

Passo 6 - Confira os dados e redirecione para a Instituição Detentora

Após a seleção será exibida a tela com o detalhamento da instituição, além das informações da conta que está sendo creditada. Clique em redirecionar para ir para a confirmação do pagamento na página da detentora.

A aplicação irá redirecionar o Portal para a Instituição Detentora.

Passo 6 - Informe os dados de acesso na Instituição Detentora.

Informe o usuário em senha de acesso.

📘

Ambiente de Homologação

No ambiente de homologação utilizamos a Instituição detentora de contas do Mock Bank. O usuário e senha são:
[email protected]
P@ssword01

Passo 7 - Confirme o Consentimento para a realização do pagamento

Na instituição detentora será informado todo o detalhamento do pagamento que está sendo realizado, para que seja feito o consentimento pelo usuário.

Após a confirmação o pagamento será realizado e retornado para a URL informada no campo "redirectUri" ("https://redirect-demo-opal.vercel.app") do Body inicial da API. No retorno é concatenado o "paymentLinkId" que deve ser utilizado para consultar o Status do Pagamento.

Passo 8 - Consulte o Payment Request via API para verificar o Status do Pagamento.

A Postman Collection enviada possui uma pasta de "Consultas", onde deve ser realizada a chamada do método "GET" -
"/payments/requests/:id- Get Payment Request", para verificar o status do pagamento realizado.