Para poder realizar a utilização das rotas, implementamos uma autenticação garantindo que os ECs acessem somente seus respectivos dados. Dentro da Fix Pay temos dois tipos de autenticação, sendo elas:
- Token Authorization
As rotas que utilizam este tipo de verificação necessitam realizar o login no nosso Portal, através da rota Sign In. Ao realizar o login será gerado um Token temporário que permitirá a utilização de algumas rotas. - Token API
As rotas que utilizam este tipo de verificação, não necessitam realizar o login, bastam utilizar o Token API, sendo ele um Token único que é disponibilizado para cada Ec.
Obs.: As rotas nas quais a autenticação está preenchida como "Token API *", são as rotas que utilizamos apenas o Token, já as que não possuem, a autenticação é feita desta forma: "Bearer $TokenAPI".
Abaixo temos as rotas separadas por Módulo e Categoria, especificando qual a sua devida autenticação.
1.0 - EDI
| Nome da Rota | URL da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Consulta de Lançamento | https://apis.fixpay.com.br/v1/edi/extracts | 🔗 Consulta de Lançamento | Token API * |
| Consulta de Venda | https://apis.fixpay.com.br/v1/edi/sales | 🔗 Consulta de Venda | Token API * |
2.0 - PIX
| Nome da Rota | URL da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Gerar Pix | https://pix.fixpay.com.br:3467/v1/generate_pix | 🔗Gerar Pix | Token API |
| Gerar por Dia | https://pix.fixpay.com.br:3467/v1/generate_pix_per_day | 🔗Gerar por Dia | Token API |
| Consultar Qr Code | https://pix.fixpay.com.br:3467/v1/consult_pix_qrcode/{txId} | 🔗 Consultar Qr Code | Token API |
| Consultar por txID | https://pix.fixpay.com.br:3467/v1/consult_pix/{txId} | 🔗 Consultar por txID | Token API |
| Consultar Último Pix por Serial | https://apis.fixpay.com.br/v1/consult_pix_per_serial/{serial} | 🔗 Consultar Último Pix por Serial | Token API |
| Consultar Pix por Serial | https://apis.fixpay.com.br/v1/report_sales_pix_per_serial/{date}/{serial} | 🔗 Consultar Pix por Serial | Token API |
| Filtrar Pix Itaú | https://apis.fixpay.com.br/v1/pixitauperestabelecimento/{grupoId} | 🔗 Filtrar Pix Itaú | Token Authorization |
| Consultar Pix Itau Dashboard | https://apis.fixpay.com.br/v1/pixiperestabelecimentodashboard/{grupoId} | 🔗 Consultar Pix Itau Dashboard | Token Authorization |
3.0 - LINK BOLETOS
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Gerar | https://boleto.fixpay.com.br:4876/v1/link_billet/generation | 🔗 Gerar | Token API |
| Consultar | https://boleto.fixpay.com.br:4876/v1/link_billet/consult/{token} | 🔗 Consultar | Token API |
3.1 - Gateway Boleto
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Geração de Extrato | https://boleto.fixpay.com.br:4876/webhookabcbrasil/extract/generation | 🔗 Geração de Extrato | ❌ |
| Pagamento de Assinaturas | https://boleto.fixpay.com.br:4876/signature/{groupId}/{token} | 🔗 Pagamento de Assinaturas | ❌ |
| Checkout de Faturas | https://boleto.fixpay.com.br:4876/invoice/{groupId}/{token} | 🔗 Checkout de Faturas | ❌ |
4.0 - E-COMMERCE
4.1 - Assinaturas
4.2 - Cartão
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Calcular Parcelas Disponíveis | https://apisecommerce.fixpay.com.br:8645/v1/pluginpayment/compute/{amount}/{installments}/{brand} | 🔗 Calcular Parcelas Disponíveis | Token API |
| Consultar Bandeira | https://apisecommerce.fixpay.com.br:8645/v1/bandeira/checkbin/{bin} | 🔗 Consultar Bandeira | Token API |
| Cancelar Venda | https://apisecommerce.fixpay.com.br:8645/v1/pluginpayment/requestcancellation/{token}/{tid}/{valor} | 🔗 Cancelar Venda | ❌ |
| Consultar Status | https://apisecommerce.fixpay.com.br:8645/v1/ecommerces/salesconsultationstatus | 🔗 Consultar Status | Token API |
| Salvar Cartão | https://apisecommerce.fixpay.com.br:8645/v1/card | 🔗 Salvar Cartão | Token API |
| Deletar Cartão | https://apisecommerce.fixpay.com.br:8645/v1/card/{token_gerado} | 🔗 Deletar Cartão | Token API |
4.3 - Clientes
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Clientes | https://apisecommerce.fixpay.com.br/v1/signatures/client | 🔗 Listar Clientes | Token API |
| Listar Cliente por ID | https://apisecommerce.fixpay.com.br/v1/signatures/client/{id} | 🔗 Listar Cliente por ID | Token API |
4.4 - Genérico
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Entrar com Token | https://apisecommerce.fixpay.com.br:8645/v1/signwithtoken | 🔗 Entrar com Token | ❌ |
| Consultar Antifraude | https://apisecommerce.fixpay.com.br:8645/v1/ecommerces/checkantifraude | 🔗 Consultar Antifraude | Token API |
| Aprovar venda | https://apisecommerce.fixpay.com.br:8645/v1/ecommerces/approveorder/masterpassword | 🔗 Aprovar venda | Token API |
| Listar Contas Vencidas | https://apisecommerce.fixpay.com.br/v1/signatures/overduebillslist/{signatureId} | 🔗 Listar Contas Vencidas | Token API |
4.5 - Planos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Plano por ID | https://apisecommerce.fixpay.com.br:8645/v1/signatures/plan/product/{planId} | 🔗 Listar Plano por ID | Token API |
| Listar Planos | https://apisecommerce.fixpay.com.br/v1/signatures/plan | 🔗 Listar Planos | Token API |
| Filtrar Planos | https://apisecommerce.fixpay.com.br/v1/signatures/plan/{id} | 🔗 Filtrar Planos | Token API |
4.4 - Plugin
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Consultar Status | https://apis.fixpay.com.br/v1/ecommerces/salesconsultationstatus | 🔗 Consultar Status | Token API |
| Listar Vendas | https://apis.fixpay.com.br/v1/ecommerces/consultdashboard/ | 🔗 Listar Vendas | Token API |
4.5 - Vendas
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Consultar Status | https://apisecommerce.fixpay.com.br:8645/v1/ecommerces/salesconsultationstatus | 🔗 Consultar Status | Token API |
| Listar Vendas | https://apisecommerce.fixpay.com.br:8645/v1/ecommerces/consultdashboard | 🔗 Listar Vendas | Token API |
| Listar Vendas do Ano Atual | https://apisecommerce.fixpay.com.br:8645/v1/ecommerces/consultdashboard | 🔗 Listar Vendas do Ano Atual | Token API |
| Consultar Status Pix | https://apisecommerce.fixpay.com.br:8645/v1/ecommerces/salesconsultationstatuspix | 🔗 Consultar Status Pix | Token API |
5.0 - FIX SIGN
5.1 - Assinaturas
5.2 - Assinaturas - Pix
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Tela de Assinatura | https://signpayments.fixpay.com.br/signature/pix/{grupoId}/{token} | 🔗 Tela de Assinatura | ❌ |
| Tela de Sucesso no Pagamento | https://signpayments.fixpay.com.br/signature/pix/{grupoId}/{token} | 🔗 Tela de Sucesso no Pagamento | ❌ |
| Consultar Pix | https://signpayments.fixpay.com.br/signature/consultpix/{txId} | 🔗 Consultar Pix | Token API |
5.3 - Antecipações
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Valor Disponível | https://apis.fixpay.com.br/v1/signature/antecipacao/amountavailableforadvancepaymentgatewaysales/{grupoId} | 🔗 Valor Disponível | Token Authorization |
| Vendas Disponíveis | https://apis.fixpay.com.br/v1/signature/antecipacao/salesattentivenessestabelecimentopaymentgateway/{groupId} | 🔗 Vendas Disponíveis | Token Authorization |
5.4 - Clientes
5.5 - Configuração
5.6 - Dashboard
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Clientes | https://apis.fixpay.com.br/v1/signature/dashboard/client/{groupId} | 🔗 Listar Clientes | Token Authorization |
| Melhores Planos | https://apis.fixpay.com.br/v1/signature/dashboard/bestplans/{groupId} | 🔗 Melhores Planos | Token Authorization |
| Novas Assinaturas | https://apis.fixpay.com.br/v1/signature/dashboard/newssignatures/{groupId} | 🔗 Novas Assinaturas | Token Authorization |
| Ticket Médio | https://apis.fixpay.com.br/v1/signature/dashboard/averageticket/{groupId} | 🔗 Ticket Médio | Token Authorization |
| Número de Cobranças | https://apis.fixpay.com.br/v1/signature/dashboard/numberofcharges/{groupId} | 🔗 Número de Cobranças | Token Authorization |
| Encargos por Mês | https://apis.fixpay.com.br/v1/signature/dashboard/chargesmonthd/{groupId} | 🔗 Encargos por Mês | Token Authorization |
| Token Authorization | https://apis.fixpay.com.br/v1/signature/dashboard/received/{groupId} | 🔗 Recebíveis Total | Token Authorization |
5.7 - Fatura
5.8 - Fatura - Pix
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Tela de Fatura | https://signpayments.fixpay.com.br/paymentInvoice/pix/{token} | 🔗 Tela de Fatura | ❌ |
| Consultar Status Pix | https://signpayments.fixpay.com.br/paymentInvoice/consultpixinvoice/{txId} | 🔗 Consultar Status Pix | Token API |
| Tela de Pagamento Sucesso | https://signpayments.fixpay.com.br/paymentInvoice/pix/{token} | 🔗 Tela de Pagamento Sucesso | ❌ |
5.9 - Faturamento
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Cobrança a Vencer | https://apis.fixpay.com.br/v1/signature/billingtowin/{groupId} | 🔗 Cobrança a Vencer | Token Authorization |
| Exportar CSV | https://apis.fixpay.com.br/v1/signature/billingtowin/exportcsv/{groupId} | 🔗 Exportar CSV | Token Authorization |
| Exportar XLSX | https://apis.fixpay.com.br/v1/signature/billingtowin/exportxlsx/{groupId} | 🔗 Exportar XLSX | Token Authorization |
5.10 - Histórico de Assinaturas
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Histórico de Cobranças | https://apis.fixpay.com.br/v1/signature/overduebillslist/{groupId}/{signatureId} | 🔗 Histórico de Cobranças | Token Authorization |
| Listar Histórico Assinaturas | https://apis.fixpay.com.br/v1/signature/historic/{grupoId} | 🔗 Listar Histórico Assinaturas | Token Authorization |
| Busca Histórico por ID | https://apis.fixpay.com.br/v1/signature/historic/{groupId}/{signatureId} | 🔗 Busca Histórico por ID | Token Authorization |
5.11 - Item Extra de Assinaturas
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Criar Itens Extras | https://apis.fixpay.com.br/v1/signature/extraitem | 🔗 Criar Itens Extras | Token Authorization |
| Editar Itens Extras | https://apis.fixpay.com.br/v1/signature/extraitem/edititems/{groupId}/{signatureId} | 🔗 Editar Itens Extras | Token Authorization |
| Listar Itens Extras | https://apis.fixpay.com.br/v1/signature/extraitem/{groupId} | 🔗 Listar Itens Extras | Token Authorization |
| Itens Extras por Id | https://apis.fixpay.com.br/v1/signature/extraitem/{groupId}/{signatureId} | 🔗 Itens Extras por Id | Token Authorization |
5.12 - Municípios
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Municípios | https://apis.fixpay.com.br/v1/cities | 🔗 Listar Municípios | ❌ |
| Buscar Cidade Por Nome | https://apis.fixpay.com.br/v1/city/findbyname | 🔗 Buscar Cidade Por Nome | ❌ |
5.13 - Planos
5.14 - Produtos
5.15 - Produtos com Plano
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Produto com Plano | https://apis.fixpay.com.br/v1/signature/plan/product | 🔗 Produto com Plano | Token Authorization |
| Listar Produtos por Plano | https://apis.fixpay.com.br/v1/signature/plan/product/{planId} | 🔗 Listar Produtos por Plano | Deletar Produto de um PlanoToken Authorization |
| Deletar Produto de um Plano | https://apis.fixpay.com.br/v1/signature/plan/product/delete/{groupId}/{planId}/{productId} | 🔗 Deletar Produto de um Plano | Token Authorization |
| Check Produto | https://apis.fixpay.com.br/v1/signature/plan/product/checkproduct/{groupId}/{productId} | 🔗 Check Produto | Token Authorization |
| Import CSV | https://apis.fixpay.com.br/v1/signature/plan/product/importcsv | 🔗 Import CSV | Token Authorization |
5.16 - Relatórios - Cartão de Crédito
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Clientes | https://apis.fixpay.com.br/v1/signature/report/creditcard/clients/{groupId} | 🔗 Listar Clientes | Token Authorization |
| Listar Detalhes das Transações | https://apis.fixpay.com.br/v1/signature/report/creditcard/details/{groupId} | 🔗 Listar Detalhes das Transações | Token Authorization |
| Exportar Relátorio XLS | https://apis.fixpay.com.br/v1/signature/report/creditcard/exportxlsx/{groupId} | 🔗 Exportar Relátorio XLS | Token Authorization |
| Exportar Relatórios CSV | https://apis.fixpay.com.br/v1/signature/report/creditcard/exportcsv/{groupId} | 🔗 Exportar Relatórios CSV | Token Authorization |
5.17 - Relatórios - Planos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Faturamento por Plano | https://apis.fixpay.com.br/v1/signature/billingbyplan/{groupId} | 🔗 Faturamento por Plano | Token Authorization |
| Exportação XLSX de Faturamento | https://apis.fixpay.com.br/v1/signature/billingbyplan/exportxlsx/{groupId} | 🔗 Exportação XLSX de Faturamento | Token Authorization |
| Exportação CSV de Faturamento | https://apis.fixpay.com.br/v1/signature/billingbyplan/exportcsv/{groupId} | 🔗 Exportação CSV de Faturamento | Token Authorization |
5.18 - Relatórios - Produtos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Cobrança Vencida | https://apis.fixpay.com.br/v1/signature/product/report/billingoverdue/{groupId} | 🔗 Cobrança Vencida | Token Authorization |
| Totalizador de Produtos | https://apis.fixpay.com.br/v1/signature/product/report/billingoverdue/totalizer/{groupId} | 🔗 Totalizador de Produtos | Token Authorization |
| Detalhes de Cobrança | https://apis.fixpay.com.br/v1/signature/product/report/billingoverdue/details/{groupId} | 🔗 Detalhes de Cobrança | Token Authorization |
| Faturamento por Mês | https://apis.fixpay.com.br/v1/signature/product/report/billing/month/{groupId} | 🔗 Faturamento por Mês | Token Authorization |
5.19 - Telas de Pagamento - Assinaturas
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Pagamento de Assinatura com Sucesso | https://signpayments.fixpay.com.br/signature/{grupoId}/{token} | 🔗 Pagamento de Assinatura com Sucesso | ❌ |
| Pagamento de Assinatura | https://signpayments.fixpay.com.br/signature/{grupoId}/{token} | 🔗 Pagamento de Assinatura | ❌ |
5.20 - Telas de Pagamento - Faturas
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Pagamento de Fatura com Sucesso | https://signpayments.fixpay.com.br/paymentInvoice/{token} | 🔗 Pagamento de Fatura com Sucesso | ❌ |
| Pagamento de Fatura | https://signpayments.fixpay.com.br/paymentInvoice/{token} | 🔗 Pagamento de Fatura | ❌ |
5.21 - Timeline - Assinatura
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Criar Timeline Assinatura | https://apis.fixpay.com.br/v1/signature/timeline | 🔗 Criar Timeline Assinatura | Token Authorization |
| Timeline Assinatura | https://apis.fixpay.com.br/v1/signature/timeline/{groupId}/{signatureId} | 🔗 Timeline Assinatura | Token Authorization |
5.22 - Timeline - Fatura
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Criar Timeline Fatura | https://apis.fixpay.com.br/v1/signature/invoice/timeline | 🔗 Criar Timeline Fatura | Token Authorization |
| Timeline Fatura | https://apis.fixpay.com.br/v1/signature/invoice/timeline/{groupId}/{invoiceId} | 🔗 Timeline Fatura | Token Authorization |
5.23 - Timeline - Planos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Criar Timeline Plano | https://apis.fixpay.com.br/v1/signature/plan/timeline | 🔗 Criar Timeline Plano | Token Authorization |
| Timeline Plano | https://apis.fixpay.com.br/v1/signature/plan/timeline/{groupId}/{planoId} | 🔗 Timeline Plano | Token Authorization |
5.24 - Timeline Produtos - Produtos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Criar Timeline Produto | https://apis.fixpay.com.br/v1/signature/product/timeline/ | 🔗 Criar Timeline Produto | Token Authorization |
| Timeline Produto | https://apis.fixpay.com.br/v1/signature/product/timeline/{groupId}/{produtoId} | 🔗 Timeline Produto | Token Authorization |
5.25 - Usuários
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Sign In | https://apis.fixpay.com.br/v1/signature/signin | 🔗 Sign In | ❌ |
| Criar | https://apis.fixpay.com.br/v1/signature/user | 🔗 Criar | Token Authorization |
| Editar | https://apis.fixpay.com.br/v1/signature/user/edit | 🔗 Editar | Token Authorization |
| Alterar Senha | https://apis.fixpay.com.br/v1/signature/user/changepassword | 🔗 Alterar Senha | Token Authorization |
| Alterar Senha Sign | https://apis.fixpay.com.br/v1/signature/user/changepasswordsign | 🔗 Alterar Senha Sign | Token Authorization |
| Ativar/Desativar Usuário | https://apis.fixpay.com.br/v1/signature/user/enabledisable | 🔗 Ativar/Desativar Usuário | Token Authorization |
| Deletar | https://apis.fixpay.com.br/v1/signature/user/delete/{groupId}/{id} | 🔗 Deletar | Token Authorization |
| Listar | https://apis.fixpay.com.br/v1/signature/user/{groupId} | 🔗 Listar | Token Authorization |
| Listar por Id | https://apis.fixpay.com.br/v1/signature/user/{groupId}/{id} | 🔗 Listar por Id | Token Authorization |
5.26 - Recebimentos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Valor Confirmado | https://apis.fixpay.com.br/v1/signature/received/confirmedvalue/{grupoId} | 🔗 Valor Confirmado | Token Authorization |
| Valor Compensado | https://apis.fixpay.com.br/v1/signature/received/compensatedvalue/{groupId} | 🔗 Valor Compensado | Token Authorization |
| Listar Operações por Dia | https://apis.fixpay.com.br/v1/signature/received/operationslistperday/{groupId} | 🔗 Listar Operações por Dia | Token Authorization |
| Listar Operações por Bandeiras | https://apis.fixpay.com.br/v1/signature/received/operationslistperdaybandeiras/{groupId} | 🔗 Listar Operações por Bandeiras | Token Authorization |
| Exportar Recebíveis | https://apis.fixpay.com.br/v1/signature/received/exportitems/{groupId} | 🔗 Exportar Recebíveis | ❌ |
6.0 - PORTAL
6.1 - Antecipação
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Val. Disp. Vendas Fisic. | https://apis.fixpay.com.br/v1/antecipacao/amountavailableforanticipation/{grupo_id} | 🔗 Val. Disp. Vendas Fisic. | Token Authorization |
| Val. Disp. Vendas Gateway | https://apis.fixpay.com.br/v1/antecipacao/amountavailableforadvancepaymentgatewaysales/{grupo_id} | 🔗 Val. Disp. Vendas Gateway | Token Authorization |
| Venda Antecipação Estabelecimento | https://apis.fixpay.com.br/v1/antecipacao/salesattentiveestabelecimento/{grupo_id} | 🔗 Venda Antecipação Estabelecimento | Token Authorization |
| Criar Antecipação | https://apis.fixpay.com.br/v1/antecipacao | 🔗 Criar Antecipação | Token Authorization |
| Relatório de Antecipações | https://apis.fixpay.com.br/v1/antecipacao/relatorio/{grupoId} | 🔗 Relatório de Antecipações | Token Authorization |
6.2 - Authentication
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Logar | https://apis.fixpay.com.br/v1/signin | 🔗 Logar | ❌ |
| Atualizar Senha | https://apis.fixpay.com.br/v1/updatepassword/{id} | 🔗 Atualizar Senha | Token Authorization |
| Alterar Senha | https://apis.fixpay.com.br/v1/changepassword | 🔗 Alterar Senha | ❌ |
6.3 - Boleto
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Boletos | https://apis.fixpay.com.br/v1/boletoperestabelecimento/{grupoId} | 🔗 Listar Boletos | Token Authorization |
6.4 - Calendário Feriados
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Feriados | https://apis.fixpay.com.br/v1/calendarioferiados | 🔗 Listar Feriados | Token Authorization |
6.5 - Capturas
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Capturas | https://apis.fixpay.com.br/v1/captura | 🔗 Listar Capturas | Token Authorization |
6.6 - Clientes
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Clientes | https://apis.fixpay.com.br/v1/ecommerces/client | 🔗 Listar Clientes | Token API |
| Listar Clientes por ID | https://apis.fixpay.com.br/v1/ecommerces/client/{id} | 🔗 Listar Clientes por Id | Token API |
6.7 - Contratos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Retorna Contrato | https://apis.fixpay.com.br/v1/lieconcordo/contract/{grupo_id} | 🔗 Retorna Contrato | ❌ |
6.8 - E-Commerce
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Ecommerce Sales | https://apis.fixpay.com.br/v1/ecommerces/sales/{grupoId}/{captura} | 🔗 Ecommerce Sales | Token Authorization |
| Ecommerce Sales Consultation Status | https://apis.fixpay.com.br/v1/ecommerces/salesconsultationstatus | 🔗 Ecommerce Sales Consultation Status | Token API |
| Ecommerce Dashboard | https://apis.fixpay.com.br/v1/ecommerces/consultdashboard | 🔗 Ecommerce Dashboard | Token API |
| Ecommerce Dashboard Rate | https://apis.fixpay.com.br/v1/ecommerces/consultdashboardrate | 🔗 Ecommerce Dashboard Rate | Token API |
| Ecommerce Pix | https://apis.fixpay.com.br/v1/ecommerces/pixes/{grupoId} | 🔗 Ecommerce Pix | Token Authorization |
| Ecommerce Boleto | https://apis.fixpay.com.br/v1/ecommerces/boletos/{grupoId} | 🔗 Ecommerce Boleto | Token Authorization |
6.9 - Estabelecimentos
6.10 - Extratos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Extrato Estabelecimento | https://apis.fixpay.com.br/v1/extract/{cpfCnpj} | 🔗 Extrato Estabelecimento | Token Authorization |
| Saldo Disponível | https://apis.fixpay.com.br/v1/extract/balanceavailable/{cpfCnpj} | 🔗 Saldo Disponível | Token Authorization |
| Lançamentos Futuros | https://apis.fixpay.com.br/v1/extract/futurereleases/{grupoId} | 🔗 Lançamentos Futuros | Token Authorization |
| Extrato Plano Aluguel e Outros | https://apis.fixpay.com.br/v1/extract/planrentandothervaluesperday | 🔗 Extrato Plano Aluguel e Outros | Token Authorization |
6.11 - Grupos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Grupos | https://apis.fixpay.com.br/v1/grupos | 🔗 Listar Grupos | Token Authorization |
6.12 - Meus Dados
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| MyDataRent | https://apis.fixpay.com.br/v1/mydata/rent/{estabelecimentoId} | 🔗 MyDataRent | Token Authorization |
6.13 - Pacotes
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Pacotes SMS | https://apis.fixpay.com.br/v1/pacotes | 🔗 Listar Pacotes SMS | Token Authorization |
| Listar Histórico SMS | https://apis.fixpay.com.br/v1/compra_sms/{groupId}/{establishmentId} | 🔗 Listar Histórico SMS | Token Authorization |
6.14 - Pesquisa NPS
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Pesq. Mês Corrente | https://apis.fixpay.com.br/v1/pesquisa_satisfacao_nps/{grupoId} | 🔗 Pesq. Mês Corrente | Token Authorization |
| Alterar Pesquisa | https://apis.fixpay.com.br/v1/pesquisa_satisfacao_nps/save/{id} | 🔗 Alterar Pesquisa | Token Authorization |
6.15 - Planos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Planos | https://apis.fixpay.com.br/v1/ecommerces/plan | 🔗 Listar Planos | Token API |
| Listar Plano por ID | https://apis.fixpay.com.br/v1/ecommerces/plan/{id} | 🔗 Listar Plano por ID | Token API |
| Produtos por Plano | https://apis.fixpay.com.br/v1/ecommerces/plan/product/{planId} | 🔗 Produtos por Plano | Token API |
6.16 - Planos Taxas
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Consultar Plano Taxas | https://apis.fixpay.com.br/v1/planotaxas | 🔗 Consultar Plano Taxas | Token Authorization |
6.17 - Solicitações
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Criar Solicitação | https://apis.fixpay.com.br/v1/solicitation/{type} | 🔗 Criar Solicitação | Token Authorization |
6.18 - Vendas
6.19 - Webhook
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Docsales | https://apis.fixpay.com.br/v1/webhookdocsales | 🔗 Docsales | ❌ |
7.0 - BANDEIRAS
7.1 - Bandeiras
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Bandeiras | https://apis.fixpay.com.br/v1/bandeiras | 🔗 Listar Bandeiras | Token Authorization |
| Vendas por Bandeiras | https://apis.fixpay.com.br/v1/bandeirasbygrupoid/{grupo_id} | 🔗 Vendas por Bandeiras | Token Authorization |
| Buscar ID da Bandeira por Bin | https://apis.fixpay.com.br/v1/bandeira/checkbin/{bin} | 🔗 Buscar ID da Bandeira por Bin | ❌ |
7.2 - Bancos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Bancos | https://apis.fixpay.com.br/v1/bancos | 🔗 Listar Bancos | Token Authorization |
7.3 - Contas Banco
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Buscar Contas | https://apis.fixpay.com.br/v1/contabancos/{cpfCnpj} | 🔗 Buscar Contas | Token Authorization |
7.4 - Contestação de Vendas
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Criar Contestação Vendas | https://apis.fixpay.com.br/v1/salescontest | 🔗 Criar Contestação Vendas | Token Authorization |
| Listar Vendas Disputa Chargeback | https://apis.fixpay.com.br/v1/salesindisputechargeback/{grupoId} | 🔗 Listar Vendas Disputa Chargeback | Token Authorization |
| Listar Log Disputa Chargeback | https://apis.fixpay.com.br/v1/logdisputechargebacks/{grupoId} | 🔗 Listar Log Disputa Chargeback | Token Authorization |
8.0 - FIX SELLER
8.1 - Agendamentos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Retornar Agendamentos | https://apis.fixpay.com.br/v1/seller/eventschedule | 🔗 Retornar Agendamentos | Token Authorization |
| Retornar por ID | https://apis.fixpay.com.br/v1/seller/eventschedule/{id} | 🔗 Retornar por ID | Token Authorization |
| Criar Agendamento | https://apis.fixpay.com.br/v1/seller/eventschedule | 🔗 Criar Agendamento | Token Authorization |
| Deletar Agendamento | https://apis.fixpay.com.br/v1/seller/eventschedule/delete/{id} | 🔗 Deletar Agendamento | Token Authorization |
| Alterar Agendamento | https://apis.fixpay.com.br/v1/seller/eventschedule/edit | 🔗 Alterar Agendamento | Token Authorization |
| Retornar por Usuário | https://apis.fixpay.com.br/v1/seller/eventschedule/unrelated/{usuarioId} | 🔗 Retornar por Usuário | Token Authorization |
| Finalizar Agendamento | https://apis.fixpay.com.br/v1/seller/eventschedule/finish | 🔗 Finalizar Agendamento | Token Authorization |
8.2 - Authentication
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Entrar Representante | https://apis.fixpay.com.br/v1/signin/seller | 🔗 Entrar Representante | ❌ |
8.3 - Checkin
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Criar Chekin | https://apis.fixpay.com.br/v1/seller/checkin | 🔗 Criar Chekin | Token Authorization |
| Checkin Não Relacionado | https://apis.fixpay.com.br/v1/seller/checkin/unrelated/{usuarioId} | 🔗 Checkin Não Relacionado | Token Authorization |
| Buscar Checkin por Id | https://apis.fixpay.com.br/v1/seller/checkin/findById/{checkInId} | 🔗 Buscar Checkin por Id | Token Authorization |
8.4 - Concorrente
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Buscar Todos os Concorrentes | https://apis.fixpay.com.br/v1/seller/competidor | 🔗 Buscar Todos os Concorrentes | Token API * |
| Buscar Concorrentes por Id | https://apis.fixpay.com.br/v1/seller/competidor/{id} | 🔗 Buscar Concorrentes por Id | Token API * |
8.5 - Ficha de Credenciamento
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Usuário FixSeller | https://apis.fixpay.com.br/v1/fixseller/{userid} | 🔗 Usuário FixSeller | Token Authorization |
| Totalizadores FixSeller | https://apis.fixpay.com.br/v1/fixseller/totalizers/{userid} | 🔗 Totalizadores FixSeller | Token Authorization |
| Atualizar Antifraude | https://apis.fixpay.com.br/v1/fixseller/updatestatusantifraude | 🔗 Atualizar Antifraude | Token Authorization |
| Atualizar Imagem Fachada | https://apis.fixpay.com.br/v1/fixseller/imagem_fachada/{fichaid} | 🔗 Atualizar Imagem Fachada | Token Authorization |
| Procurar CNPJ | https://apis.fixpay.com.br/v1/fixseller/search_cnpj/{cnpj} | 🔗 Procurar CNPJ | Token Authorization |
| Criar Ficha de Credenciamento | https://apis.fixpay.com.br/v1/fixseller/create | 🔗 Criar Ficha de Credenciamento | Token Authorization |
| Editar Ficha de Credenciamento | https://apis.fixpay.com.br/v1/fixseller/edit/{fichaid} | 🔗 Editar Ficha de Credenciamento | Token Authorization |
8.6 - Motivo Visita
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Retorna Motivo Visita | https://apis.fixpay.com.br/v1/seller/reasonvisit | 🔗 Retorna Motivo Visita | Token Authorization |
| Retornar Motivo Visita ID | https://apis.fixpay.com.br/v1/seller/reasonvisit/{id} | 🔗 Retornar Motivo Visita ID | Token Authorization |
8.7 - Pacotes
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Plano por Nome | https://apis.fixpay.com.br/v1/seller/tabela_precos/{nome} | 🔗 Listar Plano por Nome | Token Authorization |
| Listar Todos os Planos | https://apis.fixpay.com.br/v1/seller/tabela_precos | 🔗 Listar Todos os Planos | Token Authorization |
8.8 - Representante
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Buscar Representante | https://apis.fixpay.com.br/v1/seller/representative/{userId} | 🔗 Buscar Representante | Token Authorization |
8.9 - Seguimentos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Seguimentos | https://apis.fixpay.com.br/v1/seller/seguimentos | 🔗 Listar Seguimentos | Token Auhtorization |
8.10 - Supervisor
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Buscar Supervisor | https://apis.fixpay.com.br/v1/seller/supervisor/{usuario_id} | 🔗 Buscar Supervisor | Token Authorization |
| Buscar Representantes | https://apis.fixpay.com.br/v1/seller/supervisor/{id}/representatives | 🔗 Buscar Representantes | Token Authorization |
| Buscar Visitas | https://apis.fixpay.com.br/v1/seller/supervisor/{id}/visits | 🔗 Buscar Visitas | Token Authorization |
8.11 - Vendedores
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Vendedores | https://apis.fixpay.com.br/v1/usuarioseller/{grupoId} | 🔗 Listar Vendedores | Token Authorization |
| Criar Vendedor | https://apis.fixpay.com.br/v1/usuarioseller | 🔗 Criar Vendedor | Token Authorization |
| Excluir Vendedor | https://apis.fixpay.com.br/v1/usuarioseller/{id} | 🔗 Excluir Vendedor | Token Authorization |
| Atualizar Vendedor | https://apis.fixpay.com.br/v1/usuarioseller/{id} | 🔗 Atualizar Vendedor | Token Authorization |
8.12 - Visita
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Buscar | https://apis.fixpay.com.br/v1/seller/visit/history | 🔗 Buscar | Token Authorization |
| Criar | https://apis.fixpay.com.br/v1/seller/visit | 🔗 Criar | Token Authorization |
| Buscar Visitas por ID | https://apis.fixpay.com.br/v1/seller/visit/contact | 🔗 Buscar Visitas por ID | Token Authorization |
| Editar Visita | https://apis.fixpay.com.br/v1/seller/visit | 🔗 Editar Visita | Token Authorization |
8.13 - Visita Contato
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Buscar | https://apis.fixpay.com.br/v1/seller/contactvisit | 🔗 Buscar | Token API * |
| Buscar Contato por ID | https://apis.fixpay.com.br/v1/seller/contactvisit/{id} | 🔗 Buscar Contato por ID | Token API * |
| Criar | https://apis.fixpay.com.br/v1/seller/contactvisit | 🔗 Criar | Token API * |
| Buscar por Usuário | https://apis.fixpay.com.br/v1/seller/contactvisit/user/{usuarioId} | 🔗 Buscar por Usuário | Token API * |
| Mapear Contatos | https://apis.fixpay.com.br/v1/seller/contactvisit/map | 🔗 Mapear Contatos | Token API * |
| Atualizar | https://apis.fixpay.com.br/v1/seller/contactvisit | 🔗 Atualizar | Token APi * |
| Deletar | https://apis.fixpay.com.br/v1/seller/contactvisit/{id} | 🔗 Deletar | Token API * |
| Filtrar por Nome Cnpj ou Cpf | https://apis.fixpay.com.br/v1/seller/contactvisit/user/{filter} | 🔗 Filtrar por Nome Cnpj ou Cpf | Token API * |
| Atualização Curta | https://apis.fixpay.com.br/v1/seller/shortcontactvisit | 🔗 Atualização Curta | Token API * |
9.0 - GPOS7000
9.1 - Integradoras
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Integradoras | https://apis.fixpay.com.br/v1/integradoras | 🔗 Listar Integradoras | Token Authorization |
9.2 - Extratos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Operadoras | https://apis.fixpay.com.br/v1/operadoras | 🔗 Listar Operadoras | Token Authorization |
9.3 - Terminais
| Url da Rota | Nome da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Buscar Terminal | https://apis.fixpay.com.br/v1/terminalbyserial/{serial} | 🔗 Buscar Terminal | ❌ |
| Listar Modelos de Terminais | https://apis.fixpay.com.br/v1/terminals/models | 🔗 Listar Modelos de Terminais | Token Authorization |
| Listar Terminais | https://apis.fixpay.com.br/v1/terminals/serial/{grupoId} | 🔗 Listar Terminais | Token Authorization |
| Buscar Terminal Por Grupo | https://apis.fixpay.com.br/v1/terminals/serialgpos/{grupoId} | 🔗 Buscar Terminal Por Grupo | Token Authorization |
| Atualizar Terminal | https://apis.fixpay.com.br/v1/terminal/{serial} | 🔗 Atualizar Terminal | Token Authorization |
10.0 - EMPRESA ÂNCORA
10.1 - Dashboard
10.2 - Extratos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Extrato | https://apis.fixpay.com.br/v1/empresaancora/extract/{empresa_ancora_id} | 🔗 Listar Extrato | Token Authorization |
| Retornar Balanço Disponível | https://apis.fixpay.com.br/v1/empresaancora/balanceavailable/{empresa_ancora_id} | 🔗 Retornar Balanço Disponível | Token Authorization |
| Retornar Lançamentos Futuros | https://apis.fixpay.com.br/v1/empresaancora/futurereleases/{empresa_ancora_id} | 🔗 Retornar Lançamentos Futuros | Token Authorization |
| Exportar Extrato | https://apis.fixpay.com.br/v1/empresaancora/exportextracttoexcel/{empresa_ancora_id} | 🔗 Exportar Extrato | Token Authorization |
10.3 - Meus Dados
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Empresa Âncora | https://apis.fixpay.com.br/v1/mydataempresaancora/registrationdata/{empresa_ancora_id} | 🔗 Listar Empresa Âncora | Token Authorization |
| Listar Dados Bancários | https://apis.fixpay.com.br/v1/mydataempresaancora/bankdetails/{empresa_ancora_id} | 🔗 Listar Dados Bancários | Token Authorization |
| Listar Endereço | https://apis.fixpay.com.br/v1/mydataempresaancora/searchaddress/{empresa_ancora_id} | 🔗 Listar Endereço | Token Authorization |
| Listar Porcentagem | https://apis.fixpay.com.br/v1/mydataempresaancora/percentageperestabelecimento/{empresa_ancora_id} | 🔗 Listar Porcentagem | Token Authorization |
10.4 - Recebimentos
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Feriados | https://apis.fixpay.com.br/v1/receiptsempresaancora/calendarioferiados | 🔗 Listar Feriados | Token Authorization |
| Valor Confirmado | https://apis.fixpay.com.br/v1/receiptsempresaancora/confirmedvalue/{empresa_ancora_id} | 🔗 Valor Confirmado | Token Authorization |
| Valor Compensado | https://apis.fixpay.com.br/v1/receiptsempresaancora/compensatedamount/{empresa_ancora_id} | 🔗 Valor Compensado | Token Authorization |
| Retornar Valores | https://apis.fixpay.com.br/v1/receiptsempresaancora/valueperestablishment/{empresa_ancora_id} | 🔗 Retornar Valores | Token Authorization |
| Exportar Recebíveis | https://apis.fixpay.com.br/v1/receiptsempresaancora/exportitems/{empresa_ancora_id} | 🔗 Exportar Recebíveis | Token Authorization |
| Retornar Transações | https://apis.fixpay.com.br/v1/receiptsempresaancora/transactionsperday/{empresa_ancora_id} | 🔗 Retornar Transações | Token Authorization |
10.5 - Valor/Transações
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Retornar Valor Total | https://apis.fixpay.com.br/v1/empresaancora/totalamountpaymentbydate/{cpfCnpj} | 🔗 Retornar Valor Total | Token Authorization |
| Retornar Transações | https://apis.fixpay.com.br/v1/empresaancora/transactionsperday/{cpfCnpj} | 🔗 Retornar Transações | Token Authorization |
10.6 - Vendas
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Listar Vendas por NSU | https://apis.fixpay.com.br/v1/salesempresaancora/detailssalesbynsu/{empresaAncoraId}/{nsu} | 🔗 Listar Vendas por NSU | Token Authorization |
| Listar Parcelas por Venda | https://apis.fixpay.com.br/v1/salesempresaancora/installmentsbysales/{empresaAncoraId}/{nsu} | 🔗 Listar Parcelas por Venda | Token Authorization |
| Total por Empresa Âncora | https://apis.fixpay.com.br/v1/salesempresaancora/totalsalesperestablishment/{empresaAncoraId} | 🔗 Total por Empresa Âncora | Token Authorization |
| Listar Vendas Empresa Âncora | https://apis.fixpay.com.br/v1/salesempresaancora/salesbyestablishment/{empresaAncoraId} | 🔗 Listar Vendas Empresa Âncora | Token Authorization |
11.0 - RECEBIMENTOS
11.1 - Recebimentos
12.0 - SAFELINK
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Loading SafeLink | https://gateway.fixpay.com.br/v1/safelink/loading/{url} | 🔗 Loading SafeLink | ❌ |
| Success Safelink | https://gateway.fixpay.com.br/v1/safelink/success/{url} | 🔗 Success Safelink | ❌ |
| Failure Safelink | https://gateway.fixpay.com.br/v1/safelink/failure/{url} | 🔗 Failure Safelink | ❌ |
12.1 - Views
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Generate | https://gateway.fixpay.com.br/v1/safelink/personpayment/new/{cnpj} | 🔗 Generate | Token API |
| ReCaptcha | https://gateway.fixpay.com.br/v1/safelink/personpayment/recaptcha/{token} | 🔗 ReCaptcha | Token API |
12.2 - Transactions
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Auto Authorization | https://gateway.fixpay.com.br/v1/safelink/autoauthorization | 🔗 Auto Authorization | Token API |
| Pre Authorization | https://gateway.fixpay.com.br/v1/safelink/preauthorization | 🔗 Pre Authorization | Token API |
| Authorization | https://gateway.fixpay.com.br/v1/safelink/authorization | 🔗 Authorization | Token API |
12.3 - Vault
| Nome da Rota | Url da Rota | Link da Rota | Autenticação |
|---|---|---|---|
| Convert Card to Token | https://gateway.fixpay.com.br/v1/safelink/card/new | 🔗 Convert Card to Token | Token API |
| Delete Card | https://gateway.fixpay.com.br/v1/safelink/card/delete | 🔗 Delete Card | Token API |