Atualizar uma Tabela

Quando uma Tabela de Financiamento é criada com sucesso, a API retorna o código de status HTTP 200 Ok, com os dados da Tabela de Financiamento criada no corpo da resposta.

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.

Descrição dos campos

Campo	Tipo	Descrição
segmentId	string	ID do segmento cadastrado préviamente
description	string	Identificador da tabela de financiamento do parceiro. Pode ser utilizado para identificar a tabela de financiamento no sistema do parceiro.
minGracePeriod	int	Período de carência mínimo
maxGracePeriod	int	Período de carência máximo
startDate	string	Data de início da viência, no formato: YYYY-MM-DD
endDate	string	Data final da viência, no formato: YYYY-MM-DD

Requisição

PATCH https://api-sandbox.catalisa.com.br/financial-products/api/v1/financing-tables/{id} JWT scope: financing-tables/write:financing-tables

Parâmetros

Nome	Tipo	Descrição
id	string	Identificador único da tabela de financiamento, no formato UUID.

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Content-Type	application/json

Exemplo de Requisição

Corpo da Requisição

{
	"data": {
		"type": "financing-tables",
		"attributes": {
			"description": "Tabela de financiamento - Empréstimo Atualizada"
		}
	}
}

Respostas

Código	Descrição
200	Tabela de financiamento atualizado com sucesso. Retorna os dados do tabela de financiamento atualizada
401	Não autorizado

Exemplo de uso

Javascript

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

const body = JSON.stringify({
	data: {
		type: "financing-tables",
		attributes: {
			description: "Tabela de financiamento - Empréstimo Atualizada"
		}
	}
});

const requestOptions = {
  method: "PATCH",
  headers: headers,
  body: body,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/financial-products/api/v1/financing-tables",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request PATCH 'https://api-sandbox.catalisa.com.br/financial-products/api/v1/financing-tables' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
--data-raw '{
	"data": {
		"type": "financing-tables",
		"attributes": {
			"description": "Tabela de financiamento - Empréstimo Atualizada"
		}
	}
}'

Exemplo de Sucesso

{
    "links": {
        "self": "https://api-sandbox.catalisa.com.br/financing-tables/api/v1/financing-tables/3e1f2c17-576f-4203-b2b3-4940868f946b"
    },
    "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-01-01",
            "endDate": "2024-02-29"
        }
    }
}