API Reference

Listar Cobranças Vencidas

Lista o histórico de cobranças vencidas de uma assinatura.

Listar Cobrança Vencidas

Lista o histórico de inadimplência de uma determinada assinatura, de acordo com o ID do grupo do estabelecimento e o ID da assinatura, retornando dados como data da cobrança, nome do cliente, valor da cobrança, entre outros dados importantes.

Como implementar:

Primeiramente, é necessário passar o token da sessão do estabelecimento no header "Authorization". Esse token é disponibilizado através do Suporte. Os contatos estão disponibilizados em nossa página Fix Pay.

Abaixo temos um exemplo de como inserir o Header usando JSON.

{
 "Authorization": "eyJhdGcdOiJdUzI1diIsInR5cCI6IkpXVCJ9.eyJVc3VhcmlvSWQiOjQwMiwiZXhwIjoxNzA4ODcxODE3LCJpc3MiOiJBdXRoU2VydmljZSJ9.CfUuM5AcMJBfC8JopLsMDXR2oX15QQeHCFOiph_DPHE",
}

Exemplo:

Agora, veremos um exemplo da requisição feita em JavaScript e seu resultado.

const options = {
  method: 'GET',
  headers: {
    accept: 'application/json',
    Authorization: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc3VhcmlvSWQiOjQwMiwiZXhwIjoxNzA4OTQ5NDE2LCJpc3MiOiJBdXRoU2VydmljZSJ9.upQUOwRMplz210TrtiyH-oTagaIF5IhzqWLhNBrvCVY'
  }
};

fetch('https://apis.fixpay.com.br/v1/signature/overduebillslist/137/7', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

O retorno da requisição é um JSON contendo dados relevantes, como podemos ver a seguir.

{
  "data": [
    {
      "historico_assinatura_id": 33,
      "assinatura_id": 7,
      "data_cobranca": "2022-06-18 06:00:01",
      "data_pagamento": "0001-01-01 00:00:00",
      "data_criacao": "2022-06-18 06:00:01",
      "cpf_cnpj_cliente": "",
      "cpf_cnpj_titular": "XXXXX251334",
      "nome_cliente": "JOÃO",
      "cliente_id": 10,
      "tid_real": "12342206180554191182",
      "bandeira": "MASTERCARD",
      "plano": "TRATAMENTO ODONTOLOGICO",
      "plano_id": 179,
      "valor": 1200,
      "juros": 0,
      "multa": 0,
      "numero_cartao": "546452XXXXXX1234",
      "status_pag": "INADIMPLENTE",
      "metodo_pagamento": ""
    },
    {
      "historico_assinatura_id": 33,
      "assinatura_id": 7,
      "data_cobranca": "2022-07-18 06:00:01",
      "data_pagamento": "0001-01-01 00:00:00",
      "data_criacao": "2022-06-18 06:00:01",
      "cpf_cnpj_cliente": "",
      "cpf_cnpj_titular": "XXXXX251334",
      "nome_cliente": "JOÃO",
      "cliente_id": 10,
      "tid_real": "12342206180554191182",
      "bandeira": "MASTERCARD",
      "plano": "TRATAMENTO ODONTOLOGICO",
      "plano_id": 179,
      "valor": 1200,
      "juros": 0,
      "multa": 0,
      "numero_cartao": "546452XXXXXX1234",
      "status_pag": "INADIMPLENTE",
      "metodo_pagamento": ""
    },
  ]
}

Testar rota

Abaixo, você poderá testar a rota em produção, passando os valores nos parâmetros conforme sua descrição e tipo. Na lateral direita da tela, você poderá ver o código da requisição em várias linguagens diferentes e sua resposta. Além disso, na parte de resposta da requisição, você poderá ver todos os possíveis retornos gerados pela rota.

Language
Click Try It! to start a request and see the response here!