PIX INICIADOR DE PAGAMENTOS

Última atualização: 25 de Maio de 2023

Introdução

O Brasil está entre os muitos países que estão implementando infraestruturas reguladas de Open Finance. Estima-se que mais de 80 países estão com a prática regulamentada, ou em discussões já avançadas. O Open Finance é uma infraestrutura que possibilita a criação de novos serviços e produtos financeiros como a iniciação de pagamento.

No cenário de pagamentos, o Open Finance pode alterar a forma como consumidores e empresas recebem e/ou pagam, e se tornar uma alternativa eficiente, segura, barata e rápida.

Através da iniciação de pagamento, o que costumava existir apenas por trilhos tradicionais (como os cartões de débito e crédito), ganha agora uma alternativa a ser roteada pelo banco do consumidor e estabelecida diretamente entre o comerciante e o consumidor.

Descrição do Produto

O Iniciador de Transação de Pagamento se dá por meio da regulamentação do Open Finance, que criou a figura do Iniciador para intermediar e iniciar as transações de pagamentos via pix no contexto do Sistema Financeiro Nacional.

Nossa solução de Iniciação de Pagamento é Plug-and-Play e White Label.
Desenvolvido para atender instituições autorizadas com a própria "Licença ITP" e também empresas distribuidoras no modelo de Sub-Iniciador

Com apenas uma API você tem o fluxo de iniciação em sua infraestrutura de forma segura e escalável para distribuição.

Segurança

Todas as requisições submetidas à nossa API devem ser realizadas por meio de um token gerado através de um usuário e senha que devem ser fornecidos pela Clear.

Na autenticação, além do token retornamos seu tempo de expiração. É necessário que contemple no seu desenvolvimento o gerenciamento da vida útil do token com base nesse tempo de expiração. Só gere um novo token após a expiração do seu token atual.

O acesso aos serviços é feito através de API REST, usando padrões de mercado seguros.

Fluxo de Integração

Pré-requisitos:

Adesão aos serviços;

Envio dos documentos de Matriz de Funcionalidades, Cadastro de Contatos e Cadastro Técnico para o e-mail suporte.pix@clear.sale;

Após os requisitos acima devidamente atendidos e validados, a Clear enviará o usuário e senha para acesso.

Hostname Produção:

https://afpi.sec-hub.com.br/

Hostname Homologação:

https://afpi-hmg.sec-hub.com.br

Observação:

Recomendamos não enviar dados produtivos nos testes do ambiente de homologação. Os dados retornados no ambiente de homologação são aleatórios e fictícios.

Tratamento de Erro

401 - Não autorizado:

Possíveis problemas: erro ao autenticar a requisição. Consulte o valor do token.

400 - BadRequest:

Possíveis problemas: verifique se algum campo no corpo da requisição não está preenchido.

500 Internal Server Error

Possíveis problemas: algum tipo de problema está afetando o desempenho do servidor que você está tentando acessar.

Swagger

Será possível visualizar as regras no swagger por meio dos links

homologação =>

produção =>

Autenticação

Para enviar uma requisição de pagamento é necessário que o cliente esteja cadastrado no SSO

É necessário informar client_id e client_secret para obtenção do token

Também é necessário que você considere em seu desenvolvimento a gestão da vida útil do token com base neste tempo de expiração.
O tempo de expiração é retornado em segundos.

Requisição
   
                
POST  https://login.clearsale.com.br
Content-Type:application/x-www-form-urlencoded

grant_type:client_credentials
scope:PixIniciadorPagamento

Auth: Basic Auth
Username:valor_client_id
Password:valor_client_secret

                
            
   
                
POST https://loginhml.clearsale.com.br
Content-Type:application/x-www-form-urlencoded

grant_type:client_credentials
scope:PixIniciadorPagamento

Auth: Basic Auth
Username:valor_client_id
Password:valor_client_secret
Resposta
                
{
    "access_token": "token_gerado",
    "token_type": "Bearer" ou "access_token",
    "expires_in": 898
}

Payment POST - Cria um pagamento PIX

Este endpoint está disponível na API na seguinte rota "{{url_api}}/payment/create", tem a finalidade de criar uma transação de pagamento, e retorna a url da interface do iniciador de pagamento.

Após a criação da transação há um acompanhamento do status da mesma.

Antes de utilizar a API do iniciador de pagamento, você precisará realizar os seguintes passos:

  1. Realizar autenticação como descrito acima
  2. Fazer a solicitação à API do iniciador do pagamento com o token recebido.
  3. Insira {token_type} [espaço] {access_token}
    Exemplo: access_token abcd1234
  4. Informar o x-api-version no header
    Exemplo: x-api-version 1

Parâmetros

Nome Valor Tipo Obrigatório
paymentType PIX String Sim
amount 200.0 decimal Sim
redirectUrl redirecionamentourl.com.br/exemplo/sucesso string Sim
redirectOnErrorUrl redirecionamentourl.com.br/exemplo/erro string Sim
consumer [object Object] Object Sim
order [object Object] Object Não
Consumer
Nome Valor Tipo Obrigatório
name Fulado de Tal String Sim
tradeName Loja do Fulado String Não
email fulano.tal@email.com.br String Não
documentType CPF String Sim
document 18356615801 String Sim
phone 5511991234567 String Sim
birthDate 1990-01-01 Date Não
gender M/F/O char Não
address List List Sim
Address
Nome Valor Tipo Obrigatório
addressType HOME/SHIPPING/BILLING String Sim
receiverName Fulano de Tal String Sim
postalCode 90660101 String Sim
city São Paulo String Sim
state SP String Sim
country Brasil String Sim
street Rua das Américas String Sim
number 123 String Sim
neighborhood Centro String Sim
complement apto 100 String Não
reference Ao lado do Clube String Não
Order
Nome Valor Tipo Obrigatório
items List List Não
shipping List List Não
Item
Nome Valor Tipo Obrigatório
ean 1234567890 string Não
name Batatinha string Não
price 10.0 decimal Não
quantity 10 integer Não
Shipping
Nome Valor Tipo Obrigatório
addressType HOME/SHIPPING/BILLING String Sim
receiverName Fulano de Tal String Sim
postalCode 90660101 String Sim
city São Paulo String Sim
state SP String Sim
country Brasil String Sim
street Rua das Américas String Sim
number 123 String Sim
neighborhood Centro String Sim
complement apto 100 String Não
reference Ao lado do Clube String Não

Payment GET - Consulta os dados de um pagamento

Este endpoint está disponível na API na seguinte rota "{{url_api}}/payment/detail?externalId=id_do_pagamento" e tem a finalidade de consultar os dados de uma transação de pagamento e o histórico dos status da transação.

Para utilizar este endpoint será necessário informar o token obtido na autenticação, conforme descrito acima

  1. Realizar autenticação
  2. Fazer a requisição à API do iniciador do pagamento com o token recebido.
  3. Insira {token_type} [espaço] {access_token}
    Exemplo: access_token abcd1234
  4. Informar o x-api-version no header
    Exemplo: x-api-version 1