API Reference

Listar Extrato por Estabelecimento

Retorna o extrato de um estabelecimento específico.

Retorna Extrato de um Estabelecimento por Data

Através do Token_Api informado ele buscará o estabelecimento e, filtrando por tipo de lançamento e data, irá retornar todos as vendas realizadas neste período.

Como Implementar

É necessário passar o token do estabelecimento no header "Authorization", e no "Content-Type" preenchê-lo com o valor "application/json".

Abaixo temos um exemplo de como inserir o Header usando JSON:

{
 "Authorization": "Bearer seu_token_api_aqui",
 "Content-type": "application/json"
}

O tipo de lançamento representa qual a origem do lançamento realizado no extrato. Caso queira retornar todos os tipos, apenas deixe o campo vazio.

Abaixo temos uma tabela possuindo o ID do lançamento e seu Tipo.

CódigoDescrição
1Aluguel: Débito referente ao pagamento do aluguel da maquininha de pagamento.
2Ajuste a crédito: Crédito aplicado para corrigir valores de transações anteriores.
3Ajuste a débito: Débito aplicado para corrigir valores de transações anteriores.
4Lançamentos: Crédito referente a transações de vendas realizadas com cartão (categoria não utilizada atualmente).
5Desconto: Débito referente a valores descontados por avarias ou danos.
6Tarifa Bancaria: Débito referente a tarifas bancárias aplicadas ao produto Fix Bank (categoria não utilizada atualmente).
7Saque: Valor resultante da soma de créditos e débitos liquidados, disponível para retirada.
8Pagamento: Crédito referente ao valor total de recebimentos consolidados.
9Antecipação: Crédito referente ao adiantamento de valores de vendas futuras.
10Cobrança de Link: Débito relacionado à criação de links de pagamento, conforme acordo comercial.
11Transferência para Âncora: Débito referente ao valor transferido para a empresa âncora associada ao estabelecimento (Produto Âncora 1.0).
12Valor Pago em Conta Determinada pelo Banco Central: Crédito transferido para conta, conforme regulamento do Banco Central.
13Plano de Faturamento Mínimo: Débito referente ao valor mínimo de faturamento acordado em contrato com o setor comercial.
14Plano: Débito referente ao plano mensal de uso da plataforma (Produto Sign).
15Tarifa PIX: Débito referente às taxas de transações realizadas via PIX.
16Lançamento PIX: Débito referente a vendas realizadas utilizando o sistema PIX.
17Lançamento Boleto: Crédito referente a vendas processadas via boleto bancário.
18Cobrança de Pacote: Débito referente à cobrança do pacote de envio de SMS (Produto Fix Sign).
19Chargeback Recuperado: Crédito referente à recuperação de valor após disputa de chargeback vencida.
20Chargeback: Débito referente à contestação de uma venda por chargeback.
21Cancelamento: Débito referente ao cancelamento de vendas previamente realizadas.
22Transferencia Aluguel: Débito referente ao pagamento do aluguel de outro estabelecimento do mesmo grupo comercial.
23Transferencia Aluguel: Débito referente à transferência de débitos para outro estabelecimento do mesmo grupo comercial.

Quanto ao campo "decimals" só são permitidos dois valores, sendo eles: 2 e 4.

Language
Click Try It! to start a request and see the response here!