API Reference

Cartão de Crédito Associado à Assinatura

Encontra cartão de um cliente assinante.

Encontrar Cartão

Encontra os dados de um cartão de de um cliente assinante de acordo com alguns parâmetros passados na rota, como ID do grupo do estabelecimento, ID da assinatura e ID do cliente. Retorna dados como número do cartão, CPF do titular, nome do cartão, 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/creditcard/137/5/141', 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": {
    "id": 7,
    "assinatura_id": 5,
    "cliente_id": 141,
    "grupo_id": 137,
    "numero_cartao": "400634XXXXXX8075",
    "bandeira_id": 1,
    "cpf_cnpj_titular": "39244547368",
    "nome_cartao": "José Ronaldo Bomfim paiva ",
    "created_at": "2022-01-27T20:56:20.183875Z",
    "updated_at": "2022-01-27T20:56:20.183876Z"
  }
}

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!