Documentação Técnica - CF

Visão geral

A API de Portabilidade de Crédito Consignado permite que usuários transfiram suas operações de crédito e arrendamento mercantil entre instituições financeiras em busca de melhores condições para o Open Finance Brasil.

Conteúdo comum entre os produtos

Para o entendimento correto do produto você deve levar em consideração as informações presentes na página [PC] API - Crédito Consignado Federal - CF.

Realiza pedido de portabilidade de crédito: (POST /portabilities)

Realiza pedido de portabilidade de crédito para um determinado contrato junto a instituição credora. Solicitação de portabilidade de crédito via OFB.

Dicionário de dados

Campos de resposta do endpoint de /portabilities.

Fazer download do dicionário de dados

Consulta portabilidade de crédito através da propriedade portabilityId: (GET /portabilities/{portabilityId})

Endpoint responsável por consultar pedidos de portabilidade de crédito.

Cada portabilityId deve respeitar o prazo de consulta. Fortemente recomendado que ocorra a cada 2 horas, entre 8h e 18h, em dias úteis. As consultas também podem ser realizadas de forma esporádica, conforme ação do usuário (neste caso, sem restrição de dia e horário).

Dicionário de dados

Campos de resposta do endpoint de /portabilities/{portabilityId}.

Fazer download do dicionário de dados

Comunica a respeito do cancelamento da portabilidade de crédito: (PATCH /portabilities/{portabilityId}/cancel)

Comunica a Instituição Credora a respeito do cancelamento da portabilidade de crédito.

Dicionário de dados

Campos de resposta do endpoint de /portabilities/{portabilityId}/cancel.

Fazer download do dicionário de dados

Consultar contrato de portabilidade de crédito: (GET /credit-operations/{contractId}/portability-eligibility)

Informa se um contrato pertencente a um determinado cliente estará habilitado para a realização do pedido de portabilidade de crédito considerando a regra de só existir um pedido de portabilidade para um determinado contrato.

Dicionário de dados

Campos de resposta do endpoint de /credit-operations/{contractId}/portability-eligibility.

Fazer download do dicionário de dados

Obtém os dados necessários para realização do pagamento da operação via TED: (GET /account-data)

Método responsável por recuperar informações de contas para realização do pagamento via TED.

Dicionário de dados

Campos de resposta do endpoint de /account-data.

Fazer download do dicionário de dados

Comunica a Instituição Credora a respeito da liquidação da portabilidade de crédito: (POST /portabilities/{portabilityId}/payment)

Comunica a Instituição Credora a respeito da liquidação da portabilidade de crédito.

Dicionário de dados

Campos de resposta do endpoint de /portabilities/{portabilityId}/payment.

Fazer download do dicionário de dados

Solicita o estorno da STR efetuada para liquidar o contrato consignado: (POST /portabilities/{portabilityId}/payment-reversal)

Solicita o estorno da STR efetuada para liquidar o contrato consignado devido ao fato da Instituição Credora não ter desaverbado o contrato em tempo ábil conforme SLA definido pela SERPRO de 10 dias contados a partir da data de criação da solicitação da reserva da mergem para Instituição Proponente.

Dicionário de dados

Campos de resposta do endpoint de /portabilities/{portabilityId}/payment.

Fazer download do dicionário de dados

Obtém os dados necessários para identificar o contrato a ser portado junto a averbadora: (GET /credit-operations/{contractId}/registering-entity)

Obtém os dados necessários para identificar o contrato a ser portado junto a averbadora.

Dicionário de dados

Campos de resposta do endpoint de /credit-operations/{contractId}/registering-entity.

Fazer download do dicionário de dados

Nesta documentação, você encontrará orientações detalhadas sobre:

O conteúdo aqui apresentado é fundamental para garantir que as implementações sejam realizadas de forma padronizada, segura e eficiente, proporcionando uma jornada fluida para os consumidores no ecossistema do Open Finance.