Manual Portabilidade In + Refinanciamento do INSS
Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.
Para iniciar o processo de Portabilidade + Refinanciamento - INSS, primeiramente é necessário coletar os dados do benefício para checagem da elegibilidade como também os dados da conta de pagamento do benefício. Os itens 1 e 2, descrevem o procedimento para consulta da lista de benefícios de um determinado beneficiário e procedimento para consulta dos dados do benefício.
1 - Consulta da lista de benefícios com formalização do Termo de Autorização realizada através do parceiro:
1.1. Titular do benefício é o assinante do Termo de Autorização.
Request
- ENDPOINT/social_security/benefits_request
- MÉTODOPOST
Payload:
payload.json
{
"document_number": "16514548091",
"authorization_term": {
"document_number": "16514548091",
"signature": {
"signer": {
"name": "Nome Devedor",
"phone": {
"number": "887577622",
"area_code": "19",
"country_code": "55"
},
"document_number": "16514548091"
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "2023-12-05T21:04:06",
"ip_address": "200.223.171.82",
"fingerprint": {
"lat": "-44.00524157713981",
"long": "-19.807649431219804",
"name": "Nome Cliente",
"model": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.6 Mobile/15E148 Safari/604.1",
"localeHashValue": "hash cliente"
},
"third_party_additional_data": {},
"session_id": "ID DA SESSÃO DO ASSINANTE"
},
"signed_object": {
"document_key": "cfbc8469-89ea-4a80-9f64-ba7b1566c68b"
}
}
}
}
1.2. Titular do benefício não é o assinante do Termo de Autorização (com representante legal).
Como o assinante do termo nesse caso é o representante legal, os dados que preenchem o objeto signer, são os dados do representante legal.
Request
- ENDPOINT/social_security/benefits_request
- MÉTODOPOST
Payload:
payload.json
{
"document_number": "16514548091",
"authorization_term": {
"document_number": "16514548091",
"legal_representative_document_number": "70957091060",
"signature": {
"signer": {
"name": "Nome Representante legal",
"phone": {
"number": "887577622",
"area_code": "19",
"country_code": "55"
},
"document_number": "70957091060"
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "2023-12-05T21:04:06",
"ip_address": "200.223.171.82",
"fingerprint": {
"lat": "-44.00524157713981",
"long": "-19.807649431219804",
"name": "Nome Cliente",
"model": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.6 Mobile/15E148 Safari/604.1",
"localeHashValue": "hash cliente"
},
"third_party_additional_data": {},
"session_id": "ID DA SESSÃO DO ASSINANTE"
},
"signed_object": {
"document_key": "cfbc8469-89ea-4a80-9f64-ba7b1566c68b"
}
}
}
}
Nos casos em que houver representante legal, é necessário preencher o campo "legal_representative_document_number" com o CPF do representante legal, e os dados do objeto "signer" devem ser preenchidos com os dados do mesmo.
"document_key": utilizar a GUID retornada no endpoint /upload
Ao invés da chave do documento pdf assinado no objeto “authorization_term.signed_object.document_key", também é possível enviar o texto corrido do Termo de Autorização, através do objeto "authorization_term.signed_object.raw_text".
Response
- MÉTODOPOST
- ENDPOINTsocial_security/benefits_request
body.json
{
"benefits_request_key": "c9d2aa83-006b-4753-92ad-64411a7aa700",
"document_number": "18028522041",
"status": "pending_authorization",
"authorization_term": {
"authorization_term_key": "5a7b6489-8a47-4b61-a85a-6986b058fda6",
"status": "signed"
},
"status_events": [
{
"status": "pending_authorization",
"event_date": "2023-12-22T16:12:50"
}
]
}
Em caso de sucesso na consulta da lista de benefícios:
Webhook
- WEBHOOK_TYPEsocial_security_benefits_request
- STATUSSuccess
Body:
body.json
{
"webhook": {
"key": "54cddd0f-b976-4266-91ea-90279bfb49a1",
"data": [
{
"grant_date": [
"2010-10-18"
],
"benefit_number": 2052711150,
"benefit_status": "elegible"
}
],
"status": "success",
"webhook_type": "social_security_benefits_request",
"event_datetime": "2023-12-22T13:20:44"
}
}
| Campo | Descrição | Valores |
|---|---|---|
| benefit_number | Número do beneficio | - |
| benefit_status | Status do beneficio | Enumeradores |
Em caso de falha na consulta da lista de benefícios:
Webhook
- WEBHOOK_TYPEsocial_security_benefits_request
- STATUSFailure
Body:
body.json
{
"webhook": {
"key": "0020653e-c3b0-4606-af31-2ea4a577a5ce",
"data": {
"enumerator": "inexistent_beneficiary",
"description": "no beneficiary found"
},
"status": "failure",
"webhook_type": "social_security_benefits_request",
"event_datetime": "2023-12-22T15:46:31"
}
}
Detalhamento de campos no webhook de falha
| Campo | Descrição | Valores |
|---|---|---|
| enumerator | Retorno mapeado do código Dataprev | Enumeradores |
Simulando cenários de sucesso e insucesso na consulta de benefício em Sandbox:
A simulação de cenários é baseado no primeiro dígito do CPF informado na operação.
11.1. Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook.
11.2. Para os demais CPFs, será retornado uma resposta assíncrona de erro, baseado no primeiro dígito do CPF digitado, de acordo com a tabela abaixo.
| Início do CPF | Enumerador | Descrição |
|---|---|---|
| 2 | inexistent_beneficiary | no beneficiary found |
Todos os CPFs que não tiverem um cenário mapeado para o primeiro dígito, receberão um webhook com um erro padrão de cenário de teste não mapeado.
| Enumerador | Descrição |
|---|---|
| mock_error | Informed document number is not a valid mock on test environment |
2 - Consulta de dados do benefício
2.1. Consulta de dados do benefício com o Termo de Autorização previamente enviado.
Request
- MÉTODOPOST
- ENDPOINT/social_security/balance_request
Payload:
payload.json
{
"document_number": "16514548091",
"benefit_number": 2052711150
}
Response
- MÉTODOPOST
- ENDPOINT/social_security/balance_request
Body:
body.json
{
"balance_request_key": "ffda1935-9cad-47df-b848-cd33c96024e4",
"document_number": "16514548091",
"status": "pending_authorization",
"authorization_term": {
"authorization_term_key": "19196811-366f-4422-a729-4d0aa552449b",
"status": "allowed"
},
"status_events": [
{
"status": "pending_authorization",
"event_date": "2023-12-22T16:18:18"
}
]
}
2.2. Consulta de dados do benefício com envio do Termo de Autorização.
Request
- MÉTODOPOST
- ENDPOINT/social_security/balance_request
Payload:
payload.json
{
"document_number": "14950479032",
"benefit_number": 22255220,
"authorization_term": {
"document_number": "14950479032",
"legal_representative_document_number": "32866210050", // CPF do representante legal (caso aplicável)
"signature": {
"signer": {
"name": "Nome Cliente",
"phone": {
"number": "887577622",
"area_code": "19",
"country_code": "55"
},
"document_number": "14950479032"
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "2023-12-05T21:04:06",
"ip_address": "200.223.171.82",
"fingerprint": {
"lat": "-44.00524157713981",
"long": "-19.807649431219804",
"name": "Nome Cliente",
"model": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.6 Mobile/15E148 Safari/604.1",
"localeHashValue": "hash cliente"
},
"third_party_additional_data": {},
"session_id": "b75c7ac2-3be3-41b6-b769-4d982a5824a2"
},
"signed_object": {
"document_key": "cfbc8469-89ea-4a80-9f64-ba7b1566c68b"
}
}
}
}
Nos casos em que houver representante legal, é necessário preencher o campo "legal_representative_document_number" com o CPF do representante legal, e os dados do objeto "signer" devem ser preenchidos com os dados do mesmo.
Response
-
MÉTODOPOST
-
ENDPOINT/social_security/balance_request
-
Body:
body.json
{
"balance_request_key": "ffda1935-9cad-47df-b848-cd33c96024e4",
"document_number": "14950479032",
"status": "pending_authorization",
"authorization_term": {
"authorization_term_key": "19196811-366f-4422-a729-4d0aa552449b",
"status": "signed"
},
"status_events": [
{
"status": "pending_authorization",
"event_date": "2023-12-22T16:18:18"
}
]
}
Em caso de sucesso na consulta de dados do benefício
Webhook
- WEBHOOK_TYPE/social_security/balance_request
- STATUSSuccess
Body:
body.json
{
"webhook": {
"key": "ffda1935-9cad-47df-b848-cd33c96024e4",
"data": {
"name": "IVOLANDO MIRANDA",
"state": "SP",
"alimony": "not_payer",
"birth_date": "07021961",
"grant_date": "2022-09-02",
"credit_type": "checking_account",
"block_type": "not_blocked",
"benefit_card": {
"limit": 2083.2,
"balance": 0
},
"benefit_number": "22255220",
"benefit_status": "elegible",
"consigned_card": {
"limit": 2083.2,
"balance": 0
},
"assistance_type": "retirement_by_age",
"document_number": "14950479032",
"benefit_end_date": "2020-12-01",
"consigned_credit": {
"balance": 1000
},
"benefit_situation": "active",
"max_total_balance": 2000,
"used_total_balance": 1000,
"politically_exposed": {
"type": "politically_exposed_level_1",
"is_politically_exposed": true
},
"has_power_of_attorney": false,
"available_total_balance": 1000,
"has_judicial_concession": false,
"number_of_portabilities": 0,
"disbursement_bank_account": {
"bank_code": "341",
"account_digit": "6",
"account_branch": "0155",
"account_number": "000059923"
},
"has_entity_representation": false,
"social_benefit_max_balance": 2000,
"social_benefit_used_balance": 1000,
"benefit_quota_expiration_date": null,
"number_of_active_reservations": 0,
"number_of_suspended_reservations": 0,
"number_of_refinanced_reservations": 0,
"number_of_active_suspended_reservations": 3
},
"status": "success",
"webhook_type": "social_security_balance_request",
"event_datetime": "2023-12-22T16:18:21"
}
}
Detalhamento de campos no webhook de sucesso
| Campo | Descrição | Valores |
|---|---|---|
| assistance_type | Tipo do benefício | Enumeradores |
| benefit_status | Status do beneficio | Enumeradores |
| has_entity_representation | Possui entidade de representação (não permite averbação) | True ou False |
| alimony_code | Classificador da Pensão alimentícia | not_payer, payer, benefit |
| has_judicial_concession | Benefício concedido por liminar | True ou False |
| has_power_of_attorney | Possui procurador? | True ou False |
| credit_type | Tipo de crédito - recebimento do benefício | Magnetic_card, checking_account |
| benefit_situation | Situação do benefício | Enumeradores |
| used_total_balance | Valor total comprometido em averbações de empréstimos, reservado para portabilidade, refinanciamento, alterações, RMC e RCC | Numérico |
| max_total_balance | Valor comprometido possível para a respectiva espécie do benefício | Numérico |
| available_total_balance | Valor total disponível para empréstimo, somando todas as modalidades (diferença entre max_total_balance e used_total_balance) | Numérico |
| benefit_quota_expiration_date | Data de extinção do benefício. A informação está disponível apenas para alguns benefícios de pensão por morte. | String ou nulo |
| block_type | Tipo de bloqueio do benefício | Enumeradores |
| politically_exposed.type | Pessoa politicamente exposta | Enumeradores |
| is_politically_exposed | Pessoa politicamente exposta | True ou False |
Em caso de falha na consulta da lista de benefícios
Webhook
- WEBHOOK_TYPE/social_security/balance_request
- STATUSFailure
Body:
body.json
{
"webhook": {
"key": "37a14593-b934-457c-8cf6-e51f184b1f1c",
"data": {
"enumerator": "inexistent_beneficiary",
"description": "no beneficiary found"
},
"status": "failure",
"webhook_type": "social_security_balance_request",
"event_datetime": "2023-12-22T16:22:29"
}
}
Detalhamento de campos no webhook de falha
| Campo | Descrição | Valores |
|---|---|---|
| enumerator | Retorno mapeado do código Dataprev | Enumeradores |
Simulando cenários de sucesso e insucesso na consulta de dados do benefício em Sandbox:
A simulação de cenários é baseado no primeiro dígito do CPF informado na operação.
11.1. Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook.
11.2. Para os demais CPFs, será retornado uma resposta assíncrona de erro, baseado no primeiro dígito do CPF digitado, de acordo com a tabela abaixo.
| Início do CPF | Enumerador | Descrição |
|---|---|---|
| 2 | inexistent_beneficiary | no beneficiary found |
Todos os CPFs que não tiverem um cenário mapeado para o primeiro dígito, receberão um webhook com um erro padrão de cenário de teste não mapeado.
| Enumerador | Descrição |
|---|---|
| mock_error | Informed document number is not a valid mock on test environment |
3 - Digitação da Proposta:
Para que os pedidos de averbação, tanto da portabilidade, como do refinanciamento sejam criados com sucesso, é preciso que seja feita uma consulta de dados válida para o benefício previamente. Para isso basta seguir os passos do item 2 - Consulta de dados do benefício.
Falha na averbação por falta de uma consulta de dados válida do benefício
Se uma consulta dos dados do benefício não for realizada com sucesso antes do pedido de averbação, o status do pedido de averbação ficará como "aguardando ação do parceiro" e será enviado um webhook no seguinte formato para informar o ocorrido:
Webhook Body
{
"webhook": {
"key": "\<DEBT-KEY\>",
"data": {
"enumerator": "success_balance_request_not_found",
"description": "Success balance request not found for the specified benefit number"
},
"status": "pending_requester_action",
"webhook_type": "social_security_success_balance_request_not_found",
"event_datetime": "2024-02-26T21:36:22"
}
}
Para prosseguir, as seguintes ações deverão ser tomadas:
- Realizar a consulta dos dados do benefício em questão seguindo os passos do item 2 - Consulta de dados do benefício;
- Enviar uma requisição no formato abaixo para informar que a consulta foi realizada.
Essa requisição não apenas confirma a existência de uma consulta válida dos dados do benefício, mas também verifica se as informações enviadas para a criação da averbação estão corretas, permitindo assim a continuidade do processo.
3.1. Digitação da Proposta de Portabilidade com Refinanciamento: Essa forma de digitação é utilizada para realizar a portabilidade de um contrato de crédito, liberando, ao final, mais dinheiro para o devedor. O valor liberado após a portabilidade é chamado de “Troco”. A Proposta de Portabilidade e a Proposta de Refinanciamento podem ser geradas em uma mesma Request.
Para a digitação da proposta devem ser enviadas as seguintes informações:
-
Dados cadastrais do tomador do crédito.
-
Dados cadastrais do Representante Legal (caso aplicável).
-
Dados financeiros da operação de portabilidade informando sempre o número de parcelas e uma das opções entre taxa de juros e valor de face da parcela.
-
Dados financeiros da operação de refinanciamento (operação que quita a operação de portabilidade e libera o troco) juntamente com os dados de conta bancária para pagamento do troco, conforme retornado na consulta dos dados do benefício.
-
Saldo devedor, número do contrato original e ispb do credor original. Como a operação de Refinanciamento não possui data de desembolso fixa, a mudança na data de desembolso altera os valores da operação, sendo necessário informar se a taxa (“monthly_interest_rate”) deve ser fixa ou se o valor liberado ao cliente (“disbursed_amount“) deve ser fixo.
Caso a proposta seja de cliente analfabeto, os dados do rogado e testemunhas devem ser enviados no campo additional_data do payload de criação da proposta. Porém, deve ser previamente alinhado com a QI Tech quais informações e formato serão utilizados
3.1.1. Digitação da Proposta de Portabilidade com Refinanciamento com taxa fixa: Segue abaixo, exemplo de digitação da proposta fixando a taxa da operação:
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal
Payload:
- Sem Registro na C3
- Com Registro na C3
{
"proposal_type": "inss",
"purchaser_document_number": "32402502000135",
"borrower": {
"person_type": "natural",
"name": "Marilene da Silva",
"mother_name": "Maria Mariane",
"birth_date": "1990-05-06",
"profession": "Desenvolvedora",
"nationality": "Brasileira",
"marital_status": "single",
"is_pep": false,
"individual_document_number": "20676928013",
"document_identification_number": "381803326",
"email": "elaineisadoradacruz@hotmal.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "912828135"
},
"address": {
"street": "Passagem Mariana",
"state": "PA",
"city": "Ananindeua",
"neighborhood": "Águas Lindas",
"number": "660",
"postal_code": "67118003",
"complement": "complemento"
},
"document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
"document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a",
"selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076"
},
"related_parties": [
{
"name": "Nome Representante Legal",
"email": "email@email.com.br",
"birth_date": "2000-12-12",
"is_pep": false,
"mother_name": "maria",
"phone": {
"number": "991294043",
"area_code": "11",
"country_code": "055"
},
"address": {
"street": "Avenida das Castanheiras",
"state": "SP",
"city": "Brasília",
"neighborhood": "bairro",
"number": "12",
"postal_code": "71900100",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"individual_document_number": "20676928013",
"document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650",
"document_identification_type": "rg",
"document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b",
"document_identification_number": "123456789",
"selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1"
}
],
"collaterals": [
{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": "22255220",
"state": "SP",
"subcorban_document_number": "12123456000101"
}
}
],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"number_of_installments": 10
},
"contract_number": "300523588BF"
},
"refinancing_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"installment_face_value": 100,
"number_of_installments": 10
},
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "000059923",
"ispb": "341",
"bank_code": "341",
"branch_number": "0155"
},
"contract_number": "200523588BF"
},
"origin_contract": {
"ispb": "60746948",
"contract_number": "558472",
"last_due_balance": 997.87
},
"additional_data": {}
}
{
"proposal_type": "inss",
"purchaser_document_number": "32402502000135",
"borrower": {
"person_type": "natural",
"name": "Marilene da Silva",
"mother_name": "Maria Mariane",
"gender": "female",
"birth_date": "1990-05-06",
"profession": "Desenvolvedora",
"nationality": "Brasileira",
"marital_status": "single",
"is_pep": false,
"individual_document_number": "20676928013",
"document_identification_number": "381803326",
"document_identification_date": "2019-01-28",
"document_identification_type": "rg",
"email": "elaineisadoradacruz@hotmal.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "912828135"
},
"address": {
"street": "Passagem Mariana",
"state": "PA",
"city": "Ananindeua",
"neighborhood": "Águas Lindas",
"number": "660",
"postal_code": "67118003",
"complement": "complemento"
},
"document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
"document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a",
"selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076"
},
"related_parties": [
{
"name": "Nome Representante Legal",
"email": "email@email.com.br",
"birth_date": "2000-12-12",
"is_pep": false,
"mother_name": "maria",
"phone": {
"number": "991294043",
"area_code": "11",
"country_code": "055"
},
"address": {
"street": "Avenida das Castanheiras",
"state": "SP",
"city": "Brasília",
"neighborhood": "bairro",
"number": "12",
"postal_code": "71900100",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"individual_document_number": "20676928013",
"document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650",
"document_identification_type": "rg",
"document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b",
"document_identification_number": "123456789",
"selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1"
}
],
"collaterals": [
{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": "22255220",
"state": "SP",
"subcorban_document_number": "12123456000101"
}
}
],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"number_of_installments": 10
},
"contract_number": "300523588PF"
},
"refinancing_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"installment_face_value": 100,
"number_of_installments": 10
},
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "000059923",
"ispb": "341",
"bank_code": "341",
"branch_number": "0155"
},
"contract_number": "200523588PK"
},
"origin_contract": {
"ispb": "60746948",
"contract_number": "558472",
"last_due_balance": 997.87
},
"additional_data": {}
}
Segundo informado pelo DATAPREV, os benefícios provenientes do RS poderão ter uma carência de até 6 meses nos novos contratos de refinancimento gerados a partir de 28/06/2024. Para isso, é preciso acrescentar um campo a mais nos payloads acima dentro de "collateral_data" chamado "number_of_grace_periods". Esse campo vai conter o valor do número de meses desejados para carência, como no exemplo abaixo:
"collaterals": [
{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": "22255220",
"state": "RS",
"number_of_grace_periods": 3,
"subcorban_document_number": "12123456000101"
}
}
]
A lista “related_parties”, só deve ser enviada caso seja uma operação com Representante Legal. Quando enviado, deve conter os dados cadastrais do representante legal e o campo “role_type” deve ser enviado contendo o valor: ”issuer_legal_representative”.
No campo “origin_contract.ispb“ é informado o ISPB da instituição Credora Original. O ISPB é a base do CNPJ da instituição. Para ter acesso à lista completa de ISPB’s de cada instituição participante do CTC - CIP (Central de Transferência de Crédito), basta utilizar o endpoint de consulta de participantes do CTC (índice):
3.1.2. Digitação da Proposta de Portabilidade com Refinanciamento com valor liberado fixo:
Segue abaixo, exemplo de digitação da proposta fixando o valor liberado ao cliente:
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal
Payload:
- Sem Registro na C3
- Com Registro na C3
{
"proposal_type": "inss",
"purchaser_document_number": "32402502000135",
"borrower": {
"person_type": "natural",
"name": "Elaine Isadora da Cruz",
"mother_name": "Maria Mariane",
"birth_date": "1990-05-06",
"profession": "Desenvolvedora",
"nationality": "Brasileira",
"marital_status": "single",
"is_pep": false,
"individual_document_number": "90406718261",
"document_identification_number": "381803326",
"email": "elaineisadoradacruz@hotmal.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "996363253"
},
"address": {
"street": "Passagem Mariana",
"state": "PA",
"city": "Ananindeua",
"neighborhood": "Aguas Lindas",
"number": "660",
"postal_code": "67118003",
"complement": "complemento"
},
"document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
"document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a",
"selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076"
},
"related_parties": [{
"name": "Nome Representante Legal",
"email": "email@email.com.br",
"birth_date": "2000-12-12",
"is_pep": false,
"mother_name": "maria",
"phone": {
"number": "991294043",
"area_code": "11",
"country_code": "055"
},
"address": {
"street": "Avenida das Castanheiras",
"state": "SP",
"city": "Brasília",
"neighborhood": "bairro",
"number": "12",
"postal_code": "71900100",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"individual_document_number": "45102538004",
"document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650",
"document_identification_type": "rg",
"document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b",
"document_identification_number": "123456789",
"selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1"
}],
"collaterals": [{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": "12345678",
"state": "SP",
"subcorban_document_number": "12123456000101"
}
}],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"number_of_installments": 10
},
"contract_number": "3635259610"
},
"refinancing_credit_operation": {
"financial": {
"disbursed_amount": 1000,
"installment_face_value": 110,
"number_of_installments": 10
},
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "00001",
"bank_code": "033",
"branch_number": "0001"
},
"contract_number": "3635259632"
},
"origin_contract": {
"ispb": "60746948",
"contract_number": "5584745",
"last_due_balance": 800
},
"additional_data": {}
}
{
"proposal_type": "inss",
"purchaser_document_number": "32402502000135",
"borrower": {
"person_type": "natural",
"name": "Elaine Isadora da Cruz",
"mother_name": "Maria Mariane",
"birth_date": "1990-05-06",
"gender": "female",
"profession": "Desenvolvedora",
"nationality": "Brasileira",
"marital_status": "single",
"is_pep": false,
"individual_document_number": "90406718261",
"document_identification_number": "381803326",
"document_identification_type": "rg",
"document_identification_date": "2019-01-28",
"email": "elaineisadoradacruz@hotmal.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "996363253"
},
"address": {
"street": "Passagem Mariana",
"state": "PA",
"city": "Ananindeua",
"neighborhood": "Aguas Lindas",
"number": "660",
"postal_code": "67118003",
"complement": "complemento"
},
"document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
"document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a",
"selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076"
},
"related_parties": [{
"name": "Nome Representante Legal",
"email": "email@email.com.br",
"birth_date": "2000-12-12",
"is_pep": false,
"mother_name": "maria",
"phone": {
"number": "991294043",
"area_code": "11",
"country_code": "055"
},
"address": {
"street": "Avenida das Castanheiras",
"state": "SP",
"city": "Brasília",
"neighborhood": "bairro",
"number": "12",
"postal_code": "71900100",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"individual_document_number": "45102538004",
"document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650",
"document_identification_type": "rg",
"document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b",
"document_identification_number": "123456789",
"selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1"
}],
"collaterals": [{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": "12345678",
"state": "SP",
"subcorban_document_number": "12123456000101"
}
}],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"number_of_installments": 10
},
"contract_number": "3635259611"
},
"refinancing_credit_operation": {
"financial": {
"disbursed_amount": 1000,
"installment_face_value": 110,
"number_of_installments": 10
},
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "00001",
"bank_code": "033",
"branch_number": "0001"
},
"contract_number": "3635259663"
},
"origin_contract": {
"ispb": "60746948",
"contract_number": "5584745",
"last_due_balance": 800
},
"additional_data": {}
}
3.1.3. Response
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal
Body:
body.json
{
"borrower": {
"individual_document_number": "90406718261",
"name": "Elaine Isadora da Cruz",
"related_party_key": "d7f84a9d-28ba-4355-8e5e-a436ff4c3c2d",
"role_type": "issuer"
},
"portability_credit_operation": {
"collateral_is_constituted": false,
"contract_number": "3635259611",
"credit_operation_key": "235ce3a5-eea1-4b13-9335-3de577318f8b",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [],
"disbursement_options": [
{
"annual_cet": 0.17295,
"cet": 0.0134,
"contract_fee_amount": 0.0,
"contract_fees": [
{
"amount": 0.5,
"amount_type": "percentage",
"fee_amount": 0.0,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 800.0,
"disbursement_date": "2023-12-22",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"installments": [
{
"business_due_date": "2024-02-22",
"calendar_days": 62,
"due_date": "2024-02-22",
"due_principal": 800.0,
"installment_number": 1,
"pre_fixed_amount": 21.977846031814607,
"principal_amortization_amount": 65.21215396818539,
"total_amount": 87.19,
"workdays": 40
},
{
"business_due_date": "2024-03-22",
"calendar_days": 29,
"due_date": "2024-03-22",
"due_principal": 734.7878460318146,
"installment_number": 2,
"pre_fixed_amount": 9.373907348762184,
"principal_amortization_amount": 77.81609265123781,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-04-22",
"calendar_days": 31,
"due_date": "2024-04-22",
"due_principal": 656.9717533805768,
"installment_number": 3,
"pre_fixed_amount": 8.963122696164149,
"principal_amortization_amount": 78.22687730383585,
"total_amount": 87.19,
"workdays": 20
},
{
"business_due_date": "2024-05-22",
"calendar_days": 30,
"due_date": "2024-05-22",
"due_principal": 578.744876076741,
"installment_number": 4,
"pre_fixed_amount": 7.639487642788938,
"principal_amortization_amount": 79.55051235721106,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-06-24",
"calendar_days": 33,
"due_date": "2024-06-24",
"due_principal": 499.19436371952986,
"installment_number": 5,
"pre_fixed_amount": 7.253119731550034,
"principal_amortization_amount": 79.93688026844997,
"total_amount": 87.19,
"workdays": 22
},
{
"business_due_date": "2024-07-22",
"calendar_days": 28,
"due_date": "2024-07-22",
"due_principal": 419.2574834510799,
"installment_number": 6,
"pre_fixed_amount": 5.163027422441386,
"principal_amortization_amount": 82.02697257755861,
"total_amount": 87.19,
"workdays": 20
},
{
"business_due_date": "2024-08-22",
"calendar_days": 31,
"due_date": "2024-08-22",
"due_principal": 337.2305108735213,
"installment_number": 7,
"pre_fixed_amount": 4.600865151805861,
"principal_amortization_amount": 82.58913484819413,
"total_amount": 87.19,
"workdays": 23
},
{
"business_due_date": "2024-09-23",
"calendar_days": 32,
"due_date": "2024-09-23",
"due_principal": 254.64137602532716,
"installment_number": 8,
"pre_fixed_amount": 3.586947657335553,
"principal_amortization_amount": 83.60305234266444,
"total_amount": 87.19,
"workdays": 22
},
{
"business_due_date": "2024-10-22",
"calendar_days": 29,
"due_date": "2024-10-22",
"due_principal": 171.0383236826627,
"installment_number": 9,
"pre_fixed_amount": 2.18198682510524,
"principal_amortization_amount": 85.00801317489476,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-11-22",
"calendar_days": 31,
"due_date": "2024-11-22",
"due_principal": 86.03031050776795,
"installment_number": 10,
"pre_fixed_amount": 1.1637189988799015,
"principal_amortization_amount": 86.0262810011201,
"total_amount": 87.19,
"workdays": 22
}
],
"issue_amount": 800.0,
"number_of_installments": 10,
"prefixed_interest_rate": {
"annual_rate": 0.17042118,
"daily_rate": 0.00043722,
"interest_base": "calendar_days",
"monthly_rate": 0.0132
},
"total_iof": 0.0
}
],
"document_key": "c4cedeaf-23bf-450d-9fba-5ec6b5d45afb",
"document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/c4cedeaf-23bf-450d-9fba-5ec6b5d45afb/TESTEINSSS.A.-ELAINEISADORADACRUZ-CCB-3635259611.pdf",
"final_disbursement_amount": 0.0
},
"proposal_key": "2f7e320c-2a35-4e78-bfd7-a298b28a7497",
"proposal_number": "17032782193414588",
"proposal_status": "pending_submission",
"refinancing_credit_operation": {
"collateral_is_constituted": false,
"contract_number": "3635259663",
"credit_operation_key": "f73ba4d2-cd0a-4405-a47e-a51f325a9756",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [
{
"account_branch": "0001",
"account_digit": "1",
"account_number": "00001",
"bank_code": "033"
}
],
"disbursement_options": [
{
"annual_cet": 0.193423,
"cet": 0.0148,
"contract_fee_amount": 1.03,
"contract_fees": [
{
"amount": 0.5,
"amount_type": "percentage",
"fee_amount": 1.03,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 1000.0,
"disbursement_date": "2023-12-22",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"installments": [
{
"business_due_date": "2024-02-22",
"calendar_days": 62,
"due_date": "2024-02-22",
"due_principal": 1005.24,
"installment_number": 1,
"pre_fixed_amount": 28.92478321729087,
"principal_amortization_amount": 81.07521678270913,
"total_amount": 110.0,
"workdays": 40
},
{
"business_due_date": "2024-03-22",
"calendar_days": 29,
"due_date": "2024-03-22",
"due_principal": 924.1647832172908,
"installment_number": 2,
"pre_fixed_amount": 12.344286518064438,
"principal_amortization_amount": 97.65571348193556,
"total_amount": 110.0,
"workdays": 21
},
{
"business_due_date": "2024-04-22",
"calendar_days": 31,
"due_date": "2024-04-22",
"due_principal": 826.5090697353553,
"installment_number": 3,
"pre_fixed_amount": 11.806660138520433,
"principal_amortization_amount": 98.19333986147957,
"total_amount": 110.0,
"workdays": 20
},
{
"business_due_date": "2024-05-22",
"calendar_days": 30,
"due_date": "2024-05-22",
"due_principal": 728.3157298738757,
"installment_number": 4,
"pre_fixed_amount": 10.06605046134725,
"principal_amortization_amount": 99.93394953865275,
"total_amount": 110.0,
"workdays": 21
},
{
"business_due_date": "2024-06-24",
"calendar_days": 33,
"due_date": "2024-06-24",
"due_principal": 628.381780335223,
"installment_number": 5,
"pre_fixed_amount": 9.559924513271145,
"principal_amortization_amount": 100.44007548672886,
"total_amount": 110.0,
"workdays": 22
},
{
"business_due_date": "2024-07-22",
"calendar_days": 28,
"due_date": "2024-07-22",
"due_principal": 527.9417048484942,
"installment_number": 6,
"pre_fixed_amount": 6.807113809566991,
"principal_amortization_amount": 103.19288619043301,
"total_amount": 110.0,
"workdays": 20
},
{
"business_due_date": "2024-08-22",
"calendar_days": 31,
"due_date": "2024-08-22",
"due_principal": 424.7488186580611,
"installment_number": 7,
"pre_fixed_amount": 6.067525608326975,
"principal_amortization_amount": 103.93247439167303,
"total_amount": 110.0,
"workdays": 23
},
{
"business_due_date": "2024-09-23",
"calendar_days": 32,
"due_date": "2024-09-23",
"due_principal": 320.8163442663881,
"installment_number": 8,
"pre_fixed_amount": 4.731771911001933,
"principal_amortization_amount": 105.26822808899807,
"total_amount": 110.0,
"workdays": 22
},
{
"business_due_date": "2024-10-22",
"calendar_days": 29,
"due_date": "2024-10-22",
"due_principal": 215.54811617739003,
"installment_number": 9,
"pre_fixed_amount": 2.87912691853476,
"principal_amortization_amount": 107.12087308146523,
"total_amount": 110.0,
"workdays": 21
},
{
"business_due_date": "2024-11-22",
"calendar_days": 31,
"due_date": "2024-11-22",
"due_principal": 108.4272430959248,
"installment_number": 10,
"pre_fixed_amount": 1.5688802916587754,
"principal_amortization_amount": 108.43111970834123,
"total_amount": 110.0,
"workdays": 22
}
],
"issue_amount": 1005.24,
"number_of_installments": 10,
"prefixed_interest_rate": {
"annual_rate": 0.17905959,
"daily_rate": 0.00045765,
"interest_base": "calendar_days",
"monthly_rate": 0.01382107
},
"total_iof": 4.21
}
],
"document_key": "f4dfb505-3cec-4a97-9b16-dadc39bb4c7e",
"document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/f4dfb505-3cec-4a97-9b16-dadc39bb4c7e/TESTEINSSS.A.-ELAINEISADORADACRUZ-CCB-3635259663.pdf",
"final_disbursement_amount": 200.0
},
"related_party_list": [
{
"individual_document_number": "45102538004",
"name": "Nome Representante Legal",
"related_party_key": "632fa6c5-40e8-4e76-862e-e10951ed8bff",
"role_type": "issuer_legal_representative"
}
]
}
Segue abaixo definições e descrições de alguns campos retornados na resposta da digitação da Proposta:
[A]: “portability_credit_operation.disbursement_options.iof_amount”: Na Operação de Portabilidade o IOF sempre será zero.
[B]: “portability_credit_operation.disbursement_options.disbursed_issue_amount”: É igual ao valor do saldo devedor do Contrato Original.
[C]: “portability_credit_operation.disbursement_options.issue_amount”: É o valor da Operação de Portabilidade.
[D]: “refinancing_credit_operation.disbursement_options.iof_amount”: Valor de IOF da Operação de Refinanciamento (Troco).
[E]: “refinancing_credit_operation.disbursement_options.disbursed_issue_amount”: É o valor destinado à quitação do saldo devedor da Operação de Portabilidade.
[F]: “refinancing_credit_operation.disbursement_options.final_disbursement_amount”: É o valor do Troco liberado para o cliente na conta de desembolso informada no momento da digitação da Proposta (deve ser a conta informação da consulta dos dados do benefício).
[G]: “refinancing_credit_operation.disbursement_options.issue_amount”: É o valor do Refinanciamento.
Os campos “portability_credit_operation.disbursement_options.collateral_constituted“ e “refinancing_credit_operation.disbursement_options.collateral_constituted“ informam se a margem do cliente esta averbada na Dataprev. O processo de averbação da Portabilidade será iniciado assim que os recursos para quitação do contrato original forem enviados a Instituição Credora Original (Item 6.4.). O Processo de averbação do Refinanciamento é iniciado no momento em que o Parceiro decide por prosseguir com a Operação de Refinanciamento (Item 7.1.1. e 7.2.).
3.2. Digitação da Proposta de Portabilidade:
A Proposta de Portabilidade (Portabilidade Pura) deve ser digitada de forma semelhante ao descrito no item 3.1.1, porém deve ser enviada sem o objeto “refinancing_credit_operation“.
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal
Body:
body.json
{
"proposal_type": "inss",
"purchaser_document_number": "32402502000135",
"borrower": {
"person_type": "natural",
"name": "Elaine Isadora da Cruz",
"mother_name": "Maria Mariane",
"birth_date": "1990-05-06",
"gender": "female",
"profession": "Desenvolvedora",
"nationality": "Brasileira",
"marital_status": "single",
"is_pep": false,
"individual_document_number": "90406718261",
"document_identification_number": "381803326",
"document_identification_type": "rg",
"document_identification_date": "2019-01-28",
"email": "elaineisadoradacruz@hotmal.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "996363253"
},
"address": {
"street": "Passagem Mariana",
"state": "PA",
"city": "Ananindeua",
"neighborhood": "Aguas Lindas",
"number": "660",
"postal_code": "67118003",
"complement": "complemento"
},
"document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
"document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a",
"selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076"
},
"related_parties": [{
"name": "Nome Representante Legal",
"email": "email@email.com.br",
"birth_date": "2000-12-12",
"is_pep": false,
"mother_name": "maria",
"phone": {
"number": "991294043",
"area_code": "11",
"country_code": "055"
},
"address": {
"street": "Avenida das Castanheiras",
"state": "SP",
"city": "Brasília",
"neighborhood": "bairro",
"number": "12",
"postal_code": "71900100",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"individual_document_number": "45102538004",
"document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650",
"document_identification_type": "rg",
"document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b",
"document_identification_number": "123456789",
"selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1"
}],
"collaterals": [{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": "12345678",
"state": "SP",
"subcorban_document_number": "12123456000101"
}
}],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"number_of_installments": 10
},
"contract_number": "1020252636"
},
"origin_contract": {
"ispb": "60746948",
"contract_number": "558474520",
"last_due_balance": 800
},
"additional_data": {}
}
Response
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal
Payload:
payload.json
{
"borrower": {
"individual_document_number": "90406718261",
"name": "Elaine Isadora da Cruz",
"related_party_key": "f9fbaa93-4d57-494f-b60f-dcba8cb64a45",
"role_type": "issuer"
},
"portability_credit_operation": {
"collateral_is_constituted": false,
"contract_number": "1020252636",
"credit_operation_key": "1cd34a63-5a61-49a3-90a5-7a515ee98932",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [],
"disbursement_options": [
{
"annual_cet": 0.17295,
"cet": 0.0134,
"contract_fee_amount": 0.0,
"contract_fees": [
{
"amount": 0.5,
"amount_type": "percentage",
"fee_amount": 0.0,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 800.0,
"disbursement_date": "2023-12-22",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"installments": [
{
"business_due_date": "2024-02-22",
"calendar_days": 62,
"due_date": "2024-02-22",
"due_principal": 800.0,
"installment_number": 1,
"pre_fixed_amount": 21.977846031814607,
"principal_amortization_amount": 65.21215396818539,
"total_amount": 87.19,
"workdays": 40
},
{
"business_due_date": "2024-03-22",
"calendar_days": 29,
"due_date": "2024-03-22",
"due_principal": 734.7878460318146,
"installment_number": 2,
"pre_fixed_amount": 9.373907348762184,
"principal_amortization_amount": 77.81609265123781,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-04-22",
"calendar_days": 31,
"due_date": "2024-04-22",
"due_principal": 656.9717533805768,
"installment_number": 3,
"pre_fixed_amount": 8.963122696164149,
"principal_amortization_amount": 78.22687730383585,
"total_amount": 87.19,
"workdays": 20
},
{
"business_due_date": "2024-05-22",
"calendar_days": 30,
"due_date": "2024-05-22",
"due_principal": 578.744876076741,
"installment_number": 4,
"pre_fixed_amount": 7.639487642788938,
"principal_amortization_amount": 79.55051235721106,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-06-24",
"calendar_days": 33,
"due_date": "2024-06-24",
"due_principal": 499.19436371952986,
"installment_number": 5,
"pre_fixed_amount": 7.253119731550034,
"principal_amortization_amount": 79.93688026844997,
"total_amount": 87.19,
"workdays": 22
},
{
"business_due_date": "2024-07-22",
"calendar_days": 28,
"due_date": "2024-07-22",
"due_principal": 419.2574834510799,
"installment_number": 6,
"pre_fixed_amount": 5.163027422441386,
"principal_amortization_amount": 82.02697257755861,
"total_amount": 87.19,
"workdays": 20
},
{
"business_due_date": "2024-08-22",
"calendar_days": 31,
"due_date": "2024-08-22",
"due_principal": 337.2305108735213,
"installment_number": 7,
"pre_fixed_amount": 4.600865151805861,
"principal_amortization_amount": 82.58913484819413,
"total_amount": 87.19,
"workdays": 23
},
{
"business_due_date": "2024-09-23",
"calendar_days": 32,
"due_date": "2024-09-23",
"due_principal": 254.64137602532716,
"installment_number": 8,
"pre_fixed_amount": 3.586947657335553,
"principal_amortization_amount": 83.60305234266444,
"total_amount": 87.19,
"workdays": 22
},
{
"business_due_date": "2024-10-22",
"calendar_days": 29,
"due_date": "2024-10-22",
"due_principal": 171.0383236826627,
"installment_number": 9,
"pre_fixed_amount": 2.18198682510524,
"principal_amortization_amount": 85.00801317489476,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-11-22",
"calendar_days": 31,
"due_date": "2024-11-22",
"due_principal": 86.03031050776795,
"installment_number": 10,
"pre_fixed_amount": 1.1637189988799015,
"principal_amortization_amount": 86.0262810011201,
"total_amount": 87.19,
"workdays": 22
}
],
"issue_amount": 800.0,
"number_of_installments": 10,
"prefixed_interest_rate": {
"annual_rate": 0.17042118,
"daily_rate": 0.00043722,
"interest_base": "calendar_days",
"monthly_rate": 0.0132
},
"total_iof": 0.0
}
],
"document_key": "2f9ac920-a5e8-4386-b049-dc971e1fc20b",
"document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/2f9ac920-a5e8-4386-b049-dc971e1fc20b/TESTEINSSS.A.-ELAINEISADORADACRUZ-CCB-1020252636.pdf",
"final_disbursement_amount": 0.0
},
"proposal_key": "9661aef8-e897-4405-a44f-ca8a43d9cee3",
"proposal_number": "17032785232138245",
"proposal_status": "pending_submission",
"related_party_list": [
{
"individual_document_number": "45102538004",
"name": "Nome Representante Legal",
"related_party_key": "c8166f37-b496-455a-96e7-f75e24f084a1",
"role_type": "issuer_legal_representative"
}
]
}
3.3. Recuperando dados de uma proposta:
- MÉTODOGET
- STATUS/v2/credit_transfer/proposal/PROPOSAL-KEY
Response:
response.json
{
"borrower": {
"address": {
"city": "Ananindeua",
"complement": "complemento",
"neighborhood": "Aguas Lindas",
"number": "660",
"postal_code": "67118003",
"state": "PA",
"street": "Passagem Mariana"
},
"birth_date": "1990-05-06",
"document_identification_date": "2019-01-28",
"document_identification_number": "381803326",
"document_identification_type": "rg",
"email": "elaineisadoradacruz@hotmal.com",
"gender": "female",
"individual_document_number": "90406718261",
"is_pep": false,
"marital_status": "single",
"mother_name": "Maria Mariane",
"name": "Elaine Isadora da Cruz",
"nationality": "Brasileira",
"person_type": "natural",
"phone": {
"area_code": "11",
"country_code": "055",
"number": "996363253"
},
"profession": "Desenvolvedora",
"related_party_key": "f9fbaa93-4d57-494f-b60f-dcba8cb64a45",
"role_type": "issuer"
},
"origin_operation": {
"contract_number": "558474520",
"ispb_number": "60746948",
"last_due_balance": 800.0
},
"portability_credit_operation": {
"collateral_is_constituted": false,
"contract_number": "1020252636",
"credit_operation_key": "1cd34a63-5a61-49a3-90a5-7a515ee98932",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [],
"disbursement_options": [
{
"annual_cet": 0.17295,
"cet": 0.0134,
"contract_fee_amount": 0.0,
"contract_fees": [
{
"amount": 0.5,
"amount_type": "percentage",
"fee_amount": 0.0,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 800.0,
"disbursement_date": "2023-12-22",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"installments": [
{
"business_due_date": "2024-02-22",
"calendar_days": 62,
"due_date": "2024-02-22",
"due_principal": 800.0,
"installment_number": 1,
"pre_fixed_amount": 21.977846031814607,
"principal_amortization_amount": 65.21215396818539,
"total_amount": 87.19,
"workdays": 40
},
{
"business_due_date": "2024-03-22",
"calendar_days": 29,
"due_date": "2024-03-22",
"due_principal": 734.7878460318146,
"installment_number": 2,
"pre_fixed_amount": 9.373907348762184,
"principal_amortization_amount": 77.81609265123781,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-04-22",
"calendar_days": 31,
"due_date": "2024-04-22",
"due_principal": 656.9717533805768,
"installment_number": 3,
"pre_fixed_amount": 8.963122696164149,
"principal_amortization_amount": 78.22687730383585,
"total_amount": 87.19,
"workdays": 20
},
{
"business_due_date": "2024-05-22",
"calendar_days": 30,
"due_date": "2024-05-22",
"due_principal": 578.744876076741,
"installment_number": 4,
"pre_fixed_amount": 7.639487642788938,
"principal_amortization_amount": 79.55051235721106,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-06-24",
"calendar_days": 33,
"due_date": "2024-06-24",
"due_principal": 499.19436371952986,
"installment_number": 5,
"pre_fixed_amount": 7.253119731550034,
"principal_amortization_amount": 79.93688026844997,
"total_amount": 87.19,
"workdays": 22
},
{
"business_due_date": "2024-07-22",
"calendar_days": 28,
"due_date": "2024-07-22",
"due_principal": 419.2574834510799,
"installment_number": 6,
"pre_fixed_amount": 5.163027422441386,
"principal_amortization_amount": 82.02697257755861,
"total_amount": 87.19,
"workdays": 20
},
{
"business_due_date": "2024-08-22",
"calendar_days": 31,
"due_date": "2024-08-22",
"due_principal": 337.2305108735213,
"installment_number": 7,
"pre_fixed_amount": 4.600865151805861,
"principal_amortization_amount": 82.58913484819413,
"total_amount": 87.19,
"workdays": 23
},
{
"business_due_date": "2024-09-23",
"calendar_days": 32,
"due_date": "2024-09-23",
"due_principal": 254.64137602532716,
"installment_number": 8,
"pre_fixed_amount": 3.586947657335553,
"principal_amortization_amount": 83.60305234266444,
"total_amount": 87.19,
"workdays": 22
},
{
"business_due_date": "2024-10-22",
"calendar_days": 29,
"due_date": "2024-10-22",
"due_principal": 171.0383236826627,
"installment_number": 9,
"pre_fixed_amount": 2.18198682510524,
"principal_amortization_amount": 85.00801317489476,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-11-22",
"calendar_days": 31,
"due_date": "2024-11-22",
"due_principal": 86.03031050776795,
"installment_number": 10,
"pre_fixed_amount": 1.1637189988799015,
"principal_amortization_amount": 86.0262810011201,
"total_amount": 87.19,
"workdays": 22
}
],
"issue_amount": 800.0,
"number_of_installments": 10,
"prefixed_interest_rate": {
"annual_rate": 0.17042118,
"daily_rate": 0.00043722,
"interest_base": "calendar_days",
"monthly_rate": 0.0132
},
"total_iof": 0.0
}
],
"document_key": "2f9ac920-a5e8-4386-b049-dc971e1fc20b",
"document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/2f9ac920-a5e8-4386-b049-dc971e1fc20b/TESTEINSSS.A.-ELAINEISADORADACRUZ-CCB-1020252636.pdf",
"final_disbursement_amount": 0.0
},
"proposal_key": "9661aef8-e897-4405-a44f-ca8a43d9cee3",
"proposal_number": "17032785232138245",
"proposal_status": "pending_submission",
"related_party_list": [
{
"address": {
"city": "Brasília",
"complement": "",
"neighborhood": "bairro",
"number": "12",
"postal_code": "71900100",
"state": "SP",
"street": "Avenida das Castanheiras"
},
"birth_date": "2000-12-12",
"document_identification_date": "2019-01-28",
"document_identification_type": "rg",
"email": "email@email.com.br",
"gender": "female",
"individual_document_number": "45102538004",
"is_pep": false,
"mother_name": "maria",
"name": "Nome Representante Legal",
"person_type": "natural",
"phone": {
"area_code": "11",
"country_code": "055",
"number": "991294043"
},
"related_party_key": "c8166f37-b496-455a-96e7-f75e24f084a1",
"role_type": "issuer_legal_representative"
}
],
"collaterals": [{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": 12345678,
"state": "SP"
}
}],
"inclusion_date": "2022-11-24",
"due_balance_expected_return_date": "2022-12-01"
}
No caso da recuperação dos dados de uma proposta de portabilidade pura o objeto “refinancing_credit_operation” não será retornado.
Correção de dados para refinanciamento:
É possível corrigir os dados financeiros e os bancários da operação de refinanciamento enquanto o refinanciamento original não for averbado.
Request Body
{
"financial": {
"interest_type": "pre_price_days",
"first_due_date": "2024-06-10",
"fine_configuration": {
"monthly_rate": 0.01,
"interest_base": "calendar_days",
"contract_fine_rate": 0.02
},
"credit_operation_type": "ccb",
"monthly_interest_rate": 0.0167,
"installment_face_value": 410,
"limit_days_to_disburse": 7,
"number_of_installments": 84
},
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "00001",
"bank_code": "033",
"branch_number": "0001"
}
}
Response:
response.json
{
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"contract_number": "00000002",
"document_key": "\<DOCUMENT-KEY da CCB de Refinanciamento\>",
"document_url": "\<URL da CCB de Refinanciamento\>",
"credit_operation_status": "issued",
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_options": [{
"installments": [{
"additional_costs": [],
"bank_slip_key": null,
"business_due_date": "2021-08-09",
"calendar_days": 53,
"digitable_line": null,
"due_date": "2021-08-08",
"due_interest": 0,
"due_principal": 997.87,
"fine_amount": null,
"has_interest": true,
"installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
"installment_number": 1,
"installment_status": "created",
"installment_type": "principal",
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 54.84865004983954,
"principal_amortization_amount": 306.98134995016045,
"total_amount": 361.83,
"workdays": 37
},
{
"additional_costs": [],
"bank_slip_key": null,
"business_due_date": "2021-09-08",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2021-09-08",
"due_interest": 0,
"due_principal": 690.8886500498395,
"fine_amount": null,
"has_interest": true,
"installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1",
"installment_number": 2,
"installment_status": "created",
"installment_type": "principal",
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 21.964874249804833,
"principal_amortization_amount": 339.86512575019515,
"tax_amount": 0,
"total_amount": 361.83,
"workdays": 22
}
],
"prefixed_interest_rate": {
"annual_rate": 0.44556431,
"daily_rate": 0.00564312,
"monthly_rate": 0.0556431,
"interest_base": "calendar_days_365"
},
"iof_amount": 50,
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"contract_fee_amount": 0,
"contract_fees": [],
"number_of_installments": 2,
"disbursed_issue_amount": 997.87,
"final_disbursement_amount": 100,
"issue_amount": 1147.87,
"disbursement_date": "2021-05-31",
"cet": 1.212,
"annual_cet": 32.122
}],
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "00001",
"ispb": "00000000",
"branch_number": "0001"
}
}
A key da operação de refinanciamento, a document key, a document url, a related_party_key e a borrower related_party_key mudarão após essa ação, sendo necessário a reassinatura da CCB.
Correção de dados para portabilidade e refin:
É possível corrigir os dados bancários, número do benefício e nome até que o contrato de portabilidade seja averbado. Tanto os dados do operação de portabilidade quanto do refinanciamento serão ajustados. Para isso basta utilizar a seguinte chamada:
Request Body
- Dados Bancários
- Número do Benefício
- Nome
{
"disbursement_bank_account": {
"bank_code": "123",
"account_digit": "1",
"account_branch": "1234",
"account_number": "5678",
"document_number": "12345678901"
}
}
{
"benefit_number": 1234567890
}
{
"name": "Nome do Beneficiário"
}
Simulando cenários de sucesso e insucesso na averbação em Sandbox:
A simulação de cenários é baseado no primeiro dígito do CPF informado na operação.
11.1. Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook.
11.2. Para os demais CPFs, será retornado uma resposta assíncrona de erro, baseado no primeiro dígito do CPF digitado, de acordo com a tabela abaixo.
11.3. Erros com Ação "cancel" receberá um webhook com o resultado final da operação.
| Início do cpf | Enumerador | Descrição | Ação |
|---|---|---|---|
| 2 | invalid_disbursement_account | Invalid disbursemente bank account | cancel |
| 3 | operation_not_allowed_IR | Operation not allowed due to operation deadline greatter than benefit termination | cancel |
Todos os CPFs que não tiverem um cenário mapeado para o primeiro dígito, receberão um webhook com um erro padrão de cenário de teste não mapeado.
| Enumerador | Descrição |
|---|---|
| mock_error | Informed document number is not a valid mock on test environment |
4 - Envio de documentos
Segundo IN 138 do INSS é obrigatório o envio dos dados complementares do contrato.
Os documentos devem ser enviados através do endpoint de upload de documentos. e devem seguir a seguinte formatação:
| Validações | Valores |
|---|---|
| Formato | JPEG |
| Tamanho mínimo | 250 x 250 px |
Caso as validações não sejam atendidas, no momento que o parceiro seguir com a proposta após receber o saldo devedor, iremos devolver os seguintes erros :
- Formato inválido
- Tamanho inválido
{
"title": "Invalid document format",
"description": "The document: document_identification_back should be in JPEG format.",
"translation": "O documento: document_identification_back deve estar no formato JPEG.",
"code": "SSC000061"
}
{
"title": "Invalid document size",
"description": "The document: document_identification_back should have at least 250x250px.",
"translation": "O documento: document_identification_back deve ter no mínimo 250x250px.",
"code": "SSC000060"
}
Após o upload de documentos, as chaves dos documentos enviados devem ser informadas no payload de criação da proposta no tópico anterior dentro do campo borrower ou dentro do objeto de related_parties* correspondente ao representante legal ("role_type": "issuer_legal_representative"):
{
"document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41",
"document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431",
"selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c"
}
Ou ainda, após a criação da proposta, podem ser informadas através do seguinte endpoint:
Request Body
{
"document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41",
"document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431",
"selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c"
}
A related_party_key é retornada na response da criação de dívida dentro do objeto borrower e dentro de cada uma das partes relacionadas dentro de related_party_list se for o caso.
5 - Simulando Proposta de Portabilidade e/ou Refinanciamento:
5.1. Simulação de Portabilidade com Refinanciamento: Antes de realizar a digitação da Proposta de Portabilidade com Refinanciamento, é possível simular as condições financeiras da proposta, sem a necessidade de coletar os dados cadastrais do cliente.
5.1.1. Simulação de Portabilidade com Refinanciamento, com taxa fixa: Assim como na Digitação da Proposta (3.1.1), é possível realizar a simulação fixando a taxa do contrato:
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal_simulation
Request:
body.json
{
"borrower": {
"person_type": "natural"
},
"collaterals": [{
"collateral_type": "social_security"
}],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"number_of_installments": 10
}
},
"refinancing_credit_operation": {
"financial": {
"days_to_accrual": 0,
"monthly_interest_rate": 0.0132,
"installment_face_value": 100,
"number_of_installments": 10
}
},
"origin_contract": {
"last_due_balance": 997.87
}
}
No payload acima, são descritos os dados mínimos para realização da simulação.
Response
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal_simulation
Payload:
response.json
{
"borrower": {
"individual_document_number": "98765432100",
"related_party_key": "fa55dca3-3147-45d2-bb8d-941f2d7191da",
"role_type": "issuer"
},
"portability_credit_operation": {
"credit_operation_key": "a66675e6-bdc2-4468-8420-2889d5cec0a8",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [],
"disbursement_options": [
{
"annual_cet": 0.173044,
"cet": 0.0134,
"contract_fee_amount": 0.0,
"contract_fees": [
{
"amount": 0.5,
"amount_type": "percentage",
"fee_amount": 0.0,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 997.87,
"disbursement_date": "2023-12-22",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"installments": [
{
"business_due_date": "2024-02-22",
"calendar_days": 62,
"due_date": "2024-02-22",
"due_principal": 997.87,
"installment_number": 1,
"pre_fixed_amount": 27.413791524708554,
"principal_amortization_amount": 81.34620847529145,
"total_amount": 108.76,
"workdays": 40
},
{
"business_due_date": "2024-03-22",
"calendar_days": 29,
"due_date": "2024-03-22",
"due_principal": 916.5237915247086,
"installment_number": 2,
"pre_fixed_amount": 11.692366920719124,
"principal_amortization_amount": 97.06763307928088,
"total_amount": 108.76,
"workdays": 21
},
{
"business_due_date": "2024-04-22",
"calendar_days": 31,
"due_date": "2024-04-22",
"due_principal": 819.4561584454277,
"installment_number": 3,
"pre_fixed_amount": 11.179911547915339,
"principal_amortization_amount": 97.58008845208467,
"total_amount": 108.76,
"workdays": 20
},
{
"business_due_date": "2024-05-22",
"calendar_days": 30,
"due_date": "2024-05-22",
"due_principal": 721.876069993343,
"installment_number": 4,
"pre_fixed_amount": 9.5288330736045,
"principal_amortization_amount": 99.2311669263955,
"total_amount": 108.76,
"workdays": 21
},
{
"business_due_date": "2024-06-24",
"calendar_days": 33,
"due_date": "2024-06-24",
"due_principal": 622.6449030669476,
"installment_number": 5,
"pre_fixed_amount": 9.046812945831448,
"principal_amortization_amount": 99.71318705416856,
"total_amount": 108.76,
"workdays": 22
},
{
"business_due_date": "2024-07-22",
"calendar_days": 28,
"due_date": "2024-07-22",
"due_principal": 522.9317160127789,
"installment_number": 6,
"pre_fixed_amount": 6.439743824282488,
"principal_amortization_amount": 102.32025617571752,
"total_amount": 108.76,
"workdays": 20
},
{
"business_due_date": "2024-08-22",
"calendar_days": 31,
"due_date": "2024-08-22",
"due_principal": 420.61145983706143,
"installment_number": 7,
"pre_fixed_amount": 5.738438681013405,
"principal_amortization_amount": 103.0215613189866,
"total_amount": 108.76,
"workdays": 23
},
{
"business_due_date": "2024-09-23",
"calendar_days": 32,
"due_date": "2024-09-23",
"due_principal": 317.58989851807485,
"installment_number": 8,
"pre_fixed_amount": 4.473657660291388,
"principal_amortization_amount": 104.28634233970861,
"total_amount": 108.76,
"workdays": 22
},
{
"business_due_date": "2024-10-22",
"calendar_days": 29,
"due_date": "2024-10-22",
"due_principal": 213.30355617836625,
"installment_number": 9,
"pre_fixed_amount": 2.721176981322744,
"principal_amortization_amount": 106.03882301867725,
"total_amount": 108.76,
"workdays": 21
},
{
"business_due_date": "2024-11-22",
"calendar_days": 31,
"due_date": "2024-11-22",
"due_principal": 107.26473315968899,
"installment_number": 10,
"pre_fixed_amount": 1.4934220715493307,
"principal_amortization_amount": 107.26657792845067,
"total_amount": 108.76,
"workdays": 22
}
],
"issue_amount": 997.87,
"number_of_installments": 10,
"prefixed_interest_rate": {
"annual_rate": 0.17042118,
"daily_rate": 0.00043722,
"interest_base": "calendar_days",
"monthly_rate": 0.0132
},
"total_iof": 0.0
}
],
"final_disbursement_amount": 0.0
},
"proposal_key": "28a925f6-570e-4724-9132-3bd42f267c4f",
"proposal_number": "17032788499215403",
"proposal_status": "pending_submission",
"refinancing_credit_operation": {
"credit_operation_key": "aaf9abe0-2b8a-4688-8e09-413e1bd5285e",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [],
"disbursement_options": [
{
"annual_cet": 0.172031,
"cet": 0.0133,
"contract_fee_amount": -0.4,
"contract_fees": [
{
"amount": 0.5,
"amount_type": "percentage",
"fee_amount": -0.4,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 918.04,
"disbursement_date": "2023-12-22",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"installments": [
{
"business_due_date": "2024-02-22",
"calendar_days": 62,
"due_date": "2024-02-22",
"due_principal": 917.64,
"installment_number": 1,
"pre_fixed_amount": 25.2095730147,
"principal_amortization_amount": 74.7904269853,
"total_amount": 100.0,
"workdays": 40
},
{
"business_due_date": "2024-03-22",
"calendar_days": 29,
"due_date": "2024-03-22",
"due_principal": 842.8495730147,
"installment_number": 2,
"pre_fixed_amount": 10.7524369787,
"principal_amortization_amount": 89.2475630213,
"total_amount": 100.0,
"workdays": 21
},
{
"business_due_date": "2024-04-22",
"calendar_days": 31,
"due_date": "2024-04-22",
"due_principal": 753.6020099934,
"installment_number": 3,
"pre_fixed_amount": 10.2814172859,
"principal_amortization_amount": 89.7185827141,
"total_amount": 100.0,
"workdays": 20
},
{
"business_due_date": "2024-05-22",
"calendar_days": 30,
"due_date": "2024-05-22",
"due_principal": 663.8834272793,
"installment_number": 4,
"pre_fixed_amount": 8.7632941742,
"principal_amortization_amount": 91.2367058258,
"total_amount": 100.0,
"workdays": 21
},
{
"business_due_date": "2024-06-24",
"calendar_days": 31,
"due_date": "2024-06-22",
"due_principal": 572.6467214535,
"installment_number": 5,
"pre_fixed_amount": 7.8126464787,
"principal_amortization_amount": 92.1873535213,
"total_amount": 100.0,
"workdays": 21
},
{
"business_due_date": "2024-07-22",
"calendar_days": 30,
"due_date": "2024-07-22",
"due_principal": 480.4593679322,
"installment_number": 6,
"pre_fixed_amount": 6.3420966342,
"principal_amortization_amount": 93.6579033658,
"total_amount": 100.0,
"workdays": 21
},
{
"business_due_date": "2024-08-22",
"calendar_days": 31,
"due_date": "2024-08-22",
"due_principal": 386.8014645664,
"installment_number": 7,
"pre_fixed_amount": 5.2771618926,
"principal_amortization_amount": 94.7228381074,
"total_amount": 100.0,
"workdays": 23
},
{
"business_due_date": "2024-09-23",
"calendar_days": 31,
"due_date": "2024-09-22",
"due_principal": 292.078626459,
"installment_number": 8,
"pre_fixed_amount": 3.9848593609,
"principal_amortization_amount": 96.0151406391,
"total_amount": 100.0,
"workdays": 21
},
{
"business_due_date": "2024-10-22",
"calendar_days": 30,
"due_date": "2024-10-22",
"due_principal": 196.0634858199,
"installment_number": 9,
"pre_fixed_amount": 2.5880710578,
"principal_amortization_amount": 97.4119289422,
"total_amount": 100.0,
"workdays": 22
},
{
"business_due_date": "2024-11-22",
"calendar_days": 31,
"due_date": "2024-11-22",
"due_principal": 98.6515568777,
"installment_number": 10,
"pre_fixed_amount": 1.3459361963,
"principal_amortization_amount": 98.6540638037,
"total_amount": 100.0,
"workdays": 22
}
],
"issue_amount": 917.64,
"number_of_installments": 10,
"prefixed_interest_rate": {
"annual_rate": 0.17042118,
"daily_rate": 0.00043722,
"interest_base": "calendar_days",
"monthly_rate": 0.0132
},
"total_iof": 0.0
}
],
"final_disbursement_amount": -79.83
}
}
5.1.2. Simulação de Portabilidade com Refinanciamento, com valor liberado fixo: Assim como na digitação da proposta (3.1.2), é possível realizar a simulação fixando o valor liberado ao cliente:
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal_simulation
Payload:
payload.json
{
"borrower": {
"person_type": "natural"
},
"collaterals": [{
"collateral_type": "social_security"
}],
"portability_credit_operation": {
"financial": {
"installment_face_value": 100,
"number_of_installments": 10
}
},
"refinancing_credit_operation": {
"financial": {
"days_to_accrual": 0,
"disbursed_amount": 1000,
"installment_face_value": 100,
"number_of_installments": 10
}
},
"origin_contract": {
"last_due_balance": 997.87
}
}
Response
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal_simulation
Payload:
payload.json
{
"portability_credit_operation": {
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_options": [{
"installments": [{
"bank_slip_key": null,
"digitable_line": null,
"business_due_date": "2021-08-09",
"calendar_days": 53,
"due_date": "2021-08-08",
"due_principal": 997.87,
"installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
"installment_number": 1,
"pre_fixed_amount": 54.84865004983954,
"principal_amortization_amount": 306.98134995016045,
"total_amount": 361.83,
"workdays": 37
},
{
"bank_slip_key": null,
"digitable_line": null,
"business_due_date": "2021-09-08",
"calendar_days": 31,
"due_date": "2021-09-08",
"due_principal": 690.89,
"installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1",
"installment_number": 2,
"pre_fixed_amount": 21.964874249804833,
"principal_amortization_amount": 339.86512575019515,
"total_amount": 361.83,
"workdays": 22
}
],
"prefixed_interest_rate": {
"annual_rate": 0.44556431,
"daily_rate": 0.00564312,
"monthly_rate": 0.0556431,
"interest_base": "calendar_days_365"
},
"iof_amount": 0,
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"contract_fee_amount": 0,
"contract_fees": [],
"number_of_installments": 2,
"disbursed_issue_amount": 1000,
"issue_amount": 1000,
"disbursement_date": "2021-05-31",
"cet": 1.212,
"annual_cet": 32.122
}]
},
"refinancing_credit_operation": {
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_options": [{
"installments": [{
"bank_slip_key": null,
"digitable_line": null,
"business_due_date": "2021-08-09",
"calendar_days": 53,
"due_date": "2021-08-08",
"due_principal": 997.87,
"installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
"installment_number": 1,
"pre_fixed_amount": 54.84865004983954,
"principal_amortization_amount": 306.98134995016045,
"total_amount": 361.83,
"workdays": 37
},
{
"bank_slip_key": null,
"digitable_line": null,
"business_due_date": "2021-09-08",
"calendar_days": 31,
"due_date": "2021-09-08",
"due_principal": 690.89,
"installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1",
"installment_number": 2,
"pre_fixed_amount": 21.964874249804833,
"principal_amortization_amount": 339.86512575019515,
"total_amount": 361.83,
"workdays": 22
}
],
"prefixed_interest_rate": {
"annual_rate": 0.44556431,
"daily_rate": 0.00564312,
"monthly_rate": 0.0556431,
"interest_base": "calendar_days_365"
},
"iof_amount": 0,
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"contract_fee_amount": 0,
"contract_fees": [],
"number_of_installments": 2,
"disbursed_issue_amount": 1000,
"issue_amount": 1000,
"disbursement_date": "2021-05-31",
"cet": 1.212,
"annual_cet": 32.122
}]
}
}
5.2. Simulação de Portabilidade: Também é possível simular as condições financeiras de uma Proposta de Portabilidade (Portabilidade Pura), sem a necessidade de coletar os dados cadastrais do cliente.
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal_simulation
Payload:
payload.json
{
"borrower": {
"person_type": "natural"
},
"collaterals": [{
"collateral_type": "social_security"
}],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"installment_face_value": 100,
"number_of_installments": 10
}
},
"origin_contract": {
"last_due_balance": 997.87
}
}
Response
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal_simulation
Payload:
payload.json
{
"portability_credit_operation": {
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_options": [{
"installments": [{
"bank_slip_key": null,
"digitable_line": null,
"business_due_date": "2021-08-09",
"calendar_days": 53,
"due_date": "2021-08-08",
"due_principal": 997.87,
"installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
"installment_number": 1,
"pre_fixed_amount": 54.84865004983954,
"principal_amortization_amount": 306.98134995016045,
"total_amount": 361.83,
"workdays": 37
},
{
"bank_slip_key": null,
"digitable_line": null,
"business_due_date": "2021-09-08",
"calendar_days": 31,
"due_date": "2021-09-08",
"due_principal": 690.89,
"installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1",
"installment_number": 2,
"pre_fixed_amount": 21.964874249804833,
"principal_amortization_amount": 339.86512575019515,
"total_amount": 361.83,
"workdays": 22
}
],
"prefixed_interest_rate": {
"annual_rate": 0.44556431,
"daily_rate": 0.00564312,
"monthly_rate": 0.0556431,
"interest_base": "calendar_days_365"
},
"iof_amount": 0,
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"contract_fee_amount": 0,
"contract_fees": [],
"number_of_installments": 2,
"disbursed_issue_amount": 1000,
"issue_amount": 1000,
"disbursement_date": "2021-05-31",
"cet": 1.212,
"annual_cet": 32.122
}]
}
}
6 - Formalização da Proposta:
Para formalização das operações de Portabilidade e/ou Refinanciamento (Troco), deve-se enviar as evidências de assinatura dos contratos gerados na digitação da Proposta.
No payload de assinatura devem conter os campos obrigatórios relacionados aos documentos enviados no item 4. Os campos obrigatórios são os seguintes: ip_address e signature_datetime.
6.1. Para assinatura da Operação de Portabilidade o Parceiro deve realizar a seguinte chamada:
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal/PROPOSAL-KEY/portability_credit_operation/signature
Payload:
payload.json
{
"type": "pdf-signature",
"biometry_analysis_reference": "SERPRO",
"signature_datetime": "2023-12-22T15:01:32.482Z",
"signed_pdf_path": "https://termos-originacao.s3.amazonaws.com/5cd2a7f9",
"ip_address": "179.145.48.219",
"similarity_score": "0.9750000000000001"
}
Enumeradores Biometry Analysis Reference
| Enumerador | Descrição |
|---|---|
| serpro | Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do Detran (Serviço prestado através da Serpro) |
| tse | Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do TSE |
| not_found | Deve ser informado quando a biometria facial não for localizada em nenhuma das bases governamentais anteriores (serpro ou tse). Neste caso o similarity_score deve ser null ou o grau de similaridade da selfie com o documento oficial com foto, retornado pelo parceiro. |
A conclusão da assinatura será notificada de forma assíncrona:
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
Body:
body.json
{
"webhook_type": "credit_transfer.proposal.credit_operation",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_type": "portability",
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"document_key": "\<GUID DO DOCUMENTO NA QI\>",
"signed_document_url": "\<LINK DO URL DO PDF ASSINADO\>",
"credit_operation_status": "signed"
}
}
6.2. Para assinatura da Operação de Refinanciamento (Troco) o Parceiro deve realizar a seguinte chamada:
Request
- MÉTODOPOST
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY/refinancing_credit_operation/signature
Payload:
payload.json
{
"type": "pdf-signature",
"signed_pdf_path": "\<LINK PUBLICO DO PDF ASSINADO\>",
"ip_address": "192.168.0.0",
"signature_datetime": "2020-03-20T14:28:23.382748Z",
"similarity_score": 0.98000,
"biometry_analysis_reference": "serpro"
}
A conclusão da assinatura será notificada de forma assíncrona:
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
Body:
body.json
{
"webhook_type": "credit_transfer.proposal.credit_operation",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_type": "refinancing",
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"document_key": "\<GUID DO DOCUMENTO NA QI\>",
"signed_document_url": "\<LINK DO URL DO PDF ASSINADO\>",
"credit_operation_status": "signed"
}
}
7 - Máquina de Status da Proposta de Portabilidade:
Os estados da Proposta de Portabilidade refletem as etapas envolvidas no processo de portabilidade de crédito dentro do CTC (Central de Transferência de Crédito) da CIP. Segue abaixo a descrição do fluxo e do significado de cada status envolvido em uma Proposta de Portabilidade, desde sua digitação até sua liquidação.
7.1. pending_response: Status da proposta após realização da digitação. Neste status a proposta foi recebida com sucesso pela QI e enviada para o CTC - CIP.
6.1.1 rejected: Caso a digitação da proposta seja rejeitada pelo CTC - CIP, será enviado um webhook com o motivo da rejeição:
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSrejected
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "rejected",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"error": {
"code": "ECTC0023",
"reason": "Contrato com portabilidade em andamento"
}
}
}
7.1.1 rejected reasons: Caso a digitação da proposta seja rejeitada pelo CTC - CIP, será enviado um webhook com o motivo da rejeição:
| reason | description | external_code |
|---|---|---|
| portability_in_progress | Contrato com portabilidade em andamento | ECTC0023 |
| portability_finished | Portabilidade já finalizada para o contrato informado | ECTC0028 |
| portability_in_expiration_progress | Portabilidade não permitida. Contrato com portabilidade em situação de "Decurso de prazo" por não efetivação da portabilidade | ECTC0085 |
| unexpected_error | Erro inesperado | ECTC9999 |
| portability_payment_rejected | Pagamento de portabilidade rejeitado. | |
| divergent_due_balance | Saldo devedor final deve ser menor que saldo devedor devolvido pela cip. |
7.2. pending_acceptance: Status da Proposta após envio/aceite pelo CTC - CIP. A Proposta, neste momento, está aguardando resposta de saldo devedor pelo banco credor original. Neste momento é enviado um webhook com o número da Portabilidade no CTC - CIP:
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSpending_acceptance
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "pending_acceptance",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"portability_number": "202211230000246536429",
"inclusion_date": "2022-11-24",
"due_balance_expected_return_date": "2022-12-01"
}
}
O “portability_number“ é o Número da Portabilidade dentro do CTC - CIP, e é o número utilizado pela instituição proponente e instituição credora original para localizar a Proposta de Portabilidade.
Assim que o banco credor original responder à solicitação de portabilidade, será enviado um webhook com a resposta do valor do saldo devedor no caso da não retenção, e com a informação de “retido”, no caso da retenção:
7.2.1. accepted: Status da Proposta quando o banco credor original retorna o saldo devedor e não retem o crédito. Será enviado um webhook com a informação do saldo devedor. O banco credor original tem até 5 d.u. após a recepção da Proposta de Portabilidade, para envio da resposta com a informação do saldo devedor da operação.
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSaccepted
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "accepted",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"final_due_balance": 1000,
"portability_number": "202211230000246536429",
"original_contract": {
"origin_contract_number": "5584745",
"origin_ispb_number": "60746948",
"origin_document_number": "90406718261",
"origin_operation_type": "0202",
"installment_face_value": 1000,
"total_iof": 1,
"first_due_date": "2021-05-31",
"last_due_date": "2022-05-31",
"interest": 1,
"cet": 1,
"installment_number": 12,
"amortization": 1,
"final_due_balance": 1000,
"final_due_date": "2021-08-31",
"contract_date": "2021-04-31"
}
}
}
Com a informação do saldo devedor retornado pela instituição credora original, o parceiro tomará a decisão se seguir ou não com a Portabilidade.
Horário limite para envio do saldo devedor pela instituição credora original é às 10:00.
Após o recebimento do saldo devedor, caso o Parceiro decida seguir com a Proposta Portabilidade, ele deve realizar a seguinte chamada:
Request
- MÉTODOPATCH
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY
Payload:
payload.json
{
"status":"accepted_by_requester"
}
O Parceiro pode adicionar dados de novo valor de parcela ou nova taxa nessa chamada, caso queira alterá-los:
Request
- MÉTODOPATCH
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY
Payload:
payload.json
{
"status":"accepted_by_requester",
"financial": {
"installment_face_value": 100
}
}
Request
- MÉTODOPATCH
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY
Payload:
payload.json
{
"status":"accepted_by_requester",
"financial": {
"monthly_interest_rate": 0.01
}
}
Caso o valor da parcela seja maior que valor total disponível (valor da parcela do contrato de origem + margem total disponível do benefício), será retornado o seguinte erro:
{
"title": "Reservation amount greater than available total balance",
"description": "The installment face value: 54.4 is greater than the available total balance (origin installment face value + available total balance):30.4. Available total balance: -20.0.",
"translation": "O valor da parcela: 54.4 é maior que o valor total disponível (valor da parcela do contrato de origem + margem total disponível) : 30.4. Margem total diponível: -20.0.",
"code": "SSC000059"
}
Ao receber esta crítica, é possível que uma nova chamada seja feita, alterando o valor da parcela para que ela se ajuste ao valor total disponível.
Se o ajuste no valor da parcela não for feito até o horário limite para aceite do saldo devedor, será necessária uma nova digitação de proposta.
Caso o Parceiro decida por não prosseguir com a Proposta de Portabilidade, ele deve, obrigatoriamente realizar a seguinte chamada para informar a desistência da Portabilidade:
Request
- MÉTODODELETE
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY
Após o envio do cancelamento da Proposta de Portabilidade ao CTC - CIP, será enviado um webhook de Proposta Cancelada:
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUScanceled
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_status": "canceled",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12"
}
O horário limite para aceite do saldo devedor é 16:30. Não é possível retomar uma Proposta com status “canceled”. Caso a Proposta esteja com este status, será necessária a realização de uma nova digitação.
7.2.2. retained: Status da Proposta quando o banco credor original retem o crédito, será enviado o webhook com a informação de retenção. O banco credor original do crédito tem até 2 d.u. após a recepção da Proposta de Portabilidade, para envio da resposta de retenção do crédito.
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSretained
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "retained",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"retained_reason": {
"reason": "issuer_retention",
"description": "Retenção do Cliente"
}
}
}
Detalhamento de campos no webhook de proposal
| Campo | Descrição | Valores |
|---|---|---|
| reason | lista dos motivos de retenção de uma Proposta | Enumeradores |
7.3. accepted_by_requester: Após aprovada pelo parceiro, a Proposta segue o fluxo interno da QI para liquidação.
7.4. settlement_sent: Após conclusão do fluxo interno da QI para liquidação da Proposta de Portabilidade o recurso para pagamento do saldo devedor é enviado ao credor original disparando o seguinte webhook para o Parceiro:
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSsettlement_sent
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL KEY\>",
"proposal_status": "settlement_sent",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"receipt": {
"amount": 1000,
"timestamp": "2022-09-14 11:55:31",
"description": "237 0001 1000093 1000093-3 59588111000103 - BCO BRADESCO S.A.",
"ted_receipt_document_key": "a34e84a2-1628-4f23-8c11-2b2f4656ced1",
"ted_receipt_url": "https://qitech.com.br/",
"transaction_key": "ed3e84a2-1628-4f23-8c11-2b2f4656cedf",
"origin": {
"account_key": "ed3e84a2-1628-4f23-8c11-2b2f4656cedf",
"bank_code": "329",
"branch": "0001",
"branch_digit": null,
"account_number": "1000361",
"account_digit": "3",
"type": "checking_account",
"name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
"document": "32402502000135"
},
"destination": {
"bank_code": "237",
"branch": "0001",
"branch_digit": null,
"account_number": "1000093",
"account_digit": "3",
"type": "checking_account",
"name": "BCO BRADESCO S.A.",
"document": "59588111000103",
"purpose": "Saída Liquidação de Portabilidade"
}
}
}
}
Neste momento será iniciada averbação da Operação de Portabilidade na Dataprev. O processo de averbação acontecerá em paralelo aos itens seguintes (itens 7.5., 7.5.1. e 7.5.2.)
7.5. pending_settlement_confirmation: Após a confirmação do envio dos recursos para pagamento do saldo devedor, é aguardada a confirmação da quitação do contrato por parte da Instituição Credora Original. Nesta etapa o Parceiro receberá o seguinte webhook:
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSpending_settlement_confirmation
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "pending_settlement_confirmation",
"event_datetime": "2022-11-24T15:42:12"
}
A confirmação da quitação do contrato é encaminhada pela Instituição Credora Original ao CTC - CIP e posteriormente encaminhado pelo CTC - CIP à QI.
O SLA para confirmação da quitação da Portabilidade é de 2 d.u. contados a partir do envio dos recursos para pagamento do saldo devedor do contrato original.
7.5.1. paid: Assim que a QI receber do CTC - CIP a confirmação da quitação do Contrato Original, a Proposta constará como paga e a Portabilidade estará finalizada.
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSpaid
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "paid",
"event_datetime": "2022-11-24T15:42:12"
}
Nesta etapa, caso a averbação da Operação de Portabilidade já esteja concluída, a Operação de Refinanciamento (Troco), poderá ser iniciada (fluxo descrito no item 7).
7.5.1.1. A notificação sobre a averbação da Operação de Portabilidade será enviada através do seguinte webhook:
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.collateral
Body:
body.json
{
"webhook_type": "credit_transfer.proposal.collateral",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_type": "portability",
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"collateral_type": "social_security",
"collateral_constituted": true,
"collateral_data": {
"reservation_method": "portability",
}
}
}
data.collateral_data.reservation_method: [portability, new_credit ]
7.5.2. rejected: Caso o banco credor original rejeite a quitação do contrato, o recurso enviado para quitação do saldo devedor do contrato original será devolvido, e a proposta será finalizada. O parceiro receberá o webhook de “rejected”.
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSrejected
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "rejected",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"error": {
"code": "QCTC0001",
"reason": "Pagamento de portabilidade rejeitado."
}
}
}
Caso nesta etapa a Operação de Portabilidada já esteja averbada na Dataprev, será realizada a desaverbação da margem.
Não é possível retomar uma Proposta com status “rejected”. É sempre necessário realizar uma nova digitação.
8 - Máquina de Status da Operação de Refinanciamento (Troco):
8.1 No momento em que a Operação de Portabilidade é paga, o Parceiro pode optar por seguir com a Operação de Refinanciamento (Troco) ou não.
Enumeradores credit_operation_status
| Enumerador | Descrição |
|---|---|
| waiting_signature | Operação aguardando assinatura |
| signed | Operação assinada |
| issued | Operação emitida |
| disbursed | Operação desembolsada |
| settled | Operação liquidada |
| canceled | Operação cancelada |
| canceled_permanently | Operação cancelada permanentemente |
8.1.1. Para prosseguir com o Refinanciamento (Troco), o Parceiro deve realizar a seguinte chamada:
Request
- MÉTODOPOST
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY/refinancing_credit_operation/acceptance
Financial body
{
"financial": {
"installment_face_value": 379.87,
"monthly_interest_rate": 0.0166,
"number_of_installments": 84,
"limit_days_to_disburse": 7,
"disbursement_date": "2024-07-02",
"rebates": [
{
"rebate_bank_account": {
"bank_code": "329",
"account_digit": "9",
"document_number": "18533555000164",
"name": "Teste Ltda",
"account_number": "4290002",
"branch_number": "0001"
},
"amount_type": "percentage",
"fee_type": "spread",
"amount": 9.5
},
{
"amount": 20,
"rebate_bank_account": {
"name": "Teste Ltda",
"document_number": "18533555000164",
"account_digit": "0",
"account_number": "4290001",
"branch_number": "0001",
"bank_code": "329"
},
"amount_type": "percentage",
"fee_type": "insurance_premium"
}
]
}
}
Disbursement bank accounts body
{
"disbursement_bank_accounts": [
{
"document_number": "92093764000197",
"branch_number": "0001",
"name": "TESTE LTDA",
"percentage_receivable": 100,
"account_number": "120012",
"account_digit": "3",
"bank_code": "329"
}
]
}
Response:
response.json
{
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"contract_number": "00000002",
"document_key": "\<DOCUMENT-KEY da CCB de Refinanciamento\>",
"document_url": "\<URL da CCB de Refinanciamento\>",
"credit_operation_status": "issued",
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_options": [{
"installments": [{
"additional_costs": [],
"bank_slip_key": null,
"business_due_date": "2021-08-09",
"calendar_days": 53,
"digitable_line": null,
"due_date": "2021-08-08",
"due_interest": 0,
"due_principal": 997.87,
"fine_amount": null,
"has_interest": true,
"installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
"installment_number": 1,
"installment_status": "created",
"installment_type": "principal",
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 54.84865004983954,
"principal_amortization_amount": 306.98134995016045,
"total_amount": 361.83,
"workdays": 37
},
{
"additional_costs": [],
"bank_slip_key": null,
"business_due_date": "2021-09-08",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2021-09-08",
"due_interest": 0,
"due_principal": 690.8886500498395,
"fine_amount": null,
"has_interest": true,
"installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1",
"installment_number": 2,
"installment_status": "created",
"installment_type": "principal",
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 21.964874249804833,
"principal_amortization_amount": 339.86512575019515,
"tax_amount": 0,
"total_amount": 361.83,
"workdays": 22
}
],
"prefixed_interest_rate": {
"annual_rate": 0.44556431,
"daily_rate": 0.00564312,
"monthly_rate": 0.0556431,
"interest_base": "calendar_days_365"
},
"iof_amount": 50,
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"contract_fee_amount": 0,
"contract_fees": [],
"number_of_installments": 2,
"disbursed_issue_amount": 997.87,
"final_disbursement_amount": 100,
"issue_amount": 1147.87,
"disbursement_date": "2021-05-31",
"cet": 1.212,
"annual_cet": 32.122
}],
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "00001",
"ispb": "00000000",
"branch_number": "0001"
}
}
8.1.2. Caso o Parceiro opte por não prosseguir com a Operação de Refinanciamento (Troco), ele deve realizar a seguinte chamada:
Request
- MÉTODODELETE
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY/refinancing_credit_operation
8.2. Averbação do Refinanciamento (Troco): Assim que o Parceiro optar por prosseguir com a Operação de Refinanciamento, a rotina para averbação da margem consignável terá início. Assim que a averbação da margem consignável do INSS for concluída o parceiro recebera o seguinte webhook:
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.collateral
Body:
body.json
{
"webhook_type": "credit_transfer.proposal.collateral",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_type": "refinancing",
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"collateral_type": "social_security",
"collateral_constituted": true
}
}
8.3. Desembolo do Refinanciamento (Troco):
Assim que a averbação da margem consignável do INSS for concluída a operação estará pronta para desembolso. No desembolso da Operação de Refinanciamento, a Operação de Portabilidade será quitada e caso exista valor desembolsado remanescente (7.1.1. “disbursement_options.final_disbursement_amount”), este valor será liberado para o cliente (Troco) na conta para desembolso da Operação (“disbursement_bank_account“). A liberação do troco para o cliente pode ser realizada via PIX ou TED, em qualquer horário do dia (obedecendo horário comercial de 7:00 às 17:00 em dias úteis, no caso da TED).
8.3.1. Caso o desembolso do troco para o cliente seja bem sucedido, será enviado um webhook com os dados da comprovação do desembolso:
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
Body:
body.json
{
"webhook_type": "credit_transfer.proposal.credit_operation",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_status": "disbursed",
"credit_operation_type": "refinancing",
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"ted_receipt_list": [{
"fee": 0,
"url": "https://qitech.com.br/",
"amount": 500,
"origin": {
"name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
"type": "payment_account",
"branch": "0001",
"document": "32402502000135",
"bank_code": "329",
"account_key": "871059bd-4014-41ad-82b4-28275ff0e67b",
"branch_digit": null,
"account_digit": "5",
"account_branch": "0001",
"account_number": "00002"
},
"timestamp": "2022-09-28T13:00:47",
"description": "DESCRIPTION",
"destination": {
"name": "Elaine Isadora da Cruz",
"type": "checking_account",
"bank_code": "033",
"branch": "0001",
"purpose": "Crédito PIX em Conta",
"document_number": "90406718261",
"bank_ispb": "90400888",
"branch_digit": null,
"account_digit": "1",
"account_number": "00001"
},
"end_to_end_id": null,
"transaction_key": "871059bd-4014-41ad-82b4-28275ff0e67b",
"origin_transaction_key": null
}]
}
}
8.3.2. Caso ocorra falha no desembolso, o parceiro receberá o seguinte webhook:
7.3.2.1. Falha no desembolso via PIX:
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
Body:
body.json
{
"webhook_type": "credit_transfer.proposal.credit_operation",
"proposal_key": "60fbbfe2-eb52-4825-9ed5-f169a58b9999",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_status": "canceled",
"credit_operation_type": "refinancing",
"credit_operation_key": "1a1a44df-29b6-431c-89af-53657d906333",
"pix_refusal": {
"reason_enumerator": "invalid_document_number",
"reason": "CPF/CNPJ do usuário recebedor não é compatível com o titular da conta de destino."
},
"cancel_reason": "pix_refusal"
}
}
7.3.2.2. Falha no desembolso via TED:
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
Body:
body.json
{
"webhook": {
"data": {
"cancel_reason": "Agência ou Conta Destinatária do Crédito Inválida",
"credit_operation_key": "1a1a44df-29b6-431c-89af-53657d906333",
"credit_operation_type": "refinancing",
"credit_operation_status": "canceled",
"cancel_reason_enumerator": "agencia_conta_invalida"
},
"proposal_key": "60fbbfe2-eb52-4825-9ed5-f169a58b9999",
"webhook_type": "credit_transfer.proposal.credit_operation",
"event_datetime": "2023-12-22T10:15:25"
}
}
8.3.3. No caso de falha no desembolso da Operação, o desembolso pode ser retentato alterando-se os dados bancários:
Request
- MÉTODOPATCH
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY/refinancing_credit_operation
Payload:
payload.json
{
"disbursement_date": "2022-11-04",
"disbursement_bank_account": {
"account_branch": "1232",
"account_digit": "4",
"account_number": "412412412",
"account_type": "checking_account",
"document_number": "\<CPF BENEFICIÁRIO\>",
"ispb": "17298092",
"name": "\<NOME BENEFICIÁRIO\>"
}
}
9 - Consulta de Lista de Parcticipantes do CTC - CIP:
Request
- MÉTODOGET
- ENDPOINT/v2/credit_transfer/participants
Response:
response.json
[
{
"name": "\<NOME DO BANCO\>",
"bank_code": "\<CÓDIGO DO BANCO\>",
"ispb": "\<BASE DO CNPJ DO BANCO\>"
}
]
10 - Recuperar resposta da última request
O last response é uma forma de mapear, de forma simples e objetiva, a resposta da comunicação entre a QI e a Dataprev, possibilitando saber quando essa requisição foi feita e qual o retorno obtido (através de um enumerador). Os enumeradores estão diretamente relacionados aos códigos de retorno da Dataprev e são divididos em duas formas: "errors" e "success".
Cada enumerador tem uma descrição detalhada e o código de referência da Dataprev. Podemos conferir abaixo, com mais detalhes, como serão apresentados os dados do last response.
Casos de sucesso
Request - Credit Transfer
PATH PARAMETERS credit-operation-type
| Enumerador | Descrição |
|---|---|
| refinancing_credit_operation | Operação de refinanciamento |
| portability_credit_operation | Operação de portabilidade |
Response
Response Body
{
"collateral_data":{
"benefit_number":1976703155,
"state":"PI",
"last_response":{
"success":[
{
"enumerator":"succesfully_included",
"reservation_method":"portability"
}
]
},
"last_response_event_datetime":"2023-05-22T19:13:02Z",
"status":"reserved"
},
"collateral_constituted":true,
"collateral_type":"social_security"
}
Detalhamento de campos no retorno da request
| Campo | Descrição | Valores |
|---|---|---|
| enumerator | Retorno mapeado do código Dataprev | Enumeradores |
| reservation_method | Método de averbação da reserva | portability, new_credit, refinancing |
Casos de erro
Request
Response
Response Body
{
"collateral_constituted": false,
"collateral_type": "type",
"updated_at": "2023-05-24 19:13:02",
"collateral_data": {
"state": "SP",
"benefit_number": 1976703155,
"status": "pending_reservation",
"last_response": {
"errors": [
{
"enumerator": "benefit_blocked_by_tbm",
"reservation_method" : "portability"
},
{
"enumerator": "benefit_blocked_by_tbm",
"reservation_method" : "new_credit"
}
]
},
"last_response_event_datetime": "2023-05-22T19:13:02Z"
}
}
Detalhamento de campos no webhook de falha
| Campo | Descrição | Valores |
|---|---|---|
| enumerator | Retorno mapeado do código Dataprev | Enumeradores |
| reservation_method | Método de averbação da reserva | portability, new_credit, refinancing |
11 - Webhook de resposta da última tentativa de averbação
Caso a operação não tenha sucesso na averbação, a mesma ficará em retentativa e será enviado o seguinte webhook, detalhando o motivo da não averbação, o horário desta tentativa e o método de averbação utilizado:
- Webhook portabilidade
- Webhook refinanciamento
{
"webhook_type": "credit_transfer.proposal.collateral",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_type": "portability",
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"collateral_type": "social_security",
"collateral_constituted": false,
"collateral_data": {
"status": "pending_reservation",
"last_response": {
"errors": [{
"enumerator": "consignable_margin_excceded"
}]
},
"last_response_event_datetime": "2023-05-22T19:13:02Z",
"reservation_method": "new_credit",
}
}
}
{
"webhook_type": "credit_operation.collateral",
"key": "\<CREDIT-OPERATION-KEY\>",
"event_time": "2022-11-24T15:42:12",
"data": {
"collateral_type": "social_security",
"collateral_constituted": false,
"collateral_data": {
"status": "pending_reservation",
"last_response": {
"errors": [{
"enumerator": "consignable_margin_excceded"
}]
},
"last_response_event_datetime": "2023-05-22T19:13:02Z",
"reservation_method": "refinancing",
}
}
}
Detalhamento de campos no webhook de falha
| Campo | Descrição | Valores |
|---|---|---|
| enumerator | Retorno mapeado do código Dataprev | Enumeradores |
| reservation_method | Método de averbação da reserva | portability, new_credit, refinancing |
12 - Consulta de portabilidade de origem
É possível consultar os dados da portabilidade do banco de origem como, por exemplo, o número do benefício, a data de início da portabilidade, o número dos contratos excluídos, os valores das parcelas desaverbadas, ultima parcela paga, data de exclusão, entre outros.
Request
- MÉTODOPOST
- ENDPOINT/social_security/reservation/external_key/CREDIT-OPERATION-KEY/portability_origin_contract
Payload:
payload.json
{
"request_type":"portability_number",
"portability_number": "202402070000298096242"
}
Response
- MÉTODOPOST
- ENDPOINT/social_security/reservation/external_key/CREDIT-OPERATION-KEY/portability_origin_contract
Body:
body.json
{
"origin_contract_request_key": "9bb68c89-4b88-400d-9359-99ad8d42a69e",
"status": "pending_search",
"status_events": [
{
"status": "pending_search"
}
]
}
Em caso de sucesso na consulta do número de benefício
Webhook
- WEBHOOK_TYPEsocial_security_portability_origin_contract_request
- STATUSSuccess
Body:
body.json
{
"webhook": {
"key": "25e93655-4713-488b-8800-7ac4fddf745f",
"data": {
"portability_number": 9223372036854776000,
"portability_status": "open",
"benefit_number": 1544326820,
"portability_start_date": "2024-02-22",
"deleted_contracts": [
{
"origin_bank": {
"bank_code": 752,
"name": "CETELEM-BNP"
},
"contract_number": "22-844817807/20",
"last_installment_paid": 84,
"exclusion_date": "22022024",
"period_amount": 165.73
}
]
},
"status": "success",
"webhook_type": "social_security_portability_origin_contract_request",
"event_datetime": "2024-02-26T21:36:22"
}
}
Em caso de falha na consulta do número de benefício
Webhook
- WEBHOOK_TYPEsocial_security_portability_origin_contract_request
- STATUSFailure
Body:
body.json
{
"webhook": {
"key": "522b5d7d-2dfc-4e92-99b7-d4df3d97edb2",
"data": {
"enumerator": "invalid_bank_code",
"description": "Invalid bank code"
},
"status": "failure",
"webhook_type": "social_security_portability_origin_contract_request",
"event_datetime": "2024-02-26T21:36:22"
}
}
13. Diminuir o valor das parcelas
Este endpoint permite a redução do valor das parcelas de um contrato de portabilidade de crédito. Esta funcionalidade é especialmente útil em casos onde a margem consignável é excedida devido ao banco de origem desaverbar uma quantia menor do que a esperada.
Request
- MÉTODOPUT
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY/portability_credit_operation
Payload:
payload.json
{
"installment_face_value": 382.18
}
Response sucesso - HTTP 200
Body:
body.json
{
"credit_operation_key": "7aa77bca-c724-4c1a-bfae-9b1b7bd81ab2",
"contract_number": "0000000007/WO",
"document_key": "045a8f35-6170-4112-8d83-29a753d0c78e",
"document_url": "http://teste.com",
"signed_url": "signed_url_test",
"credit_operation_status": "waiting_signature",
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_accounts": [
{
"account_digit": "3",
"account_branch": "0001",
"account_number": "94134",
"ispb": "32402502",
"name": "Wilker Teste",
"document_number": "37197645832"
}
],
"disbursement_options": [
{
"prefixed_interest_rate": {
"annual_rate": 3.0,
"daily_rate": 0.00385824,
"interest_base": "calendar_days",
"monthly_rate": 0.12246205
},
"total_iof": 7.03,
"external_contract_fee_amount": 0.0,
"external_contract_fees": [],
"contract_fee_amount": 0.0,
"number_of_installments": 3,
"contract_fees": [],
"disbursed_issue_amount": 1000.0,
"issue_amount": 1007.03,
"disbursement_date": "2022-08-24",
"cet": 12.6,
"annual_cet": 315.3944,
"installments": [
{
"business_due_date": "2022-08-30",
"calendar_days": 5,
"due_date": "2022-08-29",
"due_principal": 1007.03,
"installment_number": 1,
"pre_fixed_amount": 84.43554587915118,
"principal_amortization_amount": 297.73445412084885,
"total_amount": 382.17,
"workdays": 3
},
{
"business_due_date": "2022-09-30",
"calendar_days": 31,
"due_date": "2022-09-29",
"due_principal": 709.2955458791512,
"installment_number": 2,
"pre_fixed_amount": 47.97894031795043,
"principal_amortization_amount": 334.19105968204957,
"total_amount": 382.17,
"workdays": 22
},
{
"business_due_date": "2022-11-01",
"calendar_days": 32,
"due_date": "2022-10-31",
"due_principal": 375.1044861971016,
"installment_number": 3,
"pre_fixed_amount": 7.055513802898396,
"principal_amortization_amount": 375.1044861971016,
"total_amount": 382.16,
"workdays": 21
}
],
"final_disbursement_amount": 997.87
}
],
"final_disbursement_amount": 997.87,
"collateral_is_constituted": false
}
14. Mapeamento de enumeradores
Enumeradores Retention Reason
| Enumerador | Descrição |
|---|---|
| issuer_retention | Retenção do Cliente |
| different_from_original | Condições da proposta divergentes do contrato original |
| issuer_lawsuit | Cliente com ação judicial |
| insurance_in_progress | Indenização de seguro em andamento |
| collateral_in_execution | Garantia em Execução |
| contract_not_found | Contrato não encontrado |
| invalid_contract_type | Tipo de contrato inválido |
| portability_in_progress | Portabilidade em andamento |
| assigned_contract | Contrato cedido |
| issuer_document_number_invalid | CPF não é do contrato |
| unrelated_issuer_document_number | CPF informado não é o do titular |
| different_from_original | Condições da proposta divergentes do contrato original |
| issuer_lawsuit | Cliente com ação judicial |
| assigned_without_co_obligation | Contrato cedido sem coobrigação |
| insurance_in_progress | Indenização de seguro em andamento |
| collateral_in_execution | Garantia em Execução |
| fgts_in_use | FGTS AMORTIZAR em uso |
| fgts_funding | FGTS funding |
| portability_not_requested | O cliente não solicitou a portabilidade |
| wrong_original_financial_institution | IF Credora Original Incorreta |
Tabela de retorno de erros Dataprev - averbação
| Código Dataprev | Enumerador | Descrição | Ação Qi |
|---|---|---|---|
| HW | consignable_margin_excceded | Exceeded consignable margin | Teimosinha |
| IT | benefit_blocked_by_tbm | Benefit blocked due to benefit transfer | Teimosinha |
| IE | benefit_blocked_by_beneficiary | Benefit blocked by beneficiary | Teimosinha |
| AN | invalid_disbursement_account | Invalid disbursement bank account | Teimosinha |
| HX | reservation_already_included | Reservation already included | Confirmar averbação |
| IF | benefit_blocked_by_granting_process | Benefit blocked during granting process | Teimosinha |
| AV | processing_payroll | Operation couldn`t be done during processing payroll period | Teimosinha |
| OF | invalid_cbc | Invalid cbc | Teimosinha |
| IA | first_name_mismatch | First name mismatch benefit owner or legal representative | Teimosinha |
| OS | legal_representative_document_number_mismatch | Document number mismatch legal representative | Teimosinha |
| AY | invalid_state | Invalid state | Teimosinha |
| HZ | operation_not_allowed_on_this_reservation_status | Operation couldn`t be done with current reservation status | Teimosinha |
| AP | invalid_contract_date | Accrual, end or start contract date is invalid | Teimosinha |
| GA | required_fields_missing | Required fields are missing | Teimosinha |
| BC | cbc_missing | CBC is missing | Teimosinha |
| NC | contract_number_missing | Contract number is missing | Teimosinha |
| NB | benefit_number_missing | Benefit number is missing | Teimosinha |
| CA | invalid_bank_code | Invalid bank code | Teimosinha |
| HR | exceeded_number_of_allowed_contracts | Amount of contracts is above the limit | Teimosinha |
| PV | invalid_image_format | Image with wrong format | Teimosinha |
| IR | operation_not_allowed_IR | Operation date is greater than benefit expiration | Teimosinha |
| PK | wrong_bank_code_destination | Portability number was found with wrong bank code destination | Teimosinha |
| PH | wrong_benefit_number_on_portability | Portability number was found with wrong benefit number | Teimosinha |
| PI | invalid_contract_total_amount | Reservation contract total amount should be greater than Dataprev reference amount | Teimosinha |
Todas as taxas e valores do contrato são validados no momento da criação da reserva.
A crítica "invalid_contract_total_amount" ocorre nos casos em que os contratos se estendem por muito tempo sem serem averbados, o que impacta os valores previamente estabelecidos.
Tabela de retorno de sucesso - averbação
| Código Dataprev | Enumerador | Descrição |
|---|---|---|
| BD | successfully_included | Inclusion has been successfully done |
| BF | successfully_removed | Removal has been successfully done |
| BR | successfully_reactivated | Reactivation has been successfully done |
| BS | successfully_suspended | Suspension has been successfully done |
Tabela de retorno de erros na consulta de saldo
| Código | Enumerador | Descrição |
|---|---|---|
| CR | not_found_legal_representative | no legal representative for the beneficiary |
| CD | inexistent_beneficiary | no beneficiary found |
| AS | benefity_without_legal_representative | beneficiary does not have a legal representative |
| BI | inexistent_benefit | no benefit found |
| D1 | inconsistent_balance_benefit_data | The balance benefit data registered is either inconsistent, null or incomplete. |
Tabela de retorno de erros na consulta de benefícios
| Código | Enumerador | Descrição |
|---|---|---|
| CR | not_found_legal_representative | no legal representative for the beneficiary |
| CD | inexistent_beneficiary | no beneficiary found |
| AS | benefity_without_legal_representative | beneficiary does not have a legal representative |
Tabela de situação de benefícios
| Items |
|---|
| active |
| excluded |
| terminated |
| suspended |
| suspended_by_CONPAG |
| terminated_by_SISOBI |
| receiving_monthly_recover_6_months |
| receiving_monthly_recover_18_months |
| suspended_by_name_error |
| suspended_by_credentialed_payer |
| suspended_by_inspection |
| suspended_by_audit |
| terminated_by_inspection |
| terminated_by_audit |
| receiving_monthly_recover_6_months_inspection |
| receiving_monthly_recover_18_months_inspection |
| suspended_by_SISOBI |
| canceled_by_audit |
Tabela de status de benefícios
| Enumerador | Descrição |
|---|---|
| Elegible | Elegível para empréstimo |
| Inelegible | Benefício inelegível para empréstimo |
| Blocked | Benefício elegível, porém bloqueado para empréstimo |
Tabela de tipos de bloqueio
| Enumerador | Descrição |
|---|---|
| 0 | Sem bloqueio |
| 1 | Bloqueado pelo Segurado |
| 2 | Bloqueado por TBM |
| 3 | Bloqueado na Concessão |
Tabela de tipos de politicamente exposto
| Enumerador | Descrição |
|---|---|
| 0 | Pessoa Não Exposta Politicamente |
| 1 | Pessoa Exposta Politicamente - Nível 1 |
Tabela de benefícios
| código | benefício |
|---|---|
| 1 | pension_by_death_rural_worker |
| 2 | pension_by_death_accident_rural_worker |
| 3 | pension_by_death_rural_employer |
| 4 | retirement_invalidity_rural_emploee |
| 5 | retirement_invalidity_accident_rural_worker |
| 6 | retirement_invalidity_rural_employer |
| 7 | retirement_by_eldness_rural_worker |
| 8 | retirement_by_age_rural_employer |
| 9 | complement_by_work_accident_rural_worker |
| 11 | support_invalidity_rural_worker |
| 12 | support_by_age_rural_worker |
| 13 | aid_sickness_rural_worker |
| 15 | aid_time_off_rural_worker |
| 16 | aid_federal |
| 17 | international_agreement |
| 18 | inclusion_benefit |
| 19 | pension_student_law7004 |
| 20 | pension_by_death_diplomat |
| 21 | pension_by_death |
| 22 | pension_by_death_statute |
| 23 | pension_by_death_veteran |
| 24 | pension_special_institutional_act |
| 25 | aid_time_off |
| 26 | pension_by_death_special_law593 |
| 27 | pension_by_death_federal_emploee |
| 28 | pension_by_death_general_regime_law20465 |
| 29 | pension_by_death_marine_veteran |
| 30 | monthly_income_lifetime_invalidity |
| 31 | aid_sickness |
| 32 | retirement_invalidity_social_security |
| 33 | retirement_invalidity_aeronautic |
| 34 | retirement_invalidity_marine_law1756 |
| 35 | aid_sickness_veteran |
| 36 | aid_social_security_accident |
| 37 | retirement_capin_extra_emploee |
| 38 | retirement_federal_extra_emploee |
| 39 | aid_invalidity_student_law7004 |
| 40 | monthly_income_lifetime_by_age_upper70_law6179 |
| 41 | retirement_by_age |
| 42 | retirement_by_contribution_time |
| 43 | retirement_by_time_of_service_veteran |
| 44 | retirement_special_aeronautic |
| 45 | retirement_by_time_of_service_journalist |
| 46 | retirement_special |
| 47 | allowance_25 |
| 48 | allowance_20 |
| 49 | retirement_ordinary |
| 50 | aid_sickness_extinct_basic_plan |
| 51 | retirement_invalidity_extinct_basic_plan |
| 52 | retirement_by_age_extinct_basic_plan |
| 53 | aid_time_off_extinct_basic_plan |
| 54 | pension_indemnity_federal |
| 55 | pension_by_death_extinct_basic_plan |
| 56 | pension_lifetime_syndrome_thalidomide |
| 57 | retirement_by_teacher_labor_time |
| 58 | retirement_anisty |
| 59 | pension_by_death_amnesty |
| 60 | indemnity |
| 61 | aid_birth |
| 62 | aid_funeral |
| 63 | aid_funeral_rural_worker |
| 64 | aid_funeral_rural_employer |
| 65 | savings_special_autarchy |
| 67 | savings_mandatory_ipase_law5128 |
| 68 | savings_special_retirement_ps_affiliated_upper60 |
| 69 | savings_student_law7004 |
| 70 | restitution |
| 71 | monthly_income |
| 72 | retirement_by_time_of_service_law1756 |
| 73 | monthly_income_family_statute |
| 74 | complement_pension_federal |
| 75 | complement_retirement_federal |
| 76 | monthly_income_statute |
| 77 | monthly_income_sinpas_family_statute |
| 78 | retirement_by_age_law1756 |
| 79 | advantage |
| 80 | monthly_income_maternity |
| 81 | compulsory_retirement |
| 82 | retirement_by_time_of_service_sasse |
| 83 | retirement_invalidity_ex_sasse |
| 84 | pension_by_death_sasse |
| 85 | pension_lifetime_rubber_tapper_law7986 |
| 86 | pension_lifetime_rubber_tapper_dependent_law7986 |
| 87 | continuous_aid_physical_disabilities |
| 88 | continuous_aid_eldness |
| 89 | pension_special_hemodialysis_victim_caruaru |
| 90 | medic_assistency_work_accident |
| 91 | aid_sickness_by_work_accident |
| 92 | retirement_invalidity_work_accident |
| 93 | pension_by_death_work_accident |
| 94 | aid_work_accident |
| 95 | aid_additional_work_accident |
| 96 | pension_special_leprosy_law11520 |
| 97 | savings_by_death_work_accident |
| 98 | aid_longshoreman |
| 99 | time_off_15 |
15. Simulação de Cenários
Portabilidade
15.1. Aprovação pelo CTC
A proposta deve estar em status "pending_response". Se o cliente tiver configuração de envio manual a proposta será criada com status "pending_submission" e somente após o patch de "pending_response" este webhook deverá ser enviado. Caso a configuração seja de envio automático a proposta será criada com status "pending_response" e este webhook poderá ser chamado logo após.
Request
- ENDPOINT/mock/credit_transfer/ctc
- MÉTODOPOST
Payload:
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "proposal_creation_accepted"
}
15.2. Rejeição pelo CTC
A proposta deve estar em status "pending_response".
Request
- ENDPOINT/mock/credit_transfer/ctc
- MÉTODOPOST
Payload:
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "proposal_creation_refused"
}
15.3. Envio de saldo devedor pelo banco de origem
A chamada de aprovação pelo CTC (15.1) deve ser enviada antes. A proposta deve estar em status "pending_acceptance"
Request
- ENDPOINT/mock/credit_transfer/ctc
- MÉTODOPOST
Payload:
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "proposal_approval",
"due_balance": 9000, // Opcional, se não informado será enviado o valor usado na criação da proposta
"installment_face_value": 300, // Opcional, se não informado será enviado o valor usado na criação da proposta
"installment_number": 40, // Opcional, se não informado será enviado o valor usado na criação da proposta
"opened_installment_number": 35, // Opcional, se não informado será enviado igual ao installment_number
"overdue_installment_number": 5 // Opcional, se não informado será enviado 0
}
15.4. Retenção pelo banco de origem
A chamada de aprovação pelo CTC (15.1) deve ser enviada antes. A proposta deve estar em status "pending_acceptance"
Request
- ENDPOINT/mock/credit_transfer/ctc
- MÉTODOPOST
Payload:
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "proposal_retention"
}
15.5. Devolução do pagamento pelo banco de origem
Só pode ser enviado depois que a proposta for aceita e a operação de portabilidade desembolsada. Proposta deve estar em status "settlement_sent", "pending_settlement_confirmation" ou "paid".
Request
- ENDPOINT/mock/credit_transfer/str
- MÉTODOPOST
Payload:
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "payment_rejected"
}
15.6. Confirmação de pagamento pelo CTC
Proposta deve ter sido aceita e a operação de portabilidade desembolsada. Status deve ser "settlement_sent".
Request
- ENDPOINT/mock/credit_transfer/ctc
- MÉTODOPOST
Payload:
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "settlement_confirmation"
}
15.7. Confirmação de pagamento pelo banco de origem
Deve ser chamado após a confirmação de pagamento pelo CTC (15.6). Proposta deve estar em status "pending_settlement_confirmation".
Request
- ENDPOINT/mock/credit_transfer/ctc
- MÉTODOPOST
Payload:
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "payment_confirmation"
}
15.8. Averbação de garantia
Proposta deve estar em status "pending_settlement_confirmation" ou "paid", após 15.6 ou 15.7.
Request
- ENDPOINT/mock/credit_transfer/collateral
- MÉTODOPOST
Payload:
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"credit_operation_type": "portability",
"collateral_constituted": true
}
Refinanciamento
15.9. Averbação de garantia
Proposta deve estar em status "paid" ou "pending_settlement_confirmation" com garantia de portabilidade averbada e o refinanciamento deve ter sido aceito.
Request
- ENDPOINT/mock/credit_transfer/collateral
- MÉTODOPOST
Payload:
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"credit_operation_type": "refinancing",
"collateral_constituted": true
}
15.10. Falha na averbação de garantia
Proposta deve estar em status "paid" ou "pending_settlement_confirmation" com garantia de portabilidade averbada e o refinanciamento deve ter sido aceito.
Request
- ENDPOINT/mock/credit_transfer/collateral
- MÉTODOPOST
Payload:
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"credit_operation_type": "refinancing",
"collateral_constituted": false
}
15.11. Falha no desembolso
Operação de refinanciamento deve ter sido desembolsada.
Request
- ENDPOINT/mock/credit_transfer/disbursement
- MÉTODOPOST
Payload:
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "disbursement_failed"
}
16. Incluir Fee na operação de portabilidade rebatido pela QI ao parceiro
Para inclusão do fee, é necessário que a operação esteja averbada, desembolsada e que não esteja cedida.
Request
payload.json
{
"amount": 20,
"rebate_bank_account": {
"name": "Teste Ltda",
"document_number": "18533555000164",
"account_digit": "0",
"account_number": "4290001",
"branch_number": "0001",
"bank_code": "329"
},
"amount_type": "percentage",
"fee_type": "spread"
}
Response
response.json
{}