Consultar extrato de créditos

curl --request GET \
  --url https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'api-key: <api-key>'

import requests

url = "https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato"

headers = {
    "Authorization": "Basic <encoded-value>",
    "api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Basic <encoded-value>', 'api-key': '<api-key>'}
};

fetch('https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato")
  .header("Authorization", "Basic <encoded-value>")
  .header("api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "lista": [
      {
        "data_hora": "2026-10-07T17:19:20-03:00",
        "valor": -1.31,
        "pessoa": {
          "tipo": "condutor",
          "nome": "Rafael Lima"
        },
        "tipo_operacao": "taxa_central",
        "operacao_descricao": "Taxa da central",
        "descricao": "OS #632",
        "estornado": false,
        "registro_manual": null,
        "desafio_id": null,
        "solicitacao_cashback_id": null
      },
      {
        "data_hora": "2026-10-07T12:59:45-03:00",
        "valor": 100,
        "pessoa": {
          "tipo": "cliente",
          "nome": "Ana Oliveira"
        },
        "tipo_operacao": "recarga",
        "operacao_descricao": "Recarga via central",
        "descricao": "Operador: Administrador Velox",
        "estornado": false,
        "registro_manual": {
          "id": 4,
          "operador": "Administrador Velox",
          "observacao": null,
          "observacao_condutor": null
        },
        "desafio_id": null,
        "solicitacao_cashback_id": null
      },
      {
        "data_hora": "2026-10-07T12:51:48-03:00",
        "valor": -1.5,
        "pessoa": {
          "tipo": "condutor",
          "nome": "Carlos Silva"
        },
        "tipo_operacao": "saque",
        "operacao_descricao": "Saque via central",
        "descricao": "Operador: Administrador Velox",
        "estornado": false,
        "registro_manual": {
          "id": 2,
          "operador": "Administrador Velox",
          "observacao": null,
          "observacao_condutor": null
        },
        "desafio_id": null,
        "solicitacao_cashback_id": null
      }
    ],
    "processamento_mchpay": "OK"
  }
}

Financeiro

Consultar extrato de créditos

Lista os lançamentos do extrato de créditos da central, com a mesma classificação e os filtros da tela MachinePay > Extrato do painel, exceto categoria e tipo de pagamento, que respondem 400. Os lançamentos vêm do mais recente para o mais antigo, 10 por página e sem total: a última página é a que vem com menos de 10 itens.

O período (data_ini a data_fim) tem no máximo 31 dias e data_ini precisa estar nos últimos 6 meses. Quando subfiltros é informado (e não é todos), ele define os lançamentos e o tipo é ignorado; situacao e tipo_usuario só valem nesse caso.

tipo_operacao de cada lançamento. Estorno leva o prefixo estorno_ (ex.: estorno_recarga), e operacao_descricao traz o texto legível (ex.: Estorno (Recarga via central)):

Valor	Lançamento
`recarga`	Recarga de créditos (via central, pix, bônus de deslocamento ou desconto na primeira solicitação)
`saque`	Saque de créditos (via central ou pix, inclusive em processamento)
`taxa_saque`	Taxa de saque via pix
`taxa_central`	Taxa da central cobrada na corrida
`taxa_cancelamento`	Taxa de cancelamento
`cashback`	Cashback ou bônus para novo passageiro
`desafio`	Recompensa por desafio
`indicacao`	Recompensa por indicação
`gorjeta`	Gorjeta
`passe_livre`	Compra ou reembolso de passe livre
`impulsionamento_central`	Impulsionamento da solicitação pela central
`cupom`	Cupom creditado
`voucher`	Ganhos em voucher
`ticket`	Ganhos em e-ticket
`faturado`	Ganhos em faturado
`cartao`	Ganhos em cartão no app
`pix_app`	Ganhos em pix no app
`ganho`	Ganho de créditos (carteira de créditos ou bônus dedicado recebido)
`consumido`	Consumo de créditos (carteira de créditos, taxa da central em centrais só de entregas ou bônus dedicado enviado)
`pagamento_pendente`	Pagamento pendente

subfiltros aceitos:

Valor	Lançamentos
`todos`	Sem subfiltro: vale o `tipo`
`ganhos-app`	Ganhos em cartão no app
`ganhos-pix`	Ganhos em pix no app
`ganhos-voucher`	Ganhos em voucher
`ganhos-eticket`	Ganhos em e-ticket
`ganhos-carteira-credito`	Ganhos em carteira de créditos
`ganhos-presencial`	Corridas e entregas com pagamento presencial
`ganhos-cupom`	Cupons creditados
`consumo-taxas-central`	Taxas da central
`cashback`	Cashback e bônus de passageiro
`desafios`	Recompensas por desafio
`indicacao`	Recompensas por indicação
`taxas-repassadas`	Taxas de cancelamento repassadas
`recarga-pix`	Recargas via pix
`recarga-central`	Recargas via central
`saque-central`	Saques via central
`saque-pix`	Saques via pix

processamento_mchpay vem NOK quando o processamento dos lançamentos está atrasado: os mais recentes ainda podem não aparecer.

Requer Api-Key (bandeira) + autenticação HTTP Basic de um gestor ativo da central, sem empresa vinculada, com a permissão API - Carteira de créditos, e o MachinePay habilitado na central. Parâmetro enviado vazio (ex.: registro_manual_id=) vale como não informado.

GET

financeiro

extrato

Consultar extrato de créditos

curl --request GET \
  --url https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'api-key: <api-key>'

import requests

url = "https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato"

headers = {
    "Authorization": "Basic <encoded-value>",
    "api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Basic <encoded-value>', 'api-key': '<api-key>'}
};

