API Reference

Fix Pay Sign

Assinaturas

Nome da RotaUrl da RotaLink da RotaAutenticação
Listar Assinaturashttps://apis.fixpay.com.br/v1/signature/{grupoId}Listar AssinaturasToken Authorization
Listar Cobranças de Assinaturahttps://apis.fixpay.com.br/v1/signature/billingreportsignatures/{groupId}Listar Cobranças de AssinaturaToken Authorization
Buscar Assinatura por IDhttps://apis.fixpay.com.br/v1/signature/{grupoId}/{id}Buscar Assinatura por IDToken Authorization
Retornar Assinatura por Planohttps://apis.fixpay.com.br/v1/signature/plan/signatures/{groupId}/{planId}Retornar Assinatura por PlanoToken Authorization
Retornar Método de Pagamentohttps://apis.fixpay.com.br/v1/signature/paymentmethods/{groupId}Retornar Método de PagamentoToken Authorization
Retornar Boleto de Pagamentohttps://apis.fixpay.com.br/v1/signature/billingBillet/{groupId}/{establishmentId}/{signatureId}Retornar Boleto de PagamentoToken Authorization
Retornar Totalizador de Assinaturahttps://apis.fixpay.com.br/v1/signature/totalizer/{grupoId}Retornar Totalizador de AssinaturaToken Authorization
Retornar Relatório de Faturamentohttps://apis.fixpay.com.br/v1/signature/billingreport/{groupId}Retornar Relatório de FaturamentoToken Authorization
Retornar Tela Troca de Cartãohttps://signpayments.fixpay.com.br/signature/edit/{grupoId}/{token}Retornar Tela Troca de Cartão
Buscar Cartão de Crédito por Assinaturahttps://apis.fixpay.com.br/v1/signature/creditcard/{groupId}/{signatureId}/{clientId}Buscar Cartão de Crédito por AssinaturaToken Authorization
Reenviar e-mailhttps://apis.fixpay.com.br/v1/signature/reesendemail/{groupId}/{id}Reenviar e-mailToken Authorization
Exportar CSVhttps://apis.fixpay.com.br/v1/signature/exportcsv/{groupId}/{establishmentId}Exportar CSVToken Authorization
Exportar XLXShttps://apis.fixpay.com.br/v1/signature/exportxlsx/{groupId}/{establishmentId}Exportar XLXSToken Authorization
Importar CSVhttps://apis.fixpay.com.br/v1/signature/importcsv Importar CSVToken Authorization
Criar Assinaturahttps://apis.fixpay.com.br/v1/signature/Criar AssinaturaToken Authorization
Cancelar Assinaturahttps://apis.fixpay.com.br/v1/signature/cancelCancelar AssinaturaToken Authorization
Alterar Cartãohttps://apis.fixpay.com.br/v1/signature/changecardAlterar CartãoToken Authorization
Retornar Tela Sucesso na Troca de Cartãohttps://signpayments.fixpay.com.br/signature/edit/{grupoId}/{token}Retornar Tela Sucesso na Troca de Cartão
Realizar Cobrança Manualhttps://apis.fixpay.com.br/v1/signature/manualbilling/{groupId}Realizar Cobrança ManualToken Authorization
Ativar/Desativar Assinaturahttps://apis.fixpay.com.br/v1/signature/enabledisableAtivar/Desativar assinaturaToken Authorization
Editar Assinaturahttps://apis.fixpay.com.br/v1/signature/editEditar assinaturaToken Authorization
Expirar Assinaturahttps://apis.fixpay.com.br/v1/signature/expireExpirar AssinaturaToken Authorization
Deletar Assinaturahttps://apis.fixpay.com.br/v1/signature/delete/{groupId}/{id}Deletar AssinaturaToken Authorization

Pix

Antecipações

Clientes

Configuração

