> ## Documentation Index
> Fetch the complete documentation index at: https://docs.machine.global/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml pages/v2/openapi-corridas.json GET /financeiro/extrato
openapi: 3.1.0
info:
  title: API de Integração
  description: API de Integração v2 - Corridas
  license:
    name: MIT
  version: 2.0.0
servers:
  - url: https://api-vendas.taximachine.com.br/api/v2/integracao
  - url: https://api.taximachine.com.br/api/v2/integracao
security:
  - basicAuth: []
    ApiKeyAuth: []
paths:
  /financeiro/extrato:
    get:
      summary: Consultar extrato de créditos
      description: >-
        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.
      parameters:
        - name: data_ini
          in: query
          description: >-
            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`.
          schema:
            type: string
            format: date
            example: '2026-10-01'
        - name: data_fim
          in: query
          description: >-
            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`.
          schema:
            type: string
            format: date
            example: '2026-10-07'
        - name: pagina
          in: query
          description: Página, a partir de 1. Cada página traz até 10 lançamentos.
          schema:
            type: integer
            minimum: 1
            default: 1
            example: 1
        - name: tipo
          in: query
          description: >-
            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.
          schema:
            type: string
            enum:
              - T
              - C
              - B
              - R
              - S
              - P
            default: T
            example: R
        - name: subfiltros[]
          in: query
          description: Subfiltros do extrato (ver tabela acima). Pode ser repetido.
          schema:
            type: array
            items:
              type: string
              enum:
                - 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
        - name: situacao
          in: query
          description: >-
            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.
          schema:
            type: string
            enum:
              - T
              - R
              - E
            example: R
        - name: tipo_usuario[]
          in: query
          description: >-
            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.
          schema:
            type: array
            items:
              type: string
              enum:
                - T
                - C
                - M
                - E
            example:
              - M
        - name: taxista_id
          in: query
          description: Extrato de um condutor da central.
          schema:
            type: integer
            minimum: 1
            example: 1
        - name: cliente_id
          in: query
          description: Extrato de um passageiro da central. Não combina com `taxista_id`.
          schema:
            type: integer
            minimum: 1
            example: 4
        - name: empresa_id
          in: query
          description: >-
            Extrato de uma empresa da central. Com `taxista_id` ou `cliente_id`,
            filtra os lançamentos deles com essa empresa.
          schema:
            type: integer
            minimum: 1
            example: 2
        - name: solicitacao_id
          in: query
          description: >-
            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`.
          schema:
            type: integer
            minimum: 1
            example: 632
        - name: registro_manual_id
          in: query
          description: >-
            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.
          schema:
            type: integer
            minimum: 1
            example: 4
      responses:
        '200':
          description: >-
            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).
          content:
            application/json:
              schema:
                type: object
              example:
                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
        '400':
          description: Parâmetro inválido
          content:
            application/json:
              schema:
                type: object
              examples:
                data_obrigatoria:
                  summary: Data ausente
                  value:
                    success: false
                    errors:
                      - code: 2
                        message: '''data_fim'': Preenchimento obrigatório'
                data_invalida:
                  summary: Data fora do formato ou inexistente
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: >-
                          'data_ini': Deve ser uma data válida no formato
                          YYYY-MM-DD.
                periodo_invertido:
                  summary: data_ini depois de data_fim
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: '''data_ini'': Deve ser anterior ou igual a ''data_fim''.'
                periodo_maximo:
                  summary: Período maior que 31 dias
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: >-
                          'data_fim': O período entre 'data_ini' e 'data_fim'
                          pode ter no máximo 31 dias.
                fora_da_janela:
                  summary: data_ini antes dos últimos 6 meses
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: >-
                          'data_ini': O extrato só está disponível para os
                          últimos 6 meses.
                inteiro_invalido:
                  summary: Id ou página que não é inteiro positivo
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: '''taxista_id'': Deve ser um número inteiro positivo.'
                valor_invalido:
                  summary: Valor fora da lista aceita
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: >-
                          'tipo': Deve estar dentre os valores: T, C, B, R, S,
                          P.
                registro_com_solicitacao:
                  summary: registro_manual_id junto com solicitacao_id
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: >-
                          'registro_manual_id': Não pode ser combinado com
                          'solicitacao_id'.
                solicitacao_fora_da_janela:
                  summary: Solicitação ou registro manual de antes dos últimos 6 meses
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: >-
                          'solicitacao_id': O extrato só está disponível para os
                          últimos 6 meses.
                cliente_com_condutor:
                  summary: cliente_id junto com taxista_id
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: '''cliente_id'': Não pode ser combinado com ''taxista_id''.'
                filtro_nao_suportado:
                  summary: >-
                    categoria_id ou tipo_pagamento_id, filtros da tela que a API
                    não aplica
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: '''categoria_id'': Filtro não suportado pela API.'
                situacao_sem_subfiltro:
                  summary: situacao ou tipo_usuario sem subfiltro aplicável
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: >-
                          'situacao': Só pode ser usado com 'subfiltros'
                          disponíveis para a central.
        '401':
          description: Gestor não autenticado pelo HTTP Basic
          content:
            application/json:
              schema:
                type: object
              example:
                success: false
                errors:
                  - code: B5
                    message: Usuário e/ou senhas inválidos.
        '403':
          description: Gestor sem acesso ao extrato
          content:
            application/json:
              schema:
                type: object
              examples:
                sem_permissao:
                  summary: >-
                    Gestor sem a permissão API - Carteira de créditos, ou gestor
                    de empresa
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: >-
                          O usuário informado não tem permissão para realizar
                          essa operação.
                sem_machinepay:
                  summary: Central sem MachinePay habilitado
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: O MachinePay não está habilitado para esta central.
        '404':
          description: Filtro que não é da central
          content:
            application/json:
              schema:
                type: object
              examples:
                condutor:
                  summary: Condutor de outra central
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: '''taxista_id'': Não encontrado na bandeira.'
                cliente:
                  summary: Passageiro de outra central
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: '''cliente_id'': Não encontrado na bandeira.'
                empresa:
                  summary: Empresa de outra central
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: '''empresa_id'': Não encontrado na bandeira.'
                solicitacao:
                  summary: Solicitação de outra central
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: '''solicitacao_id'': Não encontrado na bandeira.'
                registro_manual:
                  summary: Registro manual de outra central
                  value:
                    success: false
                    errors:
                      - code: 0
                        message: '''registro_manual_id'': Não encontrado na bandeira.'
        '500':
          description: Falha ao consultar o extrato
          content:
            application/json:
              schema:
                type: object
              example:
                success: false
                errors:
                  - code: 0
                    message: Falha na operação
        '503':
          description: Extrato temporariamente indisponível
          content:
            application/json:
              schema:
                type: object
              example:
                success: false
                errors:
                  - code: 0
                    message: >-
                      O extrato está temporariamente indisponível. Tente
                      novamente mais tarde.
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: Obrigatório. Sua chave API.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.