fetch('https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato")
  .header("Authorization", "Basic <encoded-value>")
  .header("api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-vendas.taximachine.com.br/api/v2/integracao/financeiro/extrato")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "lista": [
      {
        "data_hora": "2026-10-07T17:19:20-03:00",
        "valor": -1.31,
        "pessoa": {
          "tipo": "condutor",
          "nome": "Rafael Lima"
        },
        "tipo_operacao": "taxa_central",
        "operacao_descricao": "Taxa da central",
        "descricao": "OS #632",
        "estornado": false,
        "registro_manual": null,
        "desafio_id": null,
        "solicitacao_cashback_id": null
      },
      {
        "data_hora": "2026-10-07T12:59:45-03:00",
        "valor": 100,
        "pessoa": {
          "tipo": "cliente",
          "nome": "Ana Oliveira"
        },
        "tipo_operacao": "recarga",
        "operacao_descricao": "Recarga via central",
        "descricao": "Operador: Administrador Velox",
        "estornado": false,
        "registro_manual": {
          "id": 4,
          "operador": "Administrador Velox",
          "observacao": null,
          "observacao_condutor": null
        },
        "desafio_id": null,
        "solicitacao_cashback_id": null
      },
      {
        "data_hora": "2026-10-07T12:51:48-03:00",
        "valor": -1.5,
        "pessoa": {
          "tipo": "condutor",
          "nome": "Carlos Silva"
        },
        "tipo_operacao": "saque",
        "operacao_descricao": "Saque via central",
        "descricao": "Operador: Administrador Velox",
        "estornado": false,
        "registro_manual": {
          "id": 2,
          "operador": "Administrador Velox",
          "observacao": null,
          "observacao_condutor": null
        },
        "desafio_id": null,
        "solicitacao_cashback_id": null
      }
    ],
    "processamento_mchpay": "OK"
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

api-key

string

header

required

Obrigatório. Sua chave API.

Query Parameters

data_ini

string<date>

Início do período (YYYY-MM-DD), no fuso da central. Precisa estar nos últimos 6 meses. Obrigatório, exceto com solicitacao_id ou registro_manual_id.

Example:

"2026-10-01"

data_fim

string<date>

Fim do período (YYYY-MM-DD), no fuso da central. No máximo 31 dias depois de data_ini. Obrigatório, exceto com solicitacao_id ou registro_manual_id.

Example:

"2026-10-07"

pagina

integer

default:1

Página, a partir de 1. Cada página traz até 10 lançamentos.

Required range: x >= 1

Example:

1

tipo

enum<string>

default:T

Aba do extrato: T todos, C solicitações, B benefícios, R recargas, S saques, P passe livre. P só traz lançamentos quando a central tem o passe livre habilitado; nas demais, a lista vem vazia.

Available options:

T,

C,

B,

R,

S,

P

Example:

"R"

subfiltros[]

enum<string>[]

Subfiltros do extrato (ver tabela acima). Pode ser repetido.

Available options:

todos,

ganhos-app,

ganhos-pix,

ganhos-voucher,

ganhos-eticket,

ganhos-carteira-credito,

ganhos-presencial,

ganhos-cupom,

consumo-taxas-central,

cashback,

desafios,

indicacao,

taxas-repassadas,

recarga-pix,

recarga-central,

saque-central,

saque-pix

Example:

["recarga-central"]

situacao

enum<string>

Com subfiltros: T todos, R recebidos (créditos), E retirados (débitos). Vale para os subfiltros de ganhos, consumo, benefícios e taxas; nos de recarga e saque não tem efeito. Sem subfiltro aplicável (ausente, todos ou só subfiltros indisponíveis para a central), valor diferente de T responde 400.

Available options:

T,

R,

E

Example:

"R"

tipo_usuario[]

enum<string>[]

Com subfiltros de recarga e saque: T todos, C passageiros, M condutores, E empresas. Pode ser repetido. Sem subfiltro aplicável (ausente, todos ou só subfiltros indisponíveis para a central), valor diferente de T responde 400.

Available options:

T,

C,

M,

E

Example:

["M"]

taxista_id

integer

Extrato de um condutor da central.

Required range: x >= 1

Example:

1

cliente_id

integer

Extrato de um passageiro da central. Não combina com taxista_id.

Required range: x >= 1

Example:

4

empresa_id

integer

Extrato de uma empresa da central. Com taxista_id ou cliente_id, filtra os lançamentos deles com essa empresa.

Required range: x >= 1

Example:

2

solicitacao_id

integer

Lançamentos de uma corrida ou entrega da central, no período da própria solicitação: data_ini e data_fim são opcionais e, se enviadas, ignoradas. A solicitação precisa ser dos últimos 6 meses. Não combina com registro_manual_id.

Required range: x >= 1

Example:

632

registro_manual_id

integer

Lançamentos de uma recarga ou saque manual da central, a partir da data do registro: data_ini e data_fim são opcionais e, se enviadas, ignoradas. O registro precisa ser dos últimos 6 meses.

Required range: x >= 1

Example:

4

Response

Lançamentos da página. pessoa.tipo é condutor, cliente ou empresa; pessoa, registro_manual, desafio_id e solicitacao_cashback_id vêm null quando não se aplicam. valor segue o ponto de vista da pessoa do lançamento, como na tela: positivo quando ela recebe créditos (recarga, ganhos) e negativo quando perde (saque, taxa).

The response is of type object.

Introdução

Corridas

Clientes

Dinâmicas

Condutores

Empresas

Financeiro

Cupons

Configurações

Notificação

Webhooks

Mensagens

Engajamento

Consultar extrato de créditos

Authorizations

Query Parameters

Response