Faturamento, créditos, movimento e saldo dos clientes, repasses aos postos e situação de boleto.
Autenticação em todos os exemplos: veja Autenticação. Teste no navegador pelo Swagger ou importe a coleção do Postman.
| Endpoint | Métodos | Para que serve |
|---|---|---|
faturamento |
GET | Faturamento: vendas confirmadas com resumo |
faturamentoApp |
GET | Faturamento (mesmo que faturamento) |
credito |
GET | Créditos (compras de saldo) dos clientes |
movimento |
GET | Movimento de saldo dos clientes (extrato) |
financeiroRelatorioSaldo |
GET | Saldo dos clientes no app |
transferencia |
GET | Repasses (transferências) do meio de pagamento para os postos |
transferenciaCredito |
GET | Créditos que compõem um repasse |
boletoSituacao |
GET | Situação de um boleto de compra de crédito |
Faturamento: vendas confirmadas com resumo. Relatório de faturamento (vendas confirmadas) do app, com resumo. O escopo segue o acesso: rede, posto e pessoa ficam fixos no acesso desses tipos; o acesso de cliente não restringe (vê o app inteiro). A ordem das linhas não é garantida entre páginas.
/v1/terceiro/faturamentoVendas do período com resumo (paginada)
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data_inicial |
date | não | Data da venda, AAAA-MM-DD (aceita data_inicio/data_ini). Padrão 1980-01-01. |
data_final |
date | não | AAAA-MM-DD (aceita data_fim). Padrão 2099-12-31. |
id_tx_estabelecimento |
integer | não | Posto (aceita id_estabelecimento/id_posto). Fixo no acesso de posto. |
id_tx_rede |
integer | não | Rede. Fixa no acesso de rede. |
id_tx_pessoa |
integer | não | Cliente (consumidor). Fixo no acesso de pessoa. |
id_comb |
integer | não | Vendas com esse combustível (aceita id_produto). |
valor_inicial / valor_final |
number | não | Faixa do total com desconto (padrão 0 a 999999999,99). |
caixa_app |
string | não | S = recebidas no caixa, N = pagas no app, * (padrão) = todas. |
id_posto_convenio |
integer | não | Vendas com esse convênio. |
fraude |
string | não | S, N ou * (padrão). |
id_pessoa_caixa / id_pessoa_frentista |
integer | não | Caixa ou frentista (pessoa). |
tem_caixa / tem_frentista |
string | não | S (com CPF informado), N (sem) ou * (padrão). |
funcionario |
string | não | S = só vendas a funcionários ativos, N = sem elas, * (padrão) = todas. |
somente_usuarios_novos |
string | não | S = só clientes cadastrados dentro do período. |
size |
integer | não | Tamanho da página (padrão e máximo 50). |
page |
integer | não | Página (padrão 1). |
curl -s -X GET "$BASE/v1/terceiro/faturamento?$AUTH"
Resposta:
{
"data": [
{
"id_operacao": 123456,
"id_tx_pessoa": 555,
"pessoa": "CLIENTE EXEMPLO",
"id_tx_estabelecimento": 10,
"estabelecimento": "POSTO EXEMPLO",
"placa": "ABC1D23",
"quilometragem": 0,
"id_produto": 1,
"produto": "GASOLINA COMUM",
"quantidade1": 20.0,
"unitario_sem_desconto": 6.0,
"abast_sem_desconto1": 120.0,
"unitario": 5.8,
"abast_com_desconto1": 116.0,
"perc_desconto_abastecimento": 3.33,
"id_posto_convenio": 0,
"posto_convenio": "",
"nome_pessoa_caixa": "",
"cpf_caixa": "",
"nome_pessoa_frentista": "",
"cpf_frentista": "",
"quantidade": 20.0,
"total_sem_desconto": 120.0,
"total": 116.0,
"desconto": 4.0,
"data_hora_operacao": "2026-11-12 10:15:00",
"caixa": "N",
"valor_saldo": 16.0,
"valor_cartao": 100.0,
"valor_limite": 0.0,
"valor_pago": 100.0,
"fraude": "N",
"cashback": 0.0,
"pontos": 0,
"cupons": 0,
"sorte": 0
}
],
"param": {
"_count": 1,
"_pages": 1,
"_size": 50,
"_page": 1
},
"resume": {
"quantidade": 20.0,
"total_sem_desconto": 120.0,
"total_com_desconto": 116.0,
"desconto": 4.0,
"valor_saldo": 16.0,
"valor_cartao": 100.0,
"valor_pago": 100.0,
"caixa_total": null,
"app_total": 116.0
},
"status": "ok"
}
Erros específicos: 401 — credencial inválida.; 403 — sem permissão ou id de rede/posto/pessoa diferente do acesso..
Faturamento (mesmo que faturamento). Outro endereço do mesmo serviço de faturamento (mesmo código, parâmetros e resposta). Relatório de faturamento (vendas confirmadas) do app, com resumo. O escopo segue o acesso: rede, posto e pessoa ficam fixos no acesso desses tipos; o acesso de cliente não restringe (vê o app inteiro). A ordem das linhas não é garantida entre páginas.
/v1/terceiro/faturamentoAppVendas do período com resumo (paginada)
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data_inicial |
date | não | Data da venda, AAAA-MM-DD (aceita data_inicio/data_ini). Padrão 1980-01-01. |
data_final |
date | não | AAAA-MM-DD (aceita data_fim). Padrão 2099-12-31. |
id_tx_estabelecimento |
integer | não | Posto (aceita id_estabelecimento/id_posto). Fixo no acesso de posto. |
id_tx_rede |
integer | não | Rede. Fixa no acesso de rede. |
id_tx_pessoa |
integer | não | Cliente (consumidor). Fixo no acesso de pessoa. |
id_comb |
integer | não | Vendas com esse combustível (aceita id_produto). |
valor_inicial / valor_final |
number | não | Faixa do total com desconto (padrão 0 a 999999999,99). |
caixa_app |
string | não | S = recebidas no caixa, N = pagas no app, * (padrão) = todas. |
id_posto_convenio |
integer | não | Vendas com esse convênio. |
fraude |
string | não | S, N ou * (padrão). |
id_pessoa_caixa / id_pessoa_frentista |
integer | não | Caixa ou frentista (pessoa). |
tem_caixa / tem_frentista |
string | não | S (com CPF informado), N (sem) ou * (padrão). |
funcionario |
string | não | S = só vendas a funcionários ativos, N = sem elas, * (padrão) = todas. |
somente_usuarios_novos |
string | não | S = só clientes cadastrados dentro do período. |
size |
integer | não | Tamanho da página (padrão e máximo 50). |
page |
integer | não | Página (padrão 1). |
curl -s -X GET "$BASE/v1/terceiro/faturamentoApp?$AUTH"
Resposta:
{
"data": [
{
"id_operacao": 123456,
"id_tx_pessoa": 555,
"pessoa": "CLIENTE EXEMPLO",
"id_tx_estabelecimento": 10,
"estabelecimento": "POSTO EXEMPLO",
"placa": "ABC1D23",
"quilometragem": 0,
"id_produto": 1,
"produto": "GASOLINA COMUM",
"quantidade1": 20.0,
"unitario_sem_desconto": 6.0,
"abast_sem_desconto1": 120.0,
"unitario": 5.8,
"abast_com_desconto1": 116.0,
"perc_desconto_abastecimento": 3.33,
"id_posto_convenio": 0,
"posto_convenio": "",
"nome_pessoa_caixa": "",
"cpf_caixa": "",
"nome_pessoa_frentista": "",
"cpf_frentista": "",
"quantidade": 20.0,
"total_sem_desconto": 120.0,
"total": 116.0,
"desconto": 4.0,
"data_hora_operacao": "2026-11-12 10:15:00",
"caixa": "N",
"valor_saldo": 16.0,
"valor_cartao": 100.0,
"valor_limite": 0.0,
"valor_pago": 100.0,
"fraude": "N",
"cashback": 0.0,
"pontos": 0,
"cupons": 0,
"sorte": 0
}
],
"param": {
"_count": 1,
"_pages": 1,
"_size": 50,
"_page": 1
},
"resume": {
"quantidade": 20.0,
"total_sem_desconto": 120.0,
"total_com_desconto": 116.0,
"desconto": 4.0,
"valor_saldo": 16.0,
"valor_cartao": 100.0,
"valor_pago": 100.0,
"caixa_total": null,
"app_total": 116.0
},
"status": "ok"
}
Erros específicos: 401 — credencial inválida.; 403 — sem permissão ou id de rede/posto/pessoa diferente do acesso..
Créditos (compras de saldo) dos clientes. Lista os créditos (entradas e saídas de saldo, por meio de pagamento) do app, com resumo. Escopo pelo acesso: app vê o app inteiro; rede, os clientes que abasteceram nos postos da rede; posto, os que abasteceram no posto; cliente, as pessoas do cliente; pessoa, só ela.
/v1/terceiro/creditoCréditos do período (paginada)
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data_operacao_inicial / data_operacao_final |
date | não | Data da operação, AAAA-MM-DD (padrão 1980-01-01 a 2099-12-31). |
data_situacao_inicial / data_situacao_final |
date | não | Data da última situação (padrão 1980-01-01 a 2099-12-31). |
valor_inicial / valor_final |
number | não | Faixa de valor (padrão 0 a 999999999,99). |
id_tx_pessoa |
integer | não | Cliente. Fixo no acesso de pessoa. |
tipo |
string | não | E (entrada), S (saída) ou * (padrão). |
parcelado |
string | não | S (com parcelas), N (sem) ou * (padrão). |
meio_pagamento |
string | não | Grupo do meio de pagamento, como aparece em meio_pagamento (ex.: CARTÃO DE CRÉDITO, BOLETO, TRANSFERÊNCIA, DEPÓSITO, CAIXA). |
fraude |
string | não | Filtra pelo campo fraude; * (padrão) = todos. |
faturamento |
string | não | S = já ligados a um faturamento, N = ainda não, * (padrão). |
size |
integer | não | Tamanho da página (padrão e máximo 50). |
page |
integer | não | Página (padrão 1). |
curl -s -X GET "$BASE/v1/terceiro/credito?$AUTH"
Resposta:
{
"data": [
{
"id_operacao": 9001,
"data_hora_operacao": "2026-11-10 09:00:00",
"data_hora_situacao": "2026-11-10 09:00:05",
"id_tx_pessoa": 555,
"pessoa": "CLIENTE EXEMPLO",
"valor": 100.0,
"tipo": "E",
"parcelas": 0,
"valor_parcela": 0.0,
"dados_pagamento": "VISA|0000",
"taxa_meio_pagamento": 3.5,
"meio_pagamento": "CARTÃO DE CRÉDITO",
"fraude": "N",
"id_operacao_faturamento": 0,
"meio_pagamento_id": "tr_000000"
}
],
"param": {
"_count": 1,
"_pages": 1,
"_size": 50,
"_page": 1
},
"resume": {
"valor": 100.0,
"taxa_meio_pagamento": 3.5,
"entrada": 100.0,
"saida": 0.0,
"cartao_de_credito": 100.0,
"boleto": 0.0,
"transferencia": 0.0,
"deposito": 0.0,
"caixa": 0.0,
"outros": 0.0
},
"status": "ok"
}
Erros específicos: 401 — credencial inválida.; 403 — sem permissão ou id_tx_pessoa diferente do acesso..
Movimento de saldo dos clientes (extrato). Extrato das operações por pessoa (compras de crédito, abastecimentos, transferências…), com o saldo acumulado. Lê a tabela de movimento que uma rotina do servidor mantém atualizada (não é em tempo real). Rede, posto e pessoa ficam fixos no acesso desses tipos.
/v1/terceiro/movimentoMovimento paginado
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data_operacao_inicial / data_operacao_final |
date | não | Data da operação (padrão 1980-01-01 a 2099-12-31). |
data_situacao_inicial / data_situacao_final |
date | não | Data da situação (padrão 1980-01-01 a 2099-12-31). |
id_operacao |
integer | não | Uma operação. |
id_tx_pessoa |
integer | não | Pessoa. Fixa no acesso de pessoa. |
id_tx_estabelecimento / id_tx_rede |
integer | não | Posto / rede. Fixos nos acessos de posto e rede. |
operacao |
string | não | Código do tipo de operação (ex.: O = abastecimento, C = compra de crédito); * (padrão) = todos. |
valor_inicial / valor_final |
number | não | Faixa de valor (padrão -999999999,99 a 999999999,99). |
litros_inicial / litros_final |
number | não | Faixa de litros (padrão 0 a 999999999,99). |
id_comb |
integer | não | Combustível (aceita id_produto). |
id_meio_pagamento |
integer | não | Meio de pagamento. |
placa, bandeira, cashback, caixa, meio_pagamento_proprio, limite, fraude, manual, meio_pagamento_id |
string | não | Filtros por igualdade (S/N nos indicadores); * (padrão) = todos. |
id_posto_convenio / operacao_contrapartida_id |
integer | não | Convênio / operação de contrapartida. |
size |
integer | não | Tamanho da página (padrão e máximo 50). |
page |
integer | não | Página (padrão 1). |
curl -s -X GET "$BASE/v1/terceiro/movimento?$AUTH"
Resposta:
{
"data": [
{
"id_operacao": 123456,
"id_tx_pessoa": 555,
"pessoa": "CLIENTE EXEMPLO",
"valor": -116.0,
"id_meio_pagamento": 0,
"meio_pagamento": "",
"operacao": "ABASTECIMENTO",
"data_hora_operacao": "2026-11-12 10:15:00",
"data_hora_situacao": "2026-11-12 10:15:00",
"placa": "ABC1D23",
"litros": 20.0,
"caixa": "N",
"valor_saldo": 16.0,
"valor_cartao": 100.0,
"id_tx_estabelecimento": 10,
"estabelecimento": "POSTO EXEMPLO",
"id_produto": 1,
"produto": "GASOLINA COMUM",
"valor_bomba": 6.0,
"valor_promocao": 5.8,
"manual": "N",
"saldo": 0.0
}
],
"param": {
"_count": 1,
"_pages": 1,
"_size": 50,
"_page": 1
},
"status": "ok"
}
Erros específicos: 401 — credencial inválida.; 403 — sem permissão ou id de rede/posto/pessoa diferente do acesso..
Saldo dos clientes no app. Saldo de cada cliente (soma das operações confirmadas pagas pelo app até a data), com última compra de crédito e último abastecimento; CPF/CNPJ, celular e e-mail vêm mascarados. Escopo pelo acesso: app vê o app inteiro; rede, os clientes que abasteceram nos postos da rede; posto, os que abasteceram no posto; cliente, as pessoas do cliente; pessoa, só ela. Atenção: data_operacao_final não tem valor padrão; sem ela a lista vem vazia.
/v1/terceiro/financeiroRelatorioSaldoSaldos (paginada) com total
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data_operacao_final |
date | sim | Saldo até esta data (AAAA-MM-DD). Sem ela não há resultado. |
data_operacao_inicial |
date | não | Padrão 1980-01-01. |
id_tx_pessoa |
integer | não | Um cliente. Fixo no acesso de pessoa. |
saldo_inicial / saldo_final |
number | não | Faixa de saldo (padrão 0 a 999999999,99; saldos zerados nunca aparecem). |
situacao |
string | não | B = só bloqueados; qualquer outro valor diferente de * = só não bloqueados; * (padrão) = todos. |
tipo_ordem |
string | não | ABASTECIMENTO (pelo último abastecimento), COMPRA_CREDITO (pela última compra) ou vazio (padrão: maior saldo primeiro). |
ordem |
string | não | ASC (padrão) ou DESC, com tipo_ordem. |
size |
integer | não | Tamanho da página (padrão e máximo 50). |
page |
integer | não | Página (padrão 1). |
curl -s -X GET "$BASE/v1/terceiro/financeiroRelatorioSaldo?$AUTH&data_operacao_final=2026-11-12"
Resposta:
{
"data": [
{
"id_tx_pessoa": 555,
"cpf_cnpj": "000.***.***-00",
"nome_razao_social": "CLIENTE EXEMPLO",
"apelido_nome_fantasia": "",
"celular": "(00) *****-0000",
"email": "c***@exemplo.com.br",
"localidade": "CIDADE",
"estado": "UF",
"saldo": 50.0,
"bloqueado": false,
"ultima_compra_credito": "2026-11-01 10:00:00",
"ultimo_abastecimento": "2026-11-10 18:00:00"
}
],
"param": {
"_count": 1,
"_pages": 1,
"_size": 50,
"_page": 1
},
"resume": {
"saldo_total": 50.0,
"saldo_bloqueado": 0.0
},
"status": "ok"
}
Erros específicos: 401 — credencial inválida.; 403 — sem permissão ou id_tx_pessoa diferente do acesso..
Repasses (transferências) do meio de pagamento para os postos. Lista os repasses feitos pelo meio de pagamento para a conta bancária dos postos, com resumo. Escopo pelo acesso: app vê todos os postos; rede, os postos da rede; posto, só o próprio; cliente e pessoa recebem 403.
/v1/terceiro/transferenciaRepasses do período (paginada)
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data_transferencia_inicial / data_transferencia_final |
date | não | Data do repasse (padrão 1980-01-01 a 2099-12-31). |
valor_inicial / valor_final |
number | não | Faixa de valor (padrão 0 a 999999999,99). |
id_tx_estabelecimento |
integer | não | Posto (aceita id_estabelecimento/id_posto). Fixo no acesso de posto. |
situacao |
string | não | Situação do repasse, como vem do meio de pagamento; * (padrão) = todas. |
size |
integer | não | Tamanho da página (padrão e máximo 50). |
page |
integer | não | Página (padrão 1). |
curl -s -X GET "$BASE/v1/terceiro/transferencia?$AUTH"
Resposta:
{
"data": [
{
"id_tx_estabelecimento": 10,
"estabelecimento": "POSTO EXEMPLO",
"meio_pagamento_id": "tf_000000",
"data_hora_lancamento": "2026-11-10 08:00:00",
"data_hora_atualizacao": "2026-11-11 08:00:00",
"data_transferencia": "2026-11-11",
"valor_original": 1000.0,
"valor": 965.0,
"situacao": "succeeded",
"banco_codigo": "000",
"banco_agencia": "0000",
"banco_conta": "00000-0"
}
],
"param": {
"_count": 1,
"_pages": 1,
"_size": 50,
"_page": 1
},
"resume": {
"valor_original": 1000.0,
"valor": 965.0
},
"status": "ok"
}
Erros específicos: 401 — credencial inválida.; 403 — sem permissão ou id_tx_estabelecimento diferente do acesso..
Créditos que compõem um repasse. Detalha um repasse (transferencia.meio_pagamento_id): cada transação do meio de pagamento, o crédito do cliente e o faturamento do posto ligados a ela.
/v1/terceiro/transferenciaCreditoTransações do repasse (paginada)
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
meio_pagamento_id |
string | sim | Id do repasse no meio de pagamento (campo meio_pagamento_id de transferencia). |
id_tx_estabelecimento |
integer | não | Posto. Fixo no acesso de posto. |
size |
integer | não | Tamanho da página (padrão e máximo 50). |
page |
integer | não | Página (padrão 1). |
curl -s -X GET "$BASE/v1/terceiro/transferenciaCredito?$AUTH&meio_pagamento_id=tf_000000"
Resposta:
{
"data": [
{
"id_operacao_credito": 9001,
"id_tx_app": 1,
"id_tx_pessoa": 555,
"pessoa": "CLIENTE EXEMPLO",
"dados_pagamento": "VISA|0000",
"meio_pagamento": "CARTÃO DE CRÉDITO",
"fraude": "N",
"id_tx_estabelecimento": 10,
"estabelecimento": "POSTO EXEMPLO",
"id_operacao_faturamento": 123456,
"meio_pagamento_id": "tr_000000",
"situacao": "succeeded",
"valor_original": 100.0,
"valor": 96.5,
"taxa_meio_pagamento": 3.5,
"data_hora_lancamento": "2026-11-10 09:00:00",
"data_hora_atualizacao": "2026-11-11 08:00:00",
"data_prevista": "2026-11-11"
}
],
"param": {
"_count": 1,
"_pages": 1,
"_size": 50,
"_page": 1
},
"resume": {
"valor_original": 100.0,
"valor": 96.5,
"taxa_meio_pagamento": 3.5,
"valor_liquido": 93.0
},
"status": "ok"
}
Erros específicos: 401 — credencial inválida.; 403 — sem permissão ou id_tx_estabelecimento diferente do acesso..
Situação de um boleto de compra de crédito. Consulta a situação da compra de crédito paga por boleto, pela linha digitável e pelo valor. Sempre responde 200.
/v1/terceiro/boletoSituacaoSituação pelo par linha digitável + valor
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
linha_digitavel |
string | sim | 47 dígitos (pontos e espaços são ignorados). |
valor |
number | sim | Valor do boleto (> 0), igual ao gravado. |
curl -s -X GET "$BASE/v1/terceiro/boletoSituacao?$AUTH&linha_digitavel=00000000000000000000000000000000000000000000000&valor=100.0"
Resposta:
{
"situacao": "CONFIRMADO",
"status": "ok"
}
Erros específicos: 401 — credencial inválida.; 403 — sem permissão..