Overview da API

Códigos de Retorno HTTP

As operações são feitas através de requests ao endpoint, de acordo com os verbos HTTP.
As respostas da API podem ser as seguintes:

HTTP Status Code

  • 200 OK
  • 400 BAD REQUEST
  • 401 UNAUTHORIZED
  • 500 INTERNAL SERVER ERROR
  • 503 SERVICE UNAVAILABLE

Arquivo de Conciliação

O arquivo contém todas as transações que foram capturadas no dia solicitado, ou seja, todas as transações capturadas no dia para o qual a conciliação está sendo gerada.

O arquivo adota o modelo de liquidação da agenda, diferente do que é praticado no mercado. Isso significa que no arquivo de conciliação da Stone fornecemos, para o mesmo dia, as informações sobre as transações financeiras, eventos e ajustes ocorridos; e as transações e eventos financeiros que serão liquidados e os pagamentos.

🚧

Transações apresentadas no arquivo

É importante lembrar que no arquivo estarão prensentes as transações que foram capturadas e não aquelas que foram apenas autorizadas, sendo que esse tipo de transação não gera movimento financeiro.

O arquivo disponibilizado via API tem uma estrutura de 7 conteiners, que trazem o detalhamento transacional do cliente de forma estruturada. São eles:

  • Header;
  • FinancialTransactions;
  • FinancialEvents;
  • FinancialTransactionsAccounts;
  • FinancialEventsAccounts;
  • Payments;
  • Trailer.

Abaixo uma explicação sobre cada um dos containers:

Container

Descrição

Header

Contém as informações do lojista e do arquivo.

FinancialTransactions

Contém as transações e eventos de transações do dia requisitado

FinancialEvents

Contém os eventos financeiros lançados para o lojista no dia.

FinancialTransactionsAccounts

Contém as transações que foram pagas/cobradas ao lojista no dia requisitado

FinancialEventsAccounts

Contém os eventos que foram pagos/cobrados ao lojista no dia requisistado

Payments

Contém informações dos pagamentos efetuados relativos as transações e eventos financeiros do arquivo.

Trailer

Contém os totalizadores e contadores do arquivo.