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
Buscar por IDhttps://apis.fixpay.com.br/v1/signature/{grupoId}/{id}Buscar por IDToken Authorization
Assinatura por planohttps://apis.fixpay.com.br/v1/signature/plan/signatures/{groupId}/{planId}Assinatura por planoToken Authorization
Métodos de pagamentohttps://apis.fixpay.com.br/v1/signature/paymentmethods/{groupId}Métodos de pagamentoToken Authorization
Retornar boleto de pagamentohttps://apis.fixpay.com.br/v1/signature/billingBillet/{groupId}/{establishmentId}/{signatureId}Retornar boleto de pagamentoToken Authorization
Cartão de crédito associado à assinaturahttps://apis.fixpay.com.br/v1/signature/creditcard/{groupId}/{signatureId}/{clientId}Cartão de crédito associado à assinaturaToken Authorization
Troca de cartãohttps://signpayments.fixpay.com.br/signature/edit/{grupoId}/{token} Troca de cartão
Cobranças de assinaturashttps://apis.fixpay.com.br/v1/signature/billingreportsignatures/{groupId}Cobranças de assinaturasToken Authorization
Totalizadorhttps://apis.fixpay.com.br/v1/signature/totalizer/{grupoId}TotalizadorToken Authorization
Reenviar e-mailhttps://apis.fixpay.com.br/v1/signature/reesendemail/{groupId}/{id}Reenviar e-mailToken Authorization
Relatório de faturamentohttps://apis.fixpay.com.br/v1/signature/billingreport/{groupId}Relatório de faturamentoToken Authorization
Exportar XLXShttps://apis.fixpay.com.br/v1/signature/exportxlsx/{groupId}/{establishmentId}Exportar XLXSToken Authorization
Exportar CSVhttps://apis.fixpay.com.br/v1/signature/exportcsv/{groupId}/{establishmentId}Exportar CSVToken Authorization
Criarhttps://apis.fixpay.com.br/v1/signature/CriarToken Authorization
Mudar cartãohttps://apis.fixpay.com.br/v1/signature/changecardMudar cartão Token Authorization
Troca de cartão com sucessohttps://signpayments.fixpay.com.br/signature/edit/{grupoId}/{token}Troca de cartão com sucesso
Cancelarhttps://apis.fixpay.com.br/v1/signature/cancelCancelarToken Authorization
Cobrança manualhttps://apis.fixpay.com.br/v1/signature/manualbilling/{groupId}Cobrança manualToken Authorization
Importar CSVhttps://apis.fixpay.com.br/v1/signature/importcsv Importar CSVToken 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
Expirarhttps://apis.fixpay.com.br/v1/signature/expireExpirarToken Authorization
Deletarhttps://apis.fixpay.com.br/v1/signature/delete/{groupId}/{id}DeletarToken Authorization

Pix

Antecipações

Clientes

Configuração

Dashboard

Fatura

Nome da RotaUrl da RotaLink da RotaAutenticação
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 faturahttps://apis.fixpay.com.br/v1/signature/invoice/productRelaciona produto faturaToken Authorization
Baixa manual da faturahttps://apis.fixpay.com.br/v1/signature/invoice/manualconfirmationBaixa manual da faturaToken Authorization
Segunda via faturahttps://apis.fixpay.com.br/v1/signature/invoice/secondSegunda via faturaToken Authorization
Deletar faturahttps://apis.fixpay.com.br/v1/signature/invoice/delete/{groupId}/{id}Deletar faturaToken Authorization
Listar faturashttps://apis.fixpay.com.br/v1/signature/invoice/{groupId}Listar faturasToken Authorization
Listar fatura específicahttps://apis.fixpay.com.br/v1/signature/invoice/{groupId}/{id}Listar fatura específicaToken Authorization
Totalizadorhttps://apis.fixpay.com.br/v1/signature/invoice/totalizer/{groupId}TotalizadorToken Authorization
Fatura com cartão de créditohttps://apis.fixpay.com.br/v1/signature/invoicecreditcard/{id}Fatura com cartão de créditoToken Authorization
Enviar e-mailhttps://apis.fixpay.com.br/v1/signature/invoice/email/{groupId}/{id}Enviar e-mailToken Authorization
Calcular penalidades e taxashttps://apis.fixpay.com.br/v1/signature/invoice/calculatepenaltyandfees/{groupId}/{id}Calcular penalidades e taxasToken Authorization
Buscar fatura do relatório de cobrançahttps://apis.fixpay.com.br/v1/signature/invoice/billingreport/{groupId}Buscar fatura do relatório de cobrançaToken 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 cidade por nomehttps://apis.fixpay.com.br/v1/city/findbynameBuscar cidade 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 plano de um produtohttps://apis.fixpay.com.br/v1/signature/plan/linkedproduct/{groupId}/{productId}Listar plano de um produtoToken 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
Planos por grupohttps://apis.fixpay.com.br/v1/signature/costumerplans/{groupId}Planos por grupoToken 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

Timeline

Assinatura

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

Fatura

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

Planos

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

Produtos

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

Usuários

Recebimentos