Home

Visão Geral

  • API REST

    • Pagamentos

      • Pré-Autorização

      • Tokenização

        • Agendamento

          • Recarga

            • Cancelamento

              • Consultas

                • Operações Genéricas

                  • Idempotência

                    • Glossário

                  • Web Checkout

                    • Link de Pagamento

                      • Notificações

                        • Retentativas Automáticas

                          • Códigos de Retorno

                            • Portal Lojista

                              • 3D Secure 2.0

                                • Conexões Adquirentes

                                  • Meios de pagamentos

                                    • Integrações Antifraude

                                      • Gestão de Lojas

                                        • Informações Gerais

                                          • Facilitador de Pagamentos

                                            Pré-autorização REST

                                            Visão geral#

                                            A pré-autorização é uma transação cujo valor será reservado do limite do cartão, porém não será debitado imediatamente, podendo ser capturado posteriormente por um valor igual ou menor que o autorizado. O prazo para realizar a captura, assim como a possibilidade de capturar valores menores, depende de negociação com a rede adquirente/roteamento, cabendo à Loja Virtual consultar a rede adquirente/roteamento.

                                            A pré-autorização é utilizada nos casos em que será necessário realizar a captura da transação após um longo período de tempo. Assim, é possível apenas autorizar uma transação de pagamento e confirmá-la/capturá-la em um dia posterior. A diferença entre um pagamento com confirmação posterior e uma pré autorização com captura é o período de tempo em que a transação poderá ser efetivada.

                                            O período permitido para realizar a confirmação/captura de uma pré-autorização é maior do que um pagamento com confirmação posterior. Para melhor entendimento, podemos citar os seguintes exemplos de aplicação:

                                            Uma empresa de aluguel de carros realiza a autorização de um pagamento para um cliente. A empresa irá capturar/confirmar a transação apenas quando o cliente devolver o carro, o que pode levar muitos dias. Neste cenário, seria recomendada a utilização de uma transação de Pré-Autorização.

                                            Uma loja autoriza um pagamento, mas antes de confirmar/capturar a transação, realiza um consulta no estoque para verificar a disponibilidade de um meio de pagamento, o que poderia levar alguns minutos ou horas, e após isso efetivar o pagamento. Neste cenário, seria recomendada a utilização de uma transação de pagamento comum com confirmação posterior.

                                            E para saber mais sobre essas nomenclaturas (Bin, Software Express, Carat, e-Sitef) Saiba mais

                                            Comunicação#

                                            Para realizar uma transação Web Service, toda a comunicação será realizada via HTTPS/TLS. É importante que o servidor do lojista suporte criptografia com no mínimo 128 bits e protocolo mínimo TLS 1.2. O servidor da loja deverá realizar chamadas em endereços específicos para transações REST.

                                            Cada serviço deve ser chamado utilizando a URL base concatenada do recurso desejado (veja o capítulo referente ao serviço a ser consumido). O método HTTP (GET, POST ou PUT) indica a ação esperada sobre o recurso escolhido. Abaixo estão as URLs base do Carat:

                                            URL do ambiente de Certificação/testes:

                                            https://esitef-homologacao.softwareexpress.com.br/e-sitef/api

                                            URL do ambiente de Produção:

                                            https://esitef.softwareexpress.com.br/e-sitef/api/

                                            Atenção: Nunca utilizar o IP ao invés do domínio esitef-ec.softwareexpress.com.br, porque o IP poderá mudar a qualquer momento e sem aviso prévio, portanto, é importante a utilização do domínio para acesso ao Carat.

                                            Importante: Além dos parâmetros de resposta do webservice descrito nesta especificação, o Carat poderá retornar outros parâmetros sem aviso prévio. É importante que o aplicativo esteja preparado para receber parâmetros extras além dos parâmetros já especificados e simplesmente desprezá-los.

                                            Fluxo#

                                            O fluxo de pré-autorização será iniciado pela Loja Virtual quando o aplicativo enviar a operação beginTransaction, na resposta da requisição o aplicativo receberá o nit e outros parâmetros.

                                            Descrição do fluxo:

                                            1. Ao iniciar a operação beginTransaction pela loja virtual, é retornado um nit (identificador da transação) e outros parâmetros;
                                            2. A loja virtual prossegue então consumindo o doPreAuthorization, serviço de efetivação da pré-autorização, passando o nit e os demais parâmetros recebidos. Em caso de sucesso, a transação de pré-autorização mudará seu status para CON (transação confirmada).
                                            3. Posteriormente (conforme a regra de negócio) o mesmo nit enviado na pré-autorização, deverá ser enviado na operação capture juntamente com outros parâmetros e deverá tratar os parâmetros recebidos no webservice response.