Jump to Content
API Reference
v1
v2
v3
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1
API Reference
Listar Municípios
Search
JUMP TO
About Us
Fix Pay
Pix
FlashLink
SafeLink
Fix Pay Sign
E-Commerce
Fix Seller
EDI
Empresa Âncora
Autenticação das Rotas - Versão 01 (v1)
Pix
SafeLink e FlashLink
Link Boletos
Portal
Fix Pay Sign
E-Commerce
Fix Seller
EDI
Empresa Âncora
Bandeiras
GPOS7000
Recebimentos
Empresas Parceiras
Authentication
Sign In
post
Pix
Buscar Pix por txID
get
Retornar Último Pix por Serial
get
Retornar Pix por Serial
get
Retornar QR Code
get
Gerar Pix
post
Gerar por Dia
post
Expirar Pix
post
Estornar Pix
post
Safelink e Flashlink
Sobre
Rotas
Retornar Links
Retornar Link por Estabelecimento
get
Retornar Link por Grupo
get
Retornar Link por Token
get
Expirar um Link
get
Retornar Telas Safelink
Retornar Tela de Falha Safelink
get
Retornar Tela de Sucesso Safelink
get
Retornar Tela de Carregamento Safelink
get
Gerar Link
Gerar Flashlink
post
Gerar Safelink
post
Cancelar Link
put
link boleto
Introdução ao Link Boletos
Retornar Dados Link-Boleto
get
Gerar Link-Boleto
post
Gateway Boleto
Retornar Tela Pagamento da Assinatura
get
Retornar Tela Pagamento da Fatura
get
Gerar Extrato ABC Brasil
post
PORTAL
Antecipação
Listar Vendas Disponíveis
get
Retornar Valor Disponível
get
Retornar Valor Disponível das Vendas Gateway
get
Retornar Relatório de Antecipações
get
Criar Antecipação
post
Authentication
Entrar
post
Alterar Senha
post
Atualizar Senha
put
Boleto
Listar Boletos
get
Calendario Feriado
Listar Feriados
get
Capturas
Listar Capturas
get
Clientes
Listar Clientes
get
Buscar Clientes por ID
get
Contratos
Retornar Contrato
get
E-commerce
Listar Vendas
get
Listar Pix por Grupo
get
Listar Boleto por Grupo
get
Retornar Dados Sobre as Vendas
get
Retornar Contagem de Pedidos
get
Retornar Status da Venda
post
Estabelecimentos
Listar Estabelecimentos
get
Buscar Estabelecimento por ID
get
Retornar Grupo
get
Retornar Endereço
get
Retornar Dados do Estabelecimento
get
Retornar Taxas por Estabelecimento
get
Retornar Taxa Direta
get
Retornar Dirf
get
Editar Apelido por CPF ou CNPJ
put
Extratos
Retornar Saldo Disponível
get
Retornar Extrato por Estabelecimento
get
Retornar Lançamentos Futuros por Grupo
get
Retornar Valor do Plano, Aluguel e Outros
get
Grupos
Listar Grupos
get
Meus Dados
Retornar Aluguel Máquina
get
Pacotes
Listar Pacotes de SMS
get
Listar Histórico de SMS
get
Comprar Pacotes de SMS
post
Pesquisa NPS
Retornar Pesquisa do Mês Corrente
get
Editar Pesquisa
put
Pix
Listar Pix
get
Listar Pix Dashboard
get
Planos
Listar Planos
get
Buscar plano por ID
get
Retornar Produtos por Plano
get
Planos Taxas
Retornar Taxas por Plano
get
Solicitações
Criar Solicitação
post
Vendas
Retornar Vendas por Mês
get
Retornar Vendas por Parcelas
get
Retornar Vendas Pix
get
Retornar Vendas Cartão
get
Retornar Vendas por Estabelecimento
get
Retornar Total Vendas
get
Retornar Status Vendas
get
Retornar Ticket Médio
get
Retornar Detalhes por NSU
get
Webhook
Atualizar Contrato Docsales
post
Fix Sign
Assinaturas
Listar Assinaturas
get
Listar Cobranças de Assinatura
get
Buscar Assinatura por ID
get
Retornar Assinatura por Plano
get
Retornar Método de Pagamento
get
Retornar Boleto de Pagamento
get
Retornar Totalizador de Assinatura
get
Retornar Relatório de Faturamento
get
Retornar Tela Troca de Cartão
get
Buscar Cartão de Crédito por Assinatura
get
Reenviar E-mail
get
Exportar CSV
get
Exportar XLXS
get
Importar CSV
post
Criar Assinatura
post
Cancelar Assinatura
post
Alterar Cartão
post
Retornar tela sucesso na troca de cartão
post
Realizar Cobrança Manual
post
Ativar/Desativar Assinatura
put
Editar Assinatura
put
Expirar Assinatura
put
Deletar Assinatura
delete
Assinaturas - Pix
Retornar Status do Pix
get
Retornar Tela Pagamento por Pix
get
Retornar Tela de Sucesso no Pagamento
post
Antecipações
Listar Vendas Disponíveis
get
Retornar Valor Disponível
get
Clientes
Listar Clientes por Grupo
get
Listar Inadimplências por Cliente
get
Buscar Cliente por ID
get
Retornar Totalizador de Clientes
get
Exportar CSV
get
Exportar XLSX
get
Importar CSV
post
Criar Cliente
post
Ativar/Desativar Cliente
put
Editar Cliente
put
Deletar Cliente
delete
Configuração
Listar Configurações por Grupo
get
Buscar Configurações por ID
get
Criar Configuração
post
Pesquisar Cupom
post
Alterar Logo
post
Deletar Logo
post
Habilitar/Desabilitar Pix
put
Habilitar/Desabilitar Cartão
put
Habilitar/Desabilitar Boleto
put
Editar Configuração
put
Editar Envio de E-mails
put
Deletar Configuração
delete
Dashboard
Listar Clientes Ativos
get
Listar Melhores Planos
get
Listar Novas Assinaturas
get
Listar Encargos por Mês
get
Retornar Ticket Médio
get
Retornar Número de Cobranças
get
Retornar Totalizador Recebíveis
get
Fatura
Listar Faturas
get
Buscar Faturas por ID
get
Retornar Fatura Paga com Cartão de Crédito
get
Retornar Totalizador de Faturas
get
Retornar Relatório de Cobrança da Fatura
get
Calcular Penalidades e Taxas
get
Enviar E-mail
get
Cancelar Fatura
post
Expirar Fatura
post
Relacionar Produto a Uma Fatura
post
Realizar Baixa Manual da Fatura
put
Gerar Segunda Via da Fatura
put
Deletar Fatura
delete
Fatura - Pix
Retornar Status do Pix
get
Retornar Tela Pagamento por Pix
get
Retornar Tela Sucesso no Pagamento
post
Faturamento
Retornar Cobrança a Vencer
get
Exportar CSV
get
Exportar XLSX
get
Histórico de Assinaturas
Buscar Histórico de Assinaturas por ID
get
Listar Histórico de Assinaturas
get
Listar Histórico de Cobranças
get
Listar Cobranças Vencidas
get
Item Extra de Assinaturas
Listar Itens Extras
get
Buscar Itens Extras por ID
get
Criar Item Extra
post
Editar Item Extra
put
Municípios
Listar Municípios
get
Buscar Município por Nome
get
Planos
Listar Recorrências por Estabelecimento
get
Listar Planos
get
Listar Planos por Produto
get
Listar Planos por Grupo
get
Buscar Plano por ID
get
Buscar Plano por Assinatura
get
Exportar XLSX
get
Exportar CSV
get
Importar CSV
post
Criar Plano
post
Editar Plano
put
Ativar/Desativar Plano
put
Deletar Plano
delete
Produtos
Listar Produtos
get
Buscar Produto por Id
get
Buscar Produtos por Grupo e Plano
get
Exportar XSLX
get
Exportar CSV
get
Importar CSV
post
Criar Produto
post
Editar Produto
put
Ativar/Desativar Produto
put
Deletar Produto
delete
Produto com plano
Listar Produtos por Plano
get
Verificar Relação Produto a um Plano
get
Relacionar Produto a um Plano
post
Import CSV
post
Deletar Produto de um Plano
delete
Relatórios
Cartão de Crédito
Listar Clientes
get
Listar Detalhes das Transações
get
Exportar CSV
get
Exportar XLSX
get
Planos
Listar Faturamento por Plano
get
Exportar CSV
get
Exportar XLSX
get
Produtos
Listar Faturamento por Mês
get
Listar Cobranças Vencidas
get
Retornar Detalhes de Cobranças Vencidas
get
Retornar Totalizador de Produtos
get
Telas de Pagamento
Retornar Tela Pagamento Assinatura
get
Retornar Tela Pagamento Fatura
get
Retornar Tela Sucesso no Pagamento Assinatura
post
Retornar Tela Sucesso no Pagamento Fatura
post
Timeline
Retornar Timeline Assinatura
get
Retornar Timeline Fatura
get
Retornar Timeline Plano
get
Retornar Timeline Produto
get
Criar Timeline Assinatura
post
Criar Timeline Fatura
post
Criar Timeline Plano
post
Criar Timeline Produto
post
Usuário
Listar Usuários
get
Buscar Usuário por ID
get
Entrar
post
Criar Usuário
post
Enviar Nova Senha
post
Ativar/Desativar Usuário
put
Editar Usuário
put
Editar Senha
put
Deletar Usuário
delete
Recebimentos
Listar Operações por Dia
get
Listar Operações por Bandeiras
get
Retornar Valor Confirmado
get
Retornar Valor Compensado
get
Exportar XLXS
get
E-Commerce
Assinatura
Buscar Assinatura por Filtro
get
Buscar Assinatura por ID
get
Listar Assinaturas
get
Listar Vendas
get
Listar Cobranças Vencidas
get
Retornar Faturamento por Assinatura
get
Criar Assinatura
post
Criar e Aderir Assinatura
post
Ativar/Desativar Assinatura
put
Expirar Assinatura
put
Cartão
Retornar Bandeira
get
Calcular Parcelas Disponíveis
get
Cancelar Venda
get
Retornar Status
post
Salvar Cartão
post
Deletar Cartão
delete
Clientes
Listar Clientes
get
Buscar Cliente por ID
get
Planos
Listar Planos
get
Buscar Plano por ID
get
Buscar Produtos do Plano por ID
get
Plugin
Listar Informações das Vendas
get
Retornar Status
post
Vendas
Listar Informações das Vendas
get
Listar Vendas do Ano
get
Retornar Status
post
Retornar Status Pix
post
Boleto
Retornar status
post
Genérico
Listar Contas Vencidas
get
Retornar Antifraude
get
Entrar com Token
post
Aprovar Venda
post
Webhook - Status Pedido
Fix Seller
Agendamentos
Retornar Agendamentos
get
Retornar Agendamentos por ID
get
Buscar Agendamentos por Usuário
get
Criar Agendamento
post
Finalizar Agendamento
post
Editar Agendamento
put
Deletar Agendamento
delete
Authentication
Entrar
post
Checkin
Buscar Check-in por ID
get
Listar Check-in Não Relacionados
get
Criar Chekin
post
Concorrente
Listar Concorrentes
get
Buscar Concorrentes por ID
get
Ficha de Credenciamentos
Retornar Ficha por Usuário
get
Retornar Totalizadores por Usuário
get
Verificar CNPJ na Receita
get
Criar Ficha de Credenciamento
post
Editar Ficha de Credenciamento
post
Atualizar Imagem da Fachada
post
Motivo Visita
Retornar Motivo Visita
get
Buscar Motivo Visita por ID
get
Pacotes
Listar Planos
get
Retornar Plano por Nome
get
Representante
Retornar Representante
get
Seguimentos
Listar Seguimentos
get
Supervisor
Buscar Supervisor por ID
get
Retornar Representantes por Supervisor
get
Retornar Visitas por Supervisor
get
Vendedores
Listar Vendedores
get
Criar Vendedor
post
Editar Vendedor
put
Deletar Vendedor
delete
Visita
Retornar Visitas
get
Buscar Visita por Contato
get
Criar Visita
post
Editar Visita
put
Contato
Retornar Contatos
get
Buscar Contato por ID
get
Buscar Contato por Usuário
get
Buscar Contato por Nome, CNPJ ou CPF
get
Mapear Contato
get
Criar Contato
post
Editar Contato
put
Editar Parcialmente Contato
put
Deletar Contato
delete
EDI
Retornar Extrato por Estabelecimento
get
Retornar Lançamentos
post
Retornar Vendas
post
Empresa Âncora
Dashboard
Retornar Valores Confirmados
get
Retornar Ticket Médio
get
Retornar Recebimentos Futuros
get
Retornar Recebimentos do Dia Atual
get
Retornar Recebimentos Crédito e Débito
get
Retornar Vendas por Estabelecimento
get
Retornar Vendas por Bandeira
get
Retornar Vendas do Dia Atual
get
Retornar Vendas da Semana
get
Retornar Venda por Mês
get
Extratos
Retornar Extrato
get
Retornar Balanço Disponível
get
Retornar Lançamentos Futuros
get
Exportar Extrato
get
Meus Dados
Retornar Empresa Âncora
get
Retornar Dados Bancários
get
Retornar Endereço
get
Retornar Porcentagem do Pagamento
get
Recebimentos
Listar Feriados
get
Listar Valores Confirmados
get
Listar Valores Compensados
get
Listar Valores
get
Listar Transações
get
Exportar Recebíveis
get
Valor/Transações
Retornar Valor Total
get
Listar Transações
get
Vendas
Listar Vendas
get
Retornar Venda por NSU
get
Retornar Parcelas por Venda
get
Retornar Total das Vendas
get
Bandeiras
Bandeiras
Listar Bandeiras
get
Retornar Valor Total por Bandeiras
get
Retornar ID da Bandeira por Bin
get
Bancos
Listar Bancos
get
Contas Bancárias
Listar Contas por Estabelecimento
get
Contestação de Vendas
Listar Vendas Disputa Chargeback
get
Listar Log Disputa Chargeback
get
Criar Contestação Vendas
post
GPOS700
Listar Integradoras
get
Listar Operadoras
get
Listar Modelos de Terminais
get
Listar Terminais
get
Listar Terminais por Grupo
get
Buscar Terminal por Serial
get
Editar Nome do Terminal
put
Recebimentos
Recebíveis
Retornar Recebíveis do Dia
get
Retornar Recebíveis da Semana
get
Retornar Recebíveis do Mês
get
Retornar Recebíveis por Débito
get
Retornar Recebíveis por Boleto
get
Retornar Recebíveis por Crédito
get
Retornar Recebíveis por Pix
get
Retornar Recebíveis por Bandeira
get
Retornar Recebíveis Futuros
get
Retornar Total dos Recebíveis
get
Listar Recebíveis
get
Listar Operações por Dia
get
Listar operações por Dia Pix
get
Listar Operações por Dia Boleto
get
Listar Operações por Bandeira
get
Listar Operações Empresa Âncora
get
Listar Valor Confirmado
get
Listar Valor Confirmado Empresa Âncora
get
Listar Valor Compensado
get
Listar Valor Compensado Empresa Âncora
get
Listar Feriados
get
Exportar XLSX
get
Realizar Conciliação Bancária
post
Empresas Parceiras
Buscar estabelecimento por CPF/CNPJ
get
Criar Estabelecimento
post
Editar Estabelecimento
put
Alterar Chaveamento Pix
put
Webhook - Status PIX
Webhook - Liquidação
Introdução à sua API
Introdução à sua API
Powered by
Listar Municípios
get
https://apis.fixpay.com.br/v1/cities
Retorna todos os municípios do pais.
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!