Nome da RotaUrl da RotaLink da RotaAutenticação
Listar Configurações por Grupohttps://apis.fixpay.com.br/v1/signature/config/{groupId}Listar Configurações por GrupoToken Authorization
Buscar Configurações por IDhttps://apis.fixpay.com.br/v1/signature/config/{groupId}/{id}Buscar Configurações por IDToken Authorization
Criar Configuraçãohttps://apis.fixpay.com.br/v1/signature/configCriar ConfiguraçãoToken Authorization
Pesquisar Cupomhttps://apis.fixpay.com.br/v1/signature/searchcupomPesquisar CupomToken Authorization
Alterar Logohttps://apis.fixpay.com.br/v1/signature/config/uploadlogoAlterar LogoToken Authorization
Deletar Logohttps://apis.fixpay.com.br/v1/signature/config/deletelogoDeletar LogoToken Authorization
Habilitar/Desabilitar Pixhttps://apis.fixpay.com.br/v1/signature/config/enabledisablepixHabilitar/Desabilitar PixToken Authorization
Habilitar/Desabilitar Cartãohttps://apis.fixpay.com.br/v1/signature/config/enabledisablecreditcardHabilitar/Desabilitar CartãoToken Authorization
Habilitar/Desabilitar Boletohttps://apis.fixpay.com.br/v1/signature/config/enabledisableboletoHabilitar/Desabilitar boletoToken Authorization
Editar Configuraçãohttps://apis.fixpay.com.br/v1/signature/config/editEditar ConfiguraçãoToken Authorization
Editar Envio de E-mailshttps://apis.fixpay.com.br/v1/signature/config/edit/sendemailoptionsEditar Envio de E-mailsToken Authorization
Deletar Configuraçãohttps://apis.fixpay.com.br/v1/signature/config/delete/{groupId}/{id}Deletar ConfiguraçãoToken Authorization

Dashboard

Fatura

Nome da RotaUrl da RotaLink da RotaAutenticação
Listar Faturashttps://apis.fixpay.com.br/v1/signature/invoice/{groupId}Listar FaturasToken Authorization
Buscar Faturas por IDhttps://apis.fixpay.com.br/v1/signature/invoice/{groupId}/{id}Buscar Faturas por IDToken Authorization
Retornar Fatura Paga com Cartão de Créditohttps://apis.fixpay.com.br/v1/signature/invoicecreditcard/{id}Retornar Fatura Paga com Cartão de CréditoToken Authorization
Retornar Totalizador de Faturashttps://apis.fixpay.com.br/v1/signature/invoice/totalizer/{groupId}Retornar Totalizador de FaturasToken Authorization
Retornar Relatório de Cobrança da Faturahttps://apis.fixpay.com.br/v1/signature/invoice/billingreport/{groupId}Retornar Relatório de Cobrança da FaturaToken Authorization
Calcular Penalidades e Taxashttps://apis.fixpay.com.br/v1/signature/invoice/calculatepenaltyandfees/{groupId}/{id}Calcular Penalidades e TaxasToken Authorization
Enviar E-mailhttps://apis.fixpay.com.br/v1/signature/invoice/email/{groupId}/{id}Enviar E-mailToken Authorization
Cancelar Faturahttps://apis.fixpay.com.br/v1/signature/invoice/cancel/creditcardCancelar FaturaToken Authorization
Expirar Faturahttps://apis.fixpay.com.br/v1/signature/invoice/expireExpirar FaturaToken Authorization
Relacionar Produto a Uma Faturahttps://apis.fixpay.com.br/v1/signature/invoice/productRelacionar Produto a Uma FaturaToken Authorization
Realizar Baixa Manual da Faturahttps://apis.fixpay.com.br/v1/signature/invoice/manualconfirmationRealizar Baixa Manual da FaturaToken Authorization
Gerar Segunda Via da Faturahttps://apis.fixpay.com.br/v1/signature/invoice/secondGerar Segunda Via da FaturaToken Authorization
Deletar Faturahttps://apis.fixpay.com.br/v1/signature/invoice/delete/{groupId}/{id}Deletar FaturaToken Authorization

Pix

Faturamento

Histórico de Assinaturas

Item Extra de Assinaturas

Municípios

Nome da RotaUrl da RotaLink da RotaAutenticação
Listar Municípioshttps://apis.fixpay.com.br/v1/citiesListar Municípios
Buscar Município por Nomehttps://apis.fixpay.com.br/v1/city/findbynameBuscar Município por Nome

Planos

Nome da RotaUrl da RotaLink da RotaAutenticação
Listar Recorrênciashttps://apis.fixpay.com.br/v1/signature/recurrencetypeListar RecorrênciasToken Authorization
Listar Planoshttps://apis.fixpay.com.br/v1/signature/plan/{groupId}Listar PlanosToken Authorization
Listar Planos por Produtohttps://apis.fixpay.com.br/v1/signature/plan/linkedproduct/{groupId}/{productId}Listar Planos por ProdutoToken Authorization
Listar Planos por Grupohttps://apis.fixpay.com.br/v1/signature/costumerplans/{groupId}Listar Planos por GrupoToken Authorization
Buscar Plano por IDhttps://apis.fixpay.com.br/v1/signature/plan/{groupId}/{id}Buscar Plano por IDToken Authorization
Buscar Plano por Assinaturahttps://apis.fixpay.com.br/v1/signature/plan/signature/{groupId}/{signatureId}Buscar Plano por AssinaturaToken Authorization
Exportar XLSXhttps://apis.fixpay.com.br/v1/signature/plan/exportxlsx/{groupId}/{establishmentId}Exportar XLSXToken Authorization
Exportar CSVhttps://apis.fixpay.com.br/v1/signature/plan/exportcsv/{groupId}/{establishmentId}Exportar CSVToken Authorization
Importar CSVhttps://apis.fixpay.com.br/v1/signature/plan/importcsvImportar CSVToken Authorization
Criar Planohttps://apis.fixpay.com.br/v1/signature/planCriar planoToken Authorization
Editar Planohttps://apis.fixpay.com.br/v1/signature/plan/edit/Editar planoToken Authorization
Ativar/Desativar Planohttps://apis.fixpay.com.br/v1/signature/plan/enabledisableAtivar/desativar PlanoToken Authorization
Deletar Planohttps://apis.fixpay.com.br/v1/signature/plan/delete/{grupoId}/{id}Deletar PlanoToken Authorization

Produtos

Produtos com Plano

Relatórios

Cartão de Crédito

Planos

Produtos

Telas de Pagamento

Assinaturas

Faturas

Nome da RotaUrl da RotaLink da RotaAutenticação
Retornar Tela Pagamento Faturahttps://signpayments.fixpay.com.br/paymentInvoice/{token}Retornar Tela Pagamento Fatura
Retornar Tela Sucesso no Pagamento Faturahttps://signpayments.fixpay.com.br/paymentInvoice/{token}Retornar Tela Sucesso no Pagamento Fatura

Timeline

Assinatura

Nome da RotaUrl da RotaLink da RotaAutenticação
Retornar Timeline Assinaturahttps://apis.fixpay.com.br/v1/signature/timeline/{groupId}/{signatureId}Retornar Timeline AssinaturaToken Authorization
Criar Timeline Assinaturahttps://apis.fixpay.com.br/v1/signature/timelineCriar Timeline AssinaturaToken Authorization

Fatura

Nome da RotaUrl da RotaLink da RotaAutenticação
Retornar Timeline Faturahttps://apis.fixpay.com.br/v1/signature/invoice/timeline/{groupId}/{invoiceId}Retornar Timeline FaturaToken Authorization
Criar timeline faturahttps://apis.fixpay.com.br/v1/signature/invoice/timelineCriar timeline faturaToken Authorization

Planos

Nome da RotaUrl da RotaLink da RotaAutenticação
Retornar Timeline Planohttps://apis.fixpay.com.br/v1/signature/plan/timeline/{groupId}/{planoId}Retornar Timeline PlanoToken Authorization
Criar Timeline Planohttps://apis.fixpay.com.br/v1/signature/plan/timelineCriar Timeline PlanoToken Authorization

Produtos

Nome da RotaUrl da RotaLink da RotaAutenticação
Retornar Timeline Produtohttps://apis.fixpay.com.br/v1/signature/product/timeline/{groupId}/{produtoId}Retornar Timeline ProdutoToken Authorization
Criar Timeline Produtohttps://apis.fixpay.com.br/v1/signature/product/timeline/Criar Timeline ProdutoToken Authorization

Usuários

Recebimentos