Listar Tabelas com Filtro

Este endpoint permite consultar uma tabela de financiamento com filtros.

Segurança

Para acessar a API, é necessário obter um token de acesso através do fluxo de autenticação OAuth2. Veja mais detalhes em Como obter acesso?

info

Ao gerar o token JWT, não esqueça de utilizar o escopo correto. Caso contrário, a requisição será rejeitada com o código de erro 401 Unauthorized.

Requisição

GET https://api-sandbox.catalisa.com.br/financial-products/api/v1/financing-tables JWT scope: financing-tables/read:financing-tables

Parâmetros

Nome	Tipo	Descrição
filter[segmentId]	string	Opcional. Identificador do segmento.
filter[currentDate]	string	Opcional. Data da taxa vigente.

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Accept	application/json

Exemplo de Requisição

Respostas

Código	Descrição
200	Retorna as tabelas de financiamento relacionadas aos filtros indicados.
401	Não autorizado
422	Quando informado filtros desconhecidos

Filtros

A API permite filtrar as tabelas de financiamento pelos campos: segmentId, currentDate. Para isso, basta informar o parâmetro filter[{nome do campo}] na requisição.

Exemplo de uso

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Accept", "application/json");

const requestOptions = {
  method: "GET",
  headers: headers,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/financial-products/api/v1/financing-tables?filter[segmentId]=2b61951c-28bc-474a-81a9-4c53cfc8ba0",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request GET 'https://api-sandbox.catalisa.com.br/financial-products/api/v1/financing-tables?filter[segmentId]=2b61951c-28bc-474a-81a9-4c53cfc8ba0' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Exemplo de Resposta

{
    "links": {
        "self": "https://api-sandbox.catalisa.com.br/financial-products/api/v1/financing-tables"
    },
    "data": [
        {
            "type": "financing-tables",
            "id": "3e1f2c17-576f-4203-b2b3-4940868f946b",
            "attributes": {
                "description": "Tabela de financiamento - Empréstimo Atualizada",
                "segmentId": "2b61951c-28bc-474a-81a9-4c53cfc8ba05",
                "minGracePeriod": 20,
                "maxGracePeriod": 60,
                "startDate": "2024-03-01",
                "endDate": "2024-04-29"
            },
            "links": {
                "self": "https://api-sandbox.catalisa.com.br/financial-products/api/v1/financing-tables/3e1f2c17-576f-4203-b2b3-4940868f946b"
            }
        }
    ]
}