Home

Overview

  • Funcionalidades

    • Arquitetura

      • Autenticação

        • Endpoints de transações

          • Endpoints de estornos

            • Endpoints de pendências

              • Estrutura de respostas

                • Códigos e descrições

                  Overview

                  Intro#

                  Welcome to the documentation for the SiTef transaction API, where clients can view their transactions, pendencies, and reversals, as well as resolve pending transactions.

                  This project is a rewrite of the WS-Consulta solution, aiming to provide a more performant, resilient, and reliable alternative for clients.

                  The usual methods for checking transaction status and handling pending transactions require the use of SiTef® or SiTef-Express or others.

                  These options do not allow for automation of operations.

                  To address this issue, an online inquiry and pendency resolution service was created, which will be accessed by an App Server (developed by the integrator/client), allowing listing, status validation, and pendency resolution of SiTef-Reconciliation transactions.

                  The API uses Spring Boot Web to handle HTTPS requests. Among the endpoints, services for pendency handling and transaction status verification are available via the REST protocol. For authentication and authorization, the OAuth 2.0 Client Credentials protocol is used, managed by an authentication server based on Keycloak.

                  Purpose#

                  This documentation aims to present the definition of interfaces and technical criteria required for using the API features.

                  Target Audience#

                  This documentation is intended for the development teams of integrators/clients, or anyone interested in using the transaction inquiry and pendency resolution service.