Índice

Eccor FGTS - Documentação

Introdução

A antecipação de FGTS é um serviço disponibilizado por algumas instituições financeiras, para oferecer aos trabalhadores a oportunidade de acessar antecipadamente parte do saldo do seu FGTS. Este benefício, normalmente disponível em situações específicas como aquisição de imóveis, aposentadoria, ou em casos de demissão sem justa causa, destaca-se como uma solução financeira flexível.

A ECCOR Open se destaca como referência nesse serviço, simplificando o modelo de negócio de nossos clientes. Equipados com um BackOffice de ponta, capaz de gerar operações de crédito de maneira eficaz, também oferecemos APIs igualmente avançadas com a mesma finalidade.

Esta documentação foi elaborada para proporcionar uma compreensão aprofundada sobre a condução de operações de crédito de antecipação de FGTS, utilizando as avançadas APIs disponibilizadas pela ECCOR FGTS. Vamos explorar juntos as possibilidades e benefícios que essa plataforma inovadora tem a oferecer.

1.0 - Onboarding

Detalhando o Processo

O processo de Onboarding inicia imediatamente após a conclusão do acordo comercial entre sua empresa e a ECCOR Open. Durante esta fase crucial, será realizada a configuração abrangente do seu ambiente, seja por meio do nosso BackOffice ou através das nossas avançadas APIs.

É de suma importância que as questões comerciais e jurídicas estejam perfeitamente alinhadas, garantindo assim uma integração eficiente, rápida e descomplicada.

Ao longo de toda a jornada, nossa equipe dedicada estará pronta para auxiliá-los em qualquer situação que possa surgir. Seja para solucionar problemas, esclarecer dúvidas ou receber sugestões valiosas, incentivamos você a compartilhar conosco através do e-mail suporte@eccoropen.com.br

Cada e-mail enviado gera automaticamente um ticket, garantindo uma análise ágil e uma resposta segura. Caso a resposta inicial não esteja completamente clara, não hesite em entrar em contato novamente. Estamos aqui para oferecer o suporte necessário em cada etapa do seu processo de integração com a ECCOR FGTS.

Configuração de Acesso

Para garantir acesso às APIs da ECCOR FGTS e viabilizar a antecipação do FGTS para seus clientes, disponibilizaremos três informações cruciais:

  • URL de Autenticação:

    • A URL de autenticação é essencial para gerar o access token, permitindo o acesso a cada endpoint de nossa API. Este token é a chave para desbloquear as funcionalidades necessárias para realizar operações.

  • Configuração de Produtos:

    • A configuração dos produtos é um passo importante. Ela assegura que todos os acordos comerciais, como comissões, taxas de juros e períodos de amortização, estejam devidamente registrados no sistema. Essa configuração é fundamental para conduzir simulações precisas e efetuar as operações de crédito.

  • URL da API ECCOR Open:

    • A URL da API ECCOR FGTS é o ponto de acesso principal, proporcionando todos os endpoints necessários para uma variedade de operações, incluindo simulações, cadastro de pessoa física, geração de operações de crédito, entre outros. É através dessa URL que você terá acesso às funcionalidades completas da ECCOR FGTS.

Essas informações formam a base para uma integração bem-sucedida e para aproveitar ao máximo as capacidades da ECCOR Open. Se houver dúvidas ou necessidade de suporte adicional, nossa equipe está pronta para ajudar.

1.1 - Autenticação

Na fase atual, é fundamental que você tenha recebido da nossa equipe as informações para a autenticação:

  • URL de Autenticação:
    • Esta URL é exclusiva para a geração do token de acesso destinado às APIs. É a chave de entrada para iniciar a autenticação e obter as permissões necessárias.
  • Basic Token:
    • Uma chave única, conhecida como Basic Token, é fornecida para a geração do token de acesso. Esta chave desempenha um papel vital na autenticação segura do cliente.
  • Grant Type:
    • O tipo de concessão, identificado como Client Credentials, indica o método pelo qual o cliente solicitará e receberá o token de acesso. Este é um elemento fundamental do processo de autenticação.
  • Scope:
    • O escopo especifica as permissões associadas ao token de acesso. Certifique-se de entender e fornecer os escopos necessários para as operações planejadas.

A seguir, apresentaremos um exemplo de autenticação, abrangendo cenários de sucesso e falha, para orientá-lo nesse processo essencial.

POST - Autenticação

sua-url-de-autenticacao/oauth2/token

Exemplo de URL de autenticação
HEADERS
Authorization
Basic basic_token
Body urlencoded
grant_type
client_credentials
scope
credit/admin
Example Request
				
					curl --location 'https://chatbotuy3-stg.auth.us-east-2.amazoncognito.com/oauth2/token' \
--header 'Authorization: Basic access_token' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'scope=credit/admin'
Example Response
200 OK
				
					{
  "access_token": "eyJraWQiOiJBb2k3Y24yMWtZQjdFYkFyaEphRyt2YkJNTkh0YU02TXRyYTF4WHk4Y3dFPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI1OHJmM2k2cGhzZW45M2xoOWozbGZkaWFhcSIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiY3JlZGl0XC9hZG1pbiIsImF1dGhfdGltZSI6MTY5OTk5MTk3OSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnNhLWVhc3QtMS5hbWF6b25hd3MuY29tXC9zYS1lYXN0LTFfT3lPT2RiQjNMIiwiZXhwIjoxNjk5OTk1NTc5LCJpYXQiOjE2OTk5OTE5NzksInZlcnNpb24iOjIsImp0aSI6IjU1YjEzZmQxLTBmMjMtNDkzYS1hZDI3LTc1MWYyYzk0N2I1OCIsImNsaWVudF9pZCI6IjU4cmYzaTZwaHNlbjkzbGg5ajNsZmRpYWFxIn0.dCiZmxagtnBsBy5v0BNeAcoBL9jcjVUz1g4BZrCLhpfh5ja3PXfaYwANkacp6fEoj5h9jqUYeav6-tP1EPfdFtoalwEtXz-99ORS0QQybraL6EVgTHOltyCQUeheHvdMv5dzLpOW6V9QhLqM_zLH9W1qIi6I_8ETK7Xn6VCMHy00LYmNsMVNqTdvMiiT77_dM7WQ1y_bpNBFdxZuQIDogkqBAup0LIoBTNdnPwWfNe4oZ5lhKadjTCufs4DX_l4e76Ugak6B9G5nitsXXT8WQIydm-ji27UqM_jR7IZNBQcUERZZF5FJlcTMR_pNZSEwhWuYxEjXuX7LcWF6GO90sA",
  "expires_in": 3600,
  "token_type": "Bearer"
}
Date
Tue, 14 Nov 2023 19:59:39 GMT
Content-Type
application/json;charset=UTF-8
Transfer-Encoding
chunked
Connection
keep-alive
Content-Security-Policy-Report-Only
script-src https://dgay0d1ozp68.cloudfront.net https://chatbot-uy3.auth.sa-east-1.amazoncognito.com; style-src https://dgay0d1ozp68.cloudfront.net https://chatbot-uy3.auth.sa-east-1.amazoncognito.com; img-src https://dgay0d1ozp68.cloudfront.net https://chatbot-uy3.auth.sa-east-1.amazoncognito.com; report-uri https://chatbot-uy3.auth.sa-east-1.amazoncognito.com/cspreport
x-amz-cognito-request-id
e8cf4d1e-fab3-425a-8e7b-0663c9fe1515
X-Content-Type-Options
nosniff
X-XSS-Protection
1; mode=block
Cache-Control
no-cache, no-store, max-age=0, must-revalidate
Pragma
no-cache
Expires
0
Strict-Transport-Security
max-age=31536000 ; includeSubDomains
X-Frame-Options
DENY
Server
Server
				
					curl --location 'https://chatbotuy3-stg.auth.us-east-2.amazoncognito.com/oauth2/token' \
--header 'Authorization: Basic access_token' \
--data-urlencode 'scope=credit/admin'
Example Response
400 BAD REQUEST
				
					{
  "error": "invalid_request"
}
Date
Tue, 14 Nov 2023 20:00:53 GMT
Content-Type
application/json;charset=UTF-8
Transfer-Encoding
chunked
Connection
keep-alive
Content-Security-Policy-Report-Only
script-src https://dgay0d1ozp68.cloudfront.net https://chatbot-uy3.auth.sa-east-1.amazoncognito.com; style-src https://dgay0d1ozp68.cloudfront.net https://chatbot-uy3.auth.sa-east-1.amazoncognito.com; img-src https://dgay0d1ozp68.cloudfront.net https://chatbot-uy3.auth.sa-east-1.amazoncognito.com; report-uri https://chatbot-uy3.auth.sa-east-1.amazoncognito.com/cspreport
x-amz-cognito-request-id
a6db47b1-b3b5-4a1e-854c-ecb1d561da02
X-Content-Type-Options
nosniff
X-XSS-Protection
1; mode=block
Cache-Control
no-cache, no-store, max-age=0, must-revalidate
Pragma
no-cache
Expires
0
Strict-Transport-Security
max-age=31536000 ; includeSubDomains
X-Frame-Options
DENY
Server
Server
				
					curl --location 'https://chatbotuy3-stg.auth.us-east-2.amazoncognito.com/oauth2/token' \
--header 'Authorization: Basic access_token' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'scope=credit/uy3'
Example Response
400 BAD REQUEST
				
					{
  "access_token": "eyJraWQiOiJBb2k3Y24yMWtZQjdFYkFyaEphRyt2YkJNTkh0YU02TXRyYTF4WHk4Y3dFPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI1OHJmM2k2cGhzZW45M2xoOWozbGZkaWFhcSIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiY3JlZGl0XC9hZG1pbiIsImF1dGhfdGltZSI6MTY5OTk5MTk3OSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnNhLWVhc3QtMS5hbWF6b25hd3MuY29tXC9zYS1lYXN0LTFfT3lPT2RiQjNMIiwiZXhwIjoxNjk5OTk1NTc5LCJpYXQiOjE2OTk5OTE5NzksInZlcnNpb24iOjIsImp0aSI6IjU1YjEzZmQxLTBmMjMtNDkzYS1hZDI3LTc1MWYyYzk0N2I1OCIsImNsaWVudF9pZCI6IjU4cmYzaTZwaHNlbjkzbGg5ajNsZmRpYWFxIn0.dCiZmxagtnBsBy5v0BNeAcoBL9jcjVUz1g4BZrCLhpfh5ja3PXfaYwANkacp6fEoj5h9jqUYeav6-tP1EPfdFtoalwEtXz-99ORS0QQybraL6EVgTHOltyCQUeheHvdMv5dzLpOW6V9QhLqM_zLH9W1qIi6I_8ETK7Xn6VCMHy00LYmNsMVNqTdvMiiT77_dM7WQ1y_bpNBFdxZuQIDogkqBAup0LIoBTNdnPwWfNe4oZ5lhKadjTCufs4DX_l4e76Ugak6B9G5nitsXXT8WQIydm-ji27UqM_jR7IZNBQcUERZZF5FJlcTMR_pNZSEwhWuYxEjXuX7LcWF6GO90sA",
  "expires_in": 3600,
  "token_type": "Bearer"
}
Date
Tue, 14 Nov 2023 20:02:12 GMT
Content-Type
application/json;charset=UTF-8
Transfer-Encoding
chunked
Connection
keep-alive
Content-Security-Policy-Report-Only
script-src https://dgay0d1ozp68.cloudfront.net https://chatbot-uy3.auth.sa-east-1.amazoncognito.com; style-src https://dgay0d1ozp68.cloudfront.net https://chatbot-uy3.auth.sa-east-1.amazoncognito.com; img-src https://dgay0d1ozp68.cloudfront.net https://chatbot-uy3.auth.sa-east-1.amazoncognito.com; report-uri https://chatbot-uy3.auth.sa-east-1.amazoncognito.com/cspreport
x-amz-cognito-request-id
03bccfcc-fa00-4b0f-8504-131c709e9463
X-Content-Type-Options
nosniff
X-XSS-Protection
1; mode=block
Cache-Control
no-cache, no-store, max-age=0, must-revalidate
Pragma
no-cache
Expires
0
Strict-Transport-Security
max-age=31536000 ; includeSubDomains
X-Frame-Options
DENY
Server
Server

1.2 - Ambientes

Abaixo estão as URLs das APIs de homologação e produção.

Os tokens de autenticação são diferentes para cada ambiente, portanto, para que você tenha acesso ao ambiente de produção é necessário ter concluído o processo homologatório.

Tabela CSV
AmbienteURL Base
Homologaçãohttps://web-credit-api.azurewebsites.net/
Produçãohttps://api.uy3.com.br/

1.3 - Produtos

A configuração do produto de FGTS permite que os acordos comerciais, como comissões, taxas de juros e períodos de amortização, estejam devidamente registrados no sistema. Essa configuração é importante para gerar simulações e efetuar as operações de crédito.

Importante ressaltar que a configuração deste produto é realizada pelo time da ECCOR FGTS, sendo assim, qualquer alteração no mesmo, precisa ser solicitada através do e-mail suporte@eccoropen.com.br

A seguir, apresentaremos exemplos de como listar os seus produtos.

GET Listar Produtos

https://web-credit-api.azurewebsites.net/v1/Product

AUTHORIZATION Bearer Token
Token
Example Request
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/Product'
Example Response
200 OK
				
					{
  "page": 0,
  "totalPages": 1,
  "totalItems": 3,
  "data": [
    {
      "id": "a3770bf5-fc8b-4668-ba54-4bfecd089b69",
      "name": "CCB FGTS",
      "categoryName": "FGTS",
      "templateDoc": {
        "id": "de46a99c-4e2f-4944-ba62-2bc0656da293",
        "fileName": "us-east-2_ljZORJruL/6eefeda2-5e66-46ef-974d-925c36fb705b/416c8b93-ca7e-4729-a848-c7c21443f65c_CCBAntecFGTS1.docx",
        "fileType": "Document",
        "displayName": "CCB_Antec_FGTS.docx",
        "tempUrl": "url",
        "tempGetUrl": "url"
      },
      "code": 2,
      "amortizationType": "FGTS",
      "amortizationTypeDisplay": "FGTS",
      "viewType": 0,
      "defaultFundId": null,
      "defaultFundDisplay": null,
      "selfieSignature": false,
      "selfieDocumentSignature": false,
      "facialBiometrics": false,
      "signatureValidation": "EletronicSignature",
      "signatureValidationStep": true,
      "defaultCreditAnalysisGroup": 2889,
      "automaticCreditApproval": true,
      "automaticCreditAnalysisExecution": true,
      "minimumInterestRate": 0.0199,
      "maximumInterestRate": 0.0204,
      "minimumPrincipalAmount": 0,
      "maximumPrincipalAmount": 0,
      "cosifBankAccount": null,
      "requireGuarantor": false,
      "bankComission": {
        "amount": 0.01,
        "type": 1,
        "baseValue": 0
      },
      "commissionRange": [],
      "relatedPerson": [],
      "requiredDoc": [],
      "allowOwnFund": true,
      "maximumValueWithoutDigitalSignature": 50000000,
      "instrumentApproval": false,
      "draftGeneration": true,
      "useSignaturePortal": true,
      "signatureType": 2,
      "automaticComplianceAnalysisExecution": true,
      "defaultComplianceAnalysisGroup": 2889,
      "automaticComplianceApproval": true,
      "requireWitness": false,
      "limitOpToPerson": false,
      "allowFinanceTaxExemption": false,
      "debitBankAccount": null,
      "signaturePortalProvider": 1,
      "useCollateral": false,
      "defaultCollateralDescription": "teste fabio",
      "openBankAccount": false,
      "isConsumerCreditNote": false,
      "maximumAbsAmortizationPeriods": null,
      "maximumAbsInterestPeriods": null,
      "maximumAmortizationPeriods": 10,
      "minimumAmortizationPeriods": 3,
      "minimumEmissionCostInCents": 0,
      "maximumEmissionCostInCents": 0,
      "timeToSendToSignatures": 600,
      "timeLimitToSign": 2359,
      "timeLimitToSubmitApproval": 2359,
      "timeLimitToApprove": 2359,
      "maximumAutomaticLiquidationValueInCents": 0,
      "financeEmissioncost": true,
      "financeFinTax": true,
      "cvmRegistrationNumber": 0,
      "cvmRegistrationNumberIndex": 0,
      "cvmRegistrationDate": "1901-01-01T00:00:00-03:06",
      "maximumValueWithoutSignatureValidation": 1000,
      "notifySigner": false
    }
  ],
  "paginationToken": null
}
Content-Length
11894
Content-Type
application/json; charset=utf-8
Date
Tue, 21 Nov 2023 22:07:59 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
X-Rate-Limit-Limit
10s
X-Rate-Limit-Remaining
49
X-Rate-Limit-Reset
2023-11-21T22:08:00.0000000Z
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/Product'
Example Response
401 UNAUTHORIZED
No response body
This request doesn't return any response body
Content-Length
0
Date
Tue, 21 Nov 2023 22:08:52 GMT
Server
Kestrel
WWW-Authenticate
Bearer
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/Product'
Example Response
403 FORBIDDEN
				
					{
  "code": "MISSING_RESOURCE_PERMISSION",
  "message": "Acesso negado. Você não possui o nível de permissão necessário para acessar este recurso",
  "details": {
    "permissionType": "Read",
    "resource": "CreditProduct"
  },
  "correlationId": "#3f71f1ab7784c066f184328a372f1e57"
}
Content-Length
259
Content-Type
application/json;charset=UTF-8
Date
Tue, 21 Nov 2023 22:10:12 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
X-Rate-Limit-Limit
10s
X-Rate-Limit-Remaining
49
X-Rate-Limit-Reset
2023-11-21T22:10:20.0000000Z

2.0 - Simulação

Para ter acesso a antecipação do FGTS, é necessário:

👉 Ativar o Saque Aniversário no app FGTS;
👉 Autorizar a UY3 (457) a consultar seu saldo no app FGTS.

Com a ECCOR FGTS devidamente autorizada, seus produtos comerciais configurados e o CPF do cliente, agora é possível realizar uma simulação de antecipação com facilidade.

Observação: em todas as nossas APIs, os valores monetários são sempre tratados em centavos, ou seja, se você receber ou enviar uma propriedade com o valor “4570”, considere R$ 45,70.

A mesma questão vale para os valores em percentuais, se você receber ou enviar uma propriedade com o valor “0.0204”, considere 2,04%.

POST Realizar Simulação

https://web-credit-api.azurewebsites.net/v1/Amortization

AUTHORIZATION Bearer Token
Token
Body raw (json)
				
					{
    "amortization": {
        "agentCommission": {
            "amount": 0, //Valor da comissão
            "type": "Percentage", //Absolute: Valor fixo por operação | Percentage: Valor percentual em relação ao valor da dívida
            "baseValue": "InitialValue" //InitialValue: Valor inicial da dívida | RequestedValue: Valor solicitado pelo tomador
        },
        "apr": 0.0204, //Taxa de juros
        "termInMonths": 10, //Quantidade de parcelas a serem antecipadas (no caso de FGTS, serão os anos antecipados)
        "startDate": "2023-11-21T03:00:00.000Z", //Data da simulação
        "requestedAmount": 0, //Valor solicitado (para FGTS sempre será 0)
        "amortizationType": "fgts" //Tipo de amortização, sempre fixo
    },
    "registrationNumber": "00805349960", //CPF da pessoa para quando não houver cadastro (enviar null em personId),
    "personId": null, //Identificador da pessoa física, para quando houver cadastro (enviar null em registrationNumber)
    "legalPerson": false, //Indica que a simulação é para pessoa física (para FGTS será sempre false)
    "productId": "a3770bf5-fc8b-4668-ba54-4bfecd089b69" //Identificador do Produto
}
Example Request
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/Amortization' \
--data '{
    "amortization": {
        "agentCommission": {
            "amount": 0,
            "type": "Percentage",
            "baseValue": "InitialValue"
        },
        "apr": 0.0204,
        "termInMonths": 10,
        "startDate": "2023-11-21T03:00:00.000Z",
        "requestedAmount": 0,
        "amortizationType": "fgts"
    },
    "registrationNumber": "00805349960",
    "legalPerson": false,
    "productId": "a3770bf5-fc8b-4668-ba54-4bfecd089b69"
}'
Example Response
200 OK
				
					{
    "id": "5088c941-7ec7-4ea9-a41f-ac6f041bec62", //Identificador da simulação
    "calculateByValueType": "Gross", //Tipo de cálculo de operação: Gross - Valor Bruto ou Liquid - Valor Líquido
    "requestedAmount": 0, //Valor solicitado pelo tomador. Quando calculado pelo valor líquido, o valor solicitado é o liquido da operação.
    "initialValue": 4914702, //Valor inicial da dívida contraída
    "liquidValue": 4705290, //Valor líquido da operação
    "monthlyInterest": 0.0204, //Taxa de juros nominal mensal da operação
    "yearlyInterest": 0.27422288066567435, //Taxa de juros nominal anual da operação
    "startDate": "2023-11-21T12:00:00-03:00", //Data de início da operação
    "dueDate": "2033-10-01T00:00:00-03:00", //Data de encerramento da operação (vencimento da última parcela)
    "comm": 49147, //Custo de Emissão da operação (soma da comissão do agente e Custo de emissão UY3)
    "finTax": 160265, //Valor de IOF da operação
    "effectiveMonthlyCost": 0.021795997411120815, //Custo Efetivo Total (CET) Mensal da operação
    "effectiveYearlyCost": 0.29529999999999945, //Custo Efetivo Total (CET) Anual da operação
    "termInMonths": 10, //Prazo da operação (em meses ou anos, dependendo da periodicidade)
    "paymentScheduleItems": [
        {
            "dueDate": "2023-11-21T12:00:00-03:00", //Data de vencimento da parcela
            "principalAmountInCents": 4914702, //Saldo devedor da parcela após a apuração de amortização e juros
            "amortization": 0, //Valor amortizado (principal) na parcela
            "interest": 0, //Juros apurados no período
            "financeTax": 0, //Valor de IOF que incide sob a parcela (IOF diário + parcela do IOF base)
            "payment": 0 //Valor da parcela que será pago pelo devedor no vencimento
        },
        {
            "dueDate": "2024-10-01T00:00:00-03:00",
            "principalAmountInCents": 3571325,
            "amortization": 1343377,
            "interest": 317309,
            "financeTax": 39804,
            "payment": 1660687
        },
        {
            "dueDate": "2025-10-01T00:00:00-03:00",
            "principalAmountInCents": 2573131,
            "amortization": 998193,
            "interest": 579459,
            "financeTax": 33669,
            "payment": 1577653
        },
        {
            "dueDate": "2026-10-01T00:00:00-03:00",
            "principalAmountInCents": 1831427,
            "amortization": 741704,
            "interest": 757065,
            "financeTax": 25017,
            "payment": 1498770
        },
        {
            "dueDate": "2027-10-01T00:00:00-03:00",
            "principalAmountInCents": 1400738,
            "amortization": 430688,
            "interest": 682002,
            "financeTax": 14527,
            "payment": 1112691
        },
        {
            "dueDate": "2028-10-01T00:00:00-03:00",
            "principalAmountInCents": 1080931,
            "amortization": 319807,
            "interest": 737250,
            "financeTax": 10787,
            "payment": 1057058
        },
        {
            "dueDate": "2029-10-01T00:00:00-03:00",
            "principalAmountInCents": 843299,
            "amortization": 237632,
            "interest": 766573,
            "financeTax": 8015,
            "payment": 1004206
        },
        {
            "dueDate": "2030-10-01T00:00:00-03:00",
            "principalAmountInCents": 567080,
            "amortization": 276218,
            "interest": 1216155,
            "financeTax": 9316,
            "payment": 1492374
        },
        {
            "dueDate": "2031-10-01T00:00:00-03:00",
            "principalAmountInCents": 361837,
            "amortization": 205243,
            "interest": 1212511,
            "financeTax": 6922,
            "payment": 1417755
        },
        {
            "dueDate": "2032-10-01T00:00:00-03:00",
            "principalAmountInCents": 154248,
            "amortization": 207589,
            "interest": 1626987,
            "financeTax": 7001,
            "payment": 1834577
        },
        {
            "dueDate": "2033-10-01T00:00:00-03:00",
            "principalAmountInCents": 0,
            "amortization": 154248,
            "interest": 1588599,
            "financeTax": 5202,
            "payment": 1742848
        }
    ]
}
Content-Length
2085
Content-Type
application/json; charset=utf-8
Date
Tue, 21 Nov 2023 22:18:35 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/Amortization' \
--data '{
    "amortization": {
        "agentCommission": {
            "amount": 0,
            "type": "Percentage",
            "baseValue": "InitialValue"
        },
        "apr": 0.0204,
        "termInMonths": 10,
        "startDate": "2023-11-21T03:00:00.000Z",
        "requestedAmount": 0,
        "amortizationType": "fgts"
    },
    "registrationNumber": "00805349960",
    "legalPerson": false,
    "productId": "a3770bf5-fc8b-4668-ba54-4bfecd089b69"
}'
Example Response
401 UNAUTHORIZED
No response body
This request doesn't return any response body
Content-Length
0
Date
Tue, 21 Nov 2023 22:19:11 GMT
Server
Kestrel
WWW-Authenticate
Bearer
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70

3.0 - Pessoa Física

POST Inserir Pessoa Física

https://web-credit-api.azurewebsites.net/v1/NaturalPerson

AUTHORIZATION Bearer Token
Token
Body raw (json)
				
					{
    "registrationNumber": "00805349960", //CPF da pessoa
    "civilStatus": "Single", //Estado civil: Married (Casado), Widowed (Viúvo), Separated (Separado), Divorced (Divorciado), Single (Solteiro)
    "birthDate": "1985-04-03T03:00:00.000Z", //Data de nascimento
    "nationality": "Brasileira", //Nacionalidade
    "email": "nilce.knupp@geradornv.com.br", //E-mail
    "phone": "12980546587", //Número de Telefone principal (Celular)
    "name": "NILCE GARBELINI KNUPP", //Nome
    "occupation": "ADVOGADA", //Ocupação
    "address": {
        "addressName": "Rua Antônio Marco Pazote", //Endereço
        "zipCode": "13737-005", //CEP
        "city": "Mococa", //Cidade
        "uf": "SP", //Estado
        "district": "Jardim Colina Verde", //Bairro
        "number": "169", //Número
        "complement": "N/A" //Complemento
    },
    //Contas bancárias: é necessário enviar pelo menos uma conta bancária em nome do tomador, para o pagamento da operação
    //Abaixo está um exemplo de envio de PIX e um exemplo de envio de dados bancários para TED
    "bankAccounts": [ 
        {
            "operationTypeValue": "Pix", //Tipo de operação PIX
            "pixKeyTypeValue": "NaturalRegistrationNumber", //Tipo de chave: NaturalRegistrationNumber (CPF), Phone (Telefone), Email, Automatic (chave aletória gerada pelo banco)
            "keyPix": "00805349960" //Chave PIX
        },
        {
            "operationTypeValue": "Transfer", //Tipo de operação Transferência
            "account": 1234567, //Número da conta
            "agency": "1234", //Número da agência (sem dígito)
            "type": "NaturalCheckingAccount", //Tipo de conta: NaturalCheckingAccount (Conta Corrente de Pessoa Física), NaturalSavingsAccount (Poupança de Pessoa Física)
            "bankCode": "1", //Código do banco
            "accountDigit": "0" //Dígito da conta
        }
    ]
}
Example Request
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson' \
--data-raw '{
    "registrationNumber": "00805349960",
    "civilStatus": "Single",
    "birthDate": "1985-04-03T03:00:00.000Z",
    "nationality": "Brasileira",
    "email": "nilce.knupp@geradornv.com.br",
    "phone": "12980546587",
    "name": "NILCE GARBELINI KNUPP",
    "occupation": "ADVOGADA",
    "address": {
        "addressName": "Rua Antônio Marco Pazote",
        "zipCode": "13737-005",
        "city": "Mococa",
        "uf": "SP",
        "district": "Jardim Colina Verde",
        "number": "169",
        "complement": "N/A"
    },
    "bankAccounts": [
        {
            "operationTypeValue": "Pix",
            "pixKeyTypeValue": "NaturalRegistrationNumber",
            "keyPix": "00805349960"
        },
        {
            "operationTypeValue": "Transfer",
            "account": 1234567,
            "agency": "1234",
            "type": "NaturalCheckingAccount",
            "bankCode": "1",
            "accountDigit": "0"
        }
    ]
}'
Example Response
200 OK
				
					"311ae9b2-a751-4819-a9f0-6d839b373172" //Identificador único da pessoa física
Content-Length
38
Content-Type
application/json; charset=utf-8
Date
Wed, 22 Nov 2023 11:31:51 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson' \
--data-raw '{
    "registrationNumber": null, //CPF da pessoa
    "civilStatus": "Single", //Estado civil: Married (Casado), Widowed (Viúvo), Separated (Separado), Divorced (Divorciado), Single (Solteiro)
    "birthDate": "1985-04-03T03:00:00.000Z", //Data de nascimento
    "nationality": "Brasileira", //Nacionalidade
    "email": "nilce.knupp@geradornv.com.br", //E-mail
    "phone": "12980546587", //Número de Telefone principal (Celular)
    "name": "NILCE GARBELINI KNUPP", //Nome
    "occupation": "ADVOGADA", //Ocupação
    "address": {
        "addressName": "Rua Antônio Marco Pazote", //Endereço
        "zipCode": "13737-005", //CEP
        "city": "Mococa", //Cidade
        "uf": "SP", //Estado
        "district": "Jardim Colina Verde", //Bairro
        "number": "169", //Número
        "complement": "N/A" //Complemento
    },
    //Contas bancárias: é necessário enviar pelo menos uma conta bancária em nome do tomador, para o pagamento da operação
    //Abaixo está um exemplo de envio de PIX e um exemplo de envio de dados bancários para TED
    "bankAccounts": [ 
        {
            "operationTypeValue": "Pix", //Tipo de operação PIX
            "pixKeyTypeValue": "NaturalRegistrationNumber", //Tipo de chave: NaturalRegistrationNumber (CPF), Phone (Telefone), Email, Automatic (chave aletória gerada pelo banco)
            "keyPix": "00805349960" //Chave PIX
        },
        {
            "operationTypeValue": "Transfer", //Tipo de operação Transferência
            "account": 1234567, //Número da conta
            "agency": "1234", //Número da agência (sem dígito)
            "type": "NaturalCheckingAccount", //Tipo de conta: NaturalCheckingAccount (Conta Corrente de Pessoa Física), NaturalSavingsAccount (Poupança de Pessoa Física)
            "bankCode": "1", //Código do banco
            "accountDigit": "0" //Dígito da conta
        }
    ]
}'
Example Response
400 BAD REQUEST
				
					{
  "code": "INVALID_FORM",
  "message": "Não foi possível validar os dados do formulário",
  "details": {
    "formErrors": [
      {
        "message": "Error setting value to 'RegistrationNumber' on 'Risk.WebApi.Models.Create.Account.NaturalPersonCreateModel'.",
        "key": "registrationNumber"
      }
    ]
  }
}
Content-Length
263
Content-Type
application/json; charset=utf-8
Date
Wed, 22 Nov 2023 11:45:23 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70

PUT Atualizar Pessoa Física

https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172

AUTHORIZATION Bearer Token
Token
Body raw (json)
				
					{
    "registrationNumber": "00805349960", //CPF da pessoa
    "civilStatus": "Single", //Estado civil: Married (Casado), Widowed (Viúvo), Separated (Separado), Divorced (Divorciado), Single (Solteiro)
    "birthDate": "1985-04-03T03:00:00.000Z", //Data de nascimento
    "nationality": "Brasileira", //Nacionalidade
    "email": "nilce.knupp@geradornv.com.br", //E-mail
    "phone": "12980546587", //Número de Telefone principal (Celular)
    "name": "NILCE GARBELINI KNUPP", //Nome
    "occupation": "ADMINISTRADORA", //Ocupação
    "address": {
        "addressName": "Rua Antônio Marco Pazote", //Endereço
        "zipCode": "13737-005", //CEP
        "city": "Mococa", //Cidade
        "uf": "SP", //Estado
        "district": "Jardim Colina Verde", //Bairro
        "number": "169", //Número
        "complement": "N/A" //Complemento
    },
    //Contas bancárias: é necessário enviar pelo menos uma conta bancária em nome do tomador, para o pagamento da operação
    //Abaixo está um exemplo de envio de PIX e um exemplo de envio de dados bancários para TED
    "bankAccounts": [ 
        {
            "id": "5fbad5a3-059c-494b-bab9-095793694f34", //Identificador da conta bancária (caso não for enviado, o registro anterior será excluído)
            "operationTypeValue": "Pix", //Tipo de operação PIX
            "pixKeyTypeValue": "NaturalRegistrationNumber", //Tipo de chave: NaturalRegistrationNumber (CPF), Phone (Telefone), Email, Automatic (chave aletória gerada pelo banco)
            "keyPix": "00805349960" //Chave PIX
        },
        {
            "id": "5a4fa4fe-689e-4d37-89c0-71c5f89e6c71", //Identificador da conta bancária (caso não for enviado, o registro anterior será excluído)
            "operationTypeValue": "Transfer", //Tipo de operação Transferência
            "account": 1234567, //Número da conta
            "agency": "1234", //Número da agência (sem dígito)
            "type": "NaturalCheckingAccount", //Tipo de conta: NaturalCheckingAccount (Conta Corrente de Pessoa Física), NaturalSavingsAccount (Poupança de Pessoa Física)
            "bankCode": "1", //Código do banco
            "accountDigit": "1" //Dígito da conta
        }
    ]
}
Example Request
				
					curl --location --request PUT 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172' \
--data-raw '{
    "registrationNumber": "00805349960", //CPF da pessoa
    "civilStatus": "Single", //Estado civil: Married (Casado), Widowed (Viúvo), Separated (Separado), Divorced (Divorciado), Single (Solteiro)
    "birthDate": "1985-04-03T03:00:00.000Z", //Data de nascimento
    "nationality": "Brasileira", //Nacionalidade
    "email": "nilce.knupp@geradornv.com.br", //E-mail
    "phone": "12980546587", //Número de Telefone principal (Celular)
    "name": "NILCE GARBELINI KNUPP", //Nome
    "occupation": "ADMINISTRADORA", //Ocupação
    "address": {
        "addressName": "Rua Antônio Marco Pazote", //Endereço
        "zipCode": "13737-005", //CEP
        "city": "Mococa", //Cidade
        "uf": "SP", //Estado
        "district": "Jardim Colina Verde", //Bairro
        "number": "169", //Número
        "complement": "N/A" //Complemento
    },
    //Contas bancárias: é necessário enviar pelo menos uma conta bancária em nome do tomador, para o pagamento da operação
    //Abaixo está um exemplo de envio de PIX e um exemplo de envio de dados bancários para TED
    "bankAccounts": [ 
        {
            "id": "5fbad5a3-059c-494b-bab9-095793694f34", //Identificador da conta bancária (caso não for enviado, o registro anterior será excluído)
            "operationTypeValue": "Pix", //Tipo de operação PIX
            "pixKeyTypeValue": "NaturalRegistrationNumber", //Tipo de chave: NaturalRegistrationNumber (CPF), Phone (Telefone), Email, Automatic (chave aletória gerada pelo banco)
            "keyPix": "00805349960" //Chave PIX
        },
        {
            "id": "5a4fa4fe-689e-4d37-89c0-71c5f89e6c71", //Identificador da conta bancária (caso não for enviado, o registro anterior será excluído)
            "operationTypeValue": "Transfer", //Tipo de operação Transferência
            "account": 1234567, //Número da conta
            "agency": "1234", //Número da agência (sem dígito)
            "type": "NaturalCheckingAccount", //Tipo de conta: NaturalCheckingAccount (Conta Corrente de Pessoa Física), NaturalSavingsAccount (Poupança de Pessoa Física)
            "bankCode": "1", //Código do banco
            "accountDigit": "1" //Dígito da conta
        }
    ]
}'
Example Response
204 NO CONTENT
No response body
This request doesn't return any response body
Date
Wed, 22 Nov 2023 14:40:06 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson' \
--data-raw '{
    "registrationNumber": null, //CPF da pessoa
    "civilStatus": "Single", //Estado civil: Married (Casado), Widowed (Viúvo), Separated (Separado), Divorced (Divorciado), Single (Solteiro)
    "birthDate": "1985-04-03T03:00:00.000Z", //Data de nascimento
    "nationality": "Brasileira", //Nacionalidade
    "email": "nilce.knupp@geradornv.com.br", //E-mail
    "phone": "12980546587", //Número de Telefone principal (Celular)
    "name": "NILCE GARBELINI KNUPP", //Nome
    "occupation": "ADVOGADA", //Ocupação
    "address": {
        "addressName": "Rua Antônio Marco Pazote", //Endereço
        "zipCode": "13737-005", //CEP
        "city": "Mococa", //Cidade
        "uf": "SP", //Estado
        "district": "Jardim Colina Verde", //Bairro
        "number": "169", //Número
        "complement": "N/A" //Complemento
    },
    //Contas bancárias: é necessário enviar pelo menos uma conta bancária em nome do tomador, para o pagamento da operação
    //Abaixo está um exemplo de envio de PIX e um exemplo de envio de dados bancários para TED
    "bankAccounts": [ 
        {
            "operationTypeValue": "Pix", //Tipo de operação PIX
            "pixKeyTypeValue": "NaturalRegistrationNumber", //Tipo de chave: NaturalRegistrationNumber (CPF), Phone (Telefone), Email, Automatic (chave aletória gerada pelo banco)
            "keyPix": "00805349960" //Chave PIX
        },
        {
            "operationTypeValue": "Transfer", //Tipo de operação Transferência
            "account": 1234567, //Número da conta
            "agency": "1234", //Número da agência (sem dígito)
            "type": "NaturalCheckingAccount", //Tipo de conta: NaturalCheckingAccount (Conta Corrente de Pessoa Física), NaturalSavingsAccount (Poupança de Pessoa Física)
            "bankCode": "1", //Código do banco
            "accountDigit": "0" //Dígito da conta
        }
    ]
}'
Example Response
401 UNAUTHORIZED
No response body
This request doesn't return any response body
Content-Length
0
Date
Wed, 22 Nov 2023 14:11:48 GMT
Server
Kestrel
WWW-Authenticate
Bearer
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70

GET Listar Pessoas

https://web-credit-api.azurewebsites.net/v1/NaturalPerson?searchString=&registrationNumber=&phone=&filterByOwner=&filterByOwnerGroup=&personDisplay=

AUTHORIZATION Bearer Token
Token
PARAMS
searchString
Pesquisa Geral
registrationNumber
Pesquisa por CPF
phone
Pesquisa por Telefone
filterByOwner
Pesquisa por Usuário
filterByOwnerGroup
Pesquisa por Grupo de Usuário
personDisplay
Pesquisa por Nome
Example Request
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson?searchString=NILCE&registrationNumber=00805349960&phone=12980546587&filterByOwner=&filterByOwnerGroup=&personDisplay=NILCE'
Example Response
200 OK
				
					{
  "page": 0,
  "totalPages": 1,
  "totalItems": 1,
  "data": [
    {
      "registrationNumber": "00805349960",
      "name": "NILCE GARBELINI KNUPP",
      "nationality": "Brasileira",
      "pep": null,
      "address": null,
      "birthDate": "1985-04-03T00:00:00-03:00",
      "civilStatus": "Single",
      "civilStatusDisplay": "Solteiro",
      "gender": null,
      "genderDisplay": null,
      "documentType": null,
      "documentTypeDisplay": null,
      "documentNumber": null,
      "documentIssuer": null,
      "documentDate": null,
      "documentExpiration": null,
      "phone": "12980546587",
      "phoneExtension": null,
      "phone2": null,
      "phone2Extension": null,
      "email": "nilce.knupp@geradornv.com.br",
      "mothersName": null,
      "fathersName": null,
      "placeOfBirthCountry": null,
      "placeOfBirthState": null,
      "typeOfResidence": null,
      "typeOfResidenceDisplay": null,
      "hasDependents": false,
      "totalDependents": 0,
      "between7And15YearsOld": null,
      "upTo6YearsOld": null,
      "over15YearsOld": null,
      "workplace": null,
      "workplaceDisplay": null,
      "workplaceCompanyRegistrationNumber": null,
      "employeeNumber": null,
      "occupation": "ADVOGADA",
      "natureOfOccupation": null,
      "natureOfOccupationDisplay": null,
      "commercialPhone": null,
      "commercialPhoneExtension": null,
      "netSalary": null,
      "otherIncome": null,
      "totalIncome": 0,
      "admissionDate": null,
      "commercialPhone2": null,
      "commercialPhone2Extension": null,
      "commercialAddress": null,
      "economicActivityCodeId": null,
      "economicActivityCode": null,
      "economicActivityCodeDisplay": null,
      "spouseIndividualRegistrationNumber": null,
      "spouseDocumentType": null,
      "spouseDocumentTypeDisplay": null,
      "spouseDocumentNumber": null,
      "spouseDocumentIssuer": null,
      "spouseDocumentDate": null,
      "spouseDocumentExpiration": null,
      "spouseName": null,
      "spouseWorkplace": null,
      "spouseOccupation": null,
      "spouseCommercialPhone": null,
      "spouseCommercialPhoneExtension": null,
      "spouseBirthDate": null,
      "spouseNetSalary": null,
      "spouseOtherIncome": null,
      "spouseTotalIncome": 0,
      "allowContactWhatsApp": null,
      "allowUpdatesWhatsApp": null,
      "assets": [],
      "uploads": [],
      "bankAccounts": [],
      "personCreditStatus": null,
      "riskRating": "Intermediary",
      "id": "311ae9b2-a751-4819-a9f0-6d839b373172",
      "createdAt": "2023-11-22T08:31:50.034512-03:00",
      "createdBy": {
        "userId": "5s20l0gphumn6fe5ntpqk79mus",
        "userIdDisplay": "chatbotApi",
        "tenantDisplay": "Chatbot UY3"
      },
      "tenant": "us-east-2_wt90UiqLA",
      "tenantDisplay": "Chatbot UY3",
      "updatedAt": "2023-11-22T08:31:50.034445-03:00",
      "updatedBy": null,
      "ownerUser": {
        "userId": "5s20l0gphumn6fe5ntpqk79mus",
        "userIdDisplay": "chatbotApi",
        "tenantDisplay": "Chatbot UY3"
      },
      "ownerGroup": {
        "groupDisplay": "Todos",
        "tenantDisplay": "Chatbot UY3"
      }
    }
  ],
  "paginationToken": null
}
Content-Length
2431
Content-Type
application/json; charset=utf-8
Date
Wed, 22 Nov 2023 14:05:48 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
X-Rate-Limit-Limit
10s
X-Rate-Limit-Remaining
49
X-Rate-Limit-Reset
2023-11-22T14:05:50.0000000Z
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson' \
--data-raw '{
    "registrationNumber": null, //CPF da pessoa
    "civilStatus": "Single", //Estado civil: Married (Casado), Widowed (Viúvo), Separated (Separado), Divorced (Divorciado), Single (Solteiro)
    "birthDate": "1985-04-03T03:00:00.000Z", //Data de nascimento
    "nationality": "Brasileira", //Nacionalidade
    "email": "nilce.knupp@geradornv.com.br", //E-mail
    "phone": "12980546587", //Número de Telefone principal (Celular)
    "name": "NILCE GARBELINI KNUPP", //Nome
    "occupation": "ADVOGADA", //Ocupação
    "address": {
        "addressName": "Rua Antônio Marco Pazote", //Endereço
        "zipCode": "13737-005", //CEP
        "city": "Mococa", //Cidade
        "uf": "SP", //Estado
        "district": "Jardim Colina Verde", //Bairro
        "number": "169", //Número
        "complement": "N/A" //Complemento
    },
    //Contas bancárias: é necessário enviar pelo menos uma conta bancária em nome do tomador, para o pagamento da operação
    //Abaixo está um exemplo de envio de PIX e um exemplo de envio de dados bancários para TED
    "bankAccounts": [ 
        {
            "operationTypeValue": "Pix", //Tipo de operação PIX
            "pixKeyTypeValue": "NaturalRegistrationNumber", //Tipo de chave: NaturalRegistrationNumber (CPF), Phone (Telefone), Email, Automatic (chave aletória gerada pelo banco)
            "keyPix": "00805349960" //Chave PIX
        },
        {
            "operationTypeValue": "Transfer", //Tipo de operação Transferência
            "account": 1234567, //Número da conta
            "agency": "1234", //Número da agência (sem dígito)
            "type": "NaturalCheckingAccount", //Tipo de conta: NaturalCheckingAccount (Conta Corrente de Pessoa Física), NaturalSavingsAccount (Poupança de Pessoa Física)
            "bankCode": "1", //Código do banco
            "accountDigit": "0" //Dígito da conta
        }
    ]
}'
Example Response
401 UNAUTHORIZED
No response body
This request doesn't return any response body
Content-Length
0
Date
Wed, 22 Nov 2023 14:11:48 GMT
Server
Kestrel
WWW-Authenticate
Bearer
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70

GET Listar Pessoas por ID

https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172

AUTHORIZATION Bearer Token
Token
Example Request
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172'
Example Response
200 OK
				
					{
  "registrationNumber": "00805349960",
  "name": "NILCE GARBELINI KNUPP",
  "nationality": "Brasileira",
  "pep": null,
  "address": {
    "addressName": "Rua Antônio Marco Pazote",
    "zipCode": "13737-005",
    "city": "Mococa",
    "uf": "SP",
    "ufDisplay": "São Paulo",
    "district": "Jardim Colina Verde",
    "number": "169",
    "complement": "N/A"
  },
  "birthDate": "1985-04-03T00:00:00-03:00",
  "civilStatus": "Single",
  "civilStatusDisplay": "Solteiro",
  "gender": null,
  "genderDisplay": null,
  "documentType": null,
  "documentTypeDisplay": null,
  "documentNumber": null,
  "documentIssuer": null,
  "documentDate": null,
  "documentExpiration": null,
  "phone": "12980546587",
  "phoneExtension": null,
  "phone2": null,
  "phone2Extension": null,
  "email": "nilce.knupp@geradornv.com.br",
  "mothersName": null,
  "fathersName": null,
  "placeOfBirthCountry": null,
  "placeOfBirthState": null,
  "typeOfResidence": null,
  "typeOfResidenceDisplay": null,
  "hasDependents": false,
  "totalDependents": 0,
  "between7And15YearsOld": null,
  "upTo6YearsOld": null,
  "over15YearsOld": null,
  "workplace": null,
  "workplaceDisplay": null,
  "workplaceCompanyRegistrationNumber": null,
  "employeeNumber": null,
  "occupation": "ADVOGADA",
  "natureOfOccupation": null,
  "natureOfOccupationDisplay": null,
  "commercialPhone": null,
  "commercialPhoneExtension": null,
  "netSalary": null,
  "otherIncome": null,
  "totalIncome": 0,
  "admissionDate": null,
  "commercialPhone2": null,
  "commercialPhone2Extension": null,
  "commercialAddress": null,
  "economicActivityCodeId": null,
  "economicActivityCode": null,
  "economicActivityCodeDisplay": null,
  "spouseIndividualRegistrationNumber": null,
  "spouseDocumentType": null,
  "spouseDocumentTypeDisplay": null,
  "spouseDocumentNumber": null,
  "spouseDocumentIssuer": null,
  "spouseDocumentDate": null,
  "spouseDocumentExpiration": null,
  "spouseName": null,
  "spouseWorkplace": null,
  "spouseOccupation": null,
  "spouseCommercialPhone": null,
  "spouseCommercialPhoneExtension": null,
  "spouseBirthDate": null,
  "spouseNetSalary": null,
  "spouseOtherIncome": null,
  "spouseTotalIncome": 0,
  "allowContactWhatsApp": null,
  "allowUpdatesWhatsApp": null,
  "assets": [],
  "uploads": [],
  "bankAccounts": [
    {
      "bankCode": "1",
      "bankCodeCompe": 1,
      "bankCodeDisplay": "BCO DO BRASIL S.A.",
      "bankIspb": 0,
      "account": "1234567",
      "accountDigit": "0",
      "agency": "1234",
      "agencyDigit": null,
      "type": "LegalCheckingAccount",
      "typeDisplay": "Conta Corrente",
      "jointAccount": false,
      "operationTypeValue": "Transfer",
      "pixKeyTypeValue": null,
      "keyPix": null,
      "id": "bdd7f023-25f0-4fc3-be79-a5a492de1e1c",
      "createdAt": "2023-11-22T08:31:50.034509-03:00",
      "createdBy": {
        "userId": "5s20l0gphumn6fe5ntpqk79mus",
        "userIdDisplay": "chatbotApi",
        "tenantDisplay": "Chatbot UY3"
      },
      "tenant": "us-east-2_wt90UiqLA",
      "tenantDisplay": "Chatbot UY3",
      "updatedAt": "2023-11-22T08:31:50.034507-03:00",
      "updatedBy": null,
      "ownerUser": {
        "userId": "5s20l0gphumn6fe5ntpqk79mus",
        "userIdDisplay": "chatbotApi",
        "tenantDisplay": "Chatbot UY3"
      },
      "ownerGroup": {
        "groupDisplay": "Todos",
        "tenantDisplay": "Chatbot UY3"
      }
    },
    {
      "bankCode": "0",
      "bankCodeCompe": 0,
      "bankCodeDisplay": null,
      "bankIspb": null,
      "account": null,
      "accountDigit": null,
      "agency": null,
      "agencyDigit": null,
      "type": null,
      "typeDisplay": null,
      "jointAccount": false,
      "operationTypeValue": "Pix",
      "pixKeyTypeValue": "NaturalRegistrationNumber",
      "keyPix": "00805349960",
      "id": "5ebb2924-9849-4d6b-a694-6fa0160f4539",
      "createdAt": "2023-11-22T08:31:50.034506-03:00",
      "createdBy": {
        "userId": "5s20l0gphumn6fe5ntpqk79mus",
        "userIdDisplay": "chatbotApi",
        "tenantDisplay": "Chatbot UY3"
      },
      "tenant": "us-east-2_wt90UiqLA",
      "tenantDisplay": "Chatbot UY3",
      "updatedAt": "2023-11-22T08:31:50.034497-03:00",
      "updatedBy": null,
      "ownerUser": {
        "userId": "5s20l0gphumn6fe5ntpqk79mus",
        "userIdDisplay": "chatbotApi",
        "tenantDisplay": "Chatbot UY3"
      },
      "ownerGroup": {
        "groupDisplay": "Todos",
        "tenantDisplay": "Chatbot UY3"
      }
    }
  ],
  "personCreditStatus": null,
  "riskRating": "Intermediary",
  "id": "311ae9b2-a751-4819-a9f0-6d839b373172",
  "createdAt": "2023-11-22T08:31:50.034512-03:00",
  "createdBy": {
    "userId": "5s20l0gphumn6fe5ntpqk79mus",
    "userIdDisplay": "chatbotApi",
    "tenantDisplay": "Chatbot UY3"
  },
  "tenant": "us-east-2_wt90UiqLA",
  "tenantDisplay": "Chatbot UY3",
  "updatedAt": "2023-11-22T08:31:50.034445-03:00",
  "updatedBy": null,
  "ownerUser": {
    "userId": "5s20l0gphumn6fe5ntpqk79mus",
    "userIdDisplay": "chatbotApi",
    "tenantDisplay": "Chatbot UY3"
  },
  "ownerGroup": {
    "groupDisplay": "Todos",
    "tenantDisplay": "Chatbot UY3"
  }
}
Content-Length
4150
Content-Type
application/json;charset=UTF-8
Date
Wed, 22 Nov 2023 14:09:03 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
X-Rate-Limit-Limit
10s
X-Rate-Limit-Remaining
49
X-Rate-Limit-Reset
2023-11-22T14:09:10.0000000Z
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172'
Example Response
401 UNAUTHORIZED
No response body
This request doesn't return any response body
Content-Length
0
Date
Wed, 22 Nov 2023 14:08:47 GMT
Server
Kestrel
WWW-Authenticate
Bearer
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373173'
Example Response
403 FORBIDDEN
				
					{
  "code": "RECORD_NOT_EXISTS_OR_MISSING_PERMISSION",
  "message": "Acesso negado. Registro não existe ou você não possui o nível de permissão necessário para acessá-lo",
  "details": {
    "resourceId": "311ae9b2-a751-4819-a9f0-6d839b373173",
    "permissionType": "Read",
    "resource": "NaturalPerson"
  },
  "correlationId": "#599d909639000f22e0f9830b26b0a401"
}
Content-Length
337
Content-Type
application/json; charset=utf-8
Date
Wed, 22 Nov 2023 14:09:21 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
X-Rate-Limit-Limit
10s
X-Rate-Limit-Remaining
49
X-Rate-Limit-Reset
2023-11-22T14:09:30.0000000Z

POST Inserir Dado Bancário

https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172/BankAccount

AUTHORIZATION Bearer Token
Token
Body raw (json)
				
					[
    {
        "operationTypeValue": "Pix", //Tipo de operação PIX
        "pixKeyTypeValue": "Phone", //Tipo de chave: NaturalRegistrationNumber (CPF), Phone (Telefone), Email, Automatic (chave aletória gerada pelo banco)
        "keyPix": "12980546587" //Chave PIX
    },
    {
        "operationTypeValue": "Transfer", //Tipo de operação Transferência
        "account": 9877898, //Número da conta
        "agency": "0001",  //Número da agência (sem dígito)
        "type": "NaturalCheckingAccount", //Tipo de conta: NaturalCheckingAccount (Conta Corrente de Pessoa Física), NaturalSavingsAccount (Poupança de Pessoa Física)
        "bankCode": "457", //Código do banco
        "accountDigit": null  //Dígito da conta
    }
]
Example Request
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172/BankAccount' \
--data '[
    {
        "operationTypeValue": "Pix", //Tipo de operação PIX
        "pixKeyTypeValue": "Phone", //Tipo de chave: NaturalRegistrationNumber (CPF), Phone (Telefone), Email, Automatic (chave aletória gerada pelo banco)
        "keyPix": "12980546587" //Chave PIX
    },
    {
        "operationTypeValue": "Transfer", //Tipo de operação Transferência
        "account": 9877898, //Número da conta
        "agency": "0001",  //Número da agência (sem dígito)
        "type": "NaturalCheckingAccount", //Tipo de conta: NaturalCheckingAccount (Conta Corrente de Pessoa Física), NaturalSavingsAccount (Poupança de Pessoa Física)
        "bankCode": "457", //Código do banco
        "accountDigit": null  //Dígito da conta
    }
]'
Example Response
200 OK
				
					[
    "14cdba56-2a51-410a-9084-3573bd74871b", //Identificador das contas inseridas
    "da968eee-a3c7-4fe7-80f9-5f5e9999afe7"
]
Content-Length
79
Content-Type
application/json;charset=UTF-8
Date
Wed, 22 Nov 2023 14:27:17 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location --request POST 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172/BankAccount'
Example Response
401 UNAUTHORIZED
No response body
This request doesn't return any response body
Content-Length
0
Date
Wed, 22 Nov 2023 14:21:39 GMT
Server
Kestrel
WWW-Authenticate
Bearer
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172/BankAccount' \
--data '[
    {
        
    }
]'
Example Response
400 BAD REQUEST
				
					{
  "code": "INVALID_FORM",
  "message": "Não foi possível validar os dados do formulário",
  "details": {
    "formErrors": [
      {
        "message": "Requerido para tipo de Operação 'Transferência'",
        "key": "[0].Type"
      }
    ]
  }
}
Content-Length
195
Content-Type
application/json; charset=utf-8
Date
Wed, 22 Nov 2023 14:22:38 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70

PUT Atualizar Dado Bancário

https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172/BankAccount/14cdba56-2a51-410a-9084-3573bd74871b

AUTHORIZATION Bearer Token
Token
Body raw (json)
				
					{
    "operationTypeValue": "Pix", //Tipo de operação PIX
    "pixKeyTypeValue": "Phone", //Tipo de chave: NaturalRegistrationNumber (CPF), Phone (Telefone), Email, Automatic (chave aletória gerada pelo banco)
    "keyPix": "12980546587" //Chave PIX
}
Example Request
				
					curl --location --request PUT 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172/BankAccount/14cdba56-2a51-410a-9084-3573bd74871b' \
--data '{
    "operationTypeValue": "Pix", //Tipo de operação PIX
    "pixKeyTypeValue": "Phone", //Tipo de chave: NaturalRegistrationNumber (CPF), Phone (Telefone), Email, Automatic (chave aletória gerada pelo banco)
    "keyPix": "12980546587" //Chave PIX
}'
Example Response
204 NO CONTENT
No response body
This request doesn't return any response body
Date
Wed, 22 Nov 2023 14:30:55 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location --request PUT 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172/BankAccount/14cdba56-2a51-410a-9084-3573bd74871b'
Example Response
401 UNAUTHORIZED
No response body
This request doesn't return any response body
Content-Length
0
Date
Wed, 22 Nov 2023 14:29:04 GMT
Server
Kestrel
WWW-Authenticate
Bearer
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location --request PUT 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172/BankAccount/14cdba56-2a51-410a-9084-3573bd74871b' \
--data '{
    
}'
Example Response
400 BAD REQUEST
				
					{
  "code": "INVALID_FORM",
  "message": "Não foi possível validar os dados do formulário",
  "details": {
    "formErrors": [
      {
        "message": "Requerido para tipo de Operação 'Transferência'",
        "key": "Type"
      }
    ]
  }
}
Content-Length
191
Content-Type
application/json; charset=utf-8
Date
Wed, 22 Nov 2023 14:29:36 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70

DELETE Dado Bancário

https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172/BankAccount/14cdba56-2a51-410a-9084-3573bd74871b

AUTHORIZATION Bearer Token
Token
Example Request
				
					curl --location --request DELETE 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172/BankAccount/14cdba56-2a51-410a-9084-3573bd74871b'
Example Response
204 NO CONTENT
No response body
This request doesn't return any response body
Date
Wed, 22 Nov 2023 14:32:59 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
X-Rate-Limit-Limit
10s
X-Rate-Limit-Remaining
49
X-Rate-Limit-Reset
2023-11-22T14:33:00.0000000Z
				
					curl --location --request DELETE 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172/BankAccount/14cdba56-2a51-410a-9084-3573bd74871b'
Example Response
401 UNAUTHORIZED
No response body
This request doesn't return any response body
Content-Length
0
Date
Wed, 22 Nov 2023 14:32:45 GMT
Server
Kestrel
WWW-Authenticate
Bearer
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70

4.0 - Operação de Crédito

POST Inserir Operação de Crédito

https://web-credit-api.azurewebsites.net/v1/CreditNote

AUTHORIZATION Bearer Token
Token
Body raw (json)
				
					{
    "productId": "a3770bf5-fc8b-4668-ba54-4bfecd089b69", //Identificador do produto
    "personId": "311ae9b2-a751-4819-a9f0-6d839b373172", //Tomador: Identificador único da pessoa física
    "beneficiaryId": "311ae9b2-a751-4819-a9f0-6d839b373172", //Beneficiário: Mesmo identificador único de "personId"
    "bankAccountId": "5ebb2924-9849-4d6b-a694-6fa0160f4539", //Identificador único da conta bancária ou PIX da pessoa física
    "liquidationType": "EletronicTransfer", //Indica que a operação será paga eletronicamente
    "amortization": {
        "agentCommission": {
            "amount": 0, //Valor da comissão
            "type": "Percentage", //Absolute: Valor fixo por operação | Percentage: Valor percentual em relação ao valor da dívida
            "baseValue": "InitialValue" //InitialValue: Valor inicial da dívida | RequestedValue: Valor solicitado pelo tomador
        },
        "apr": 0.0204, //Taxa de juros
        "termInMonths": 10, //Quantidade de parcelas a serem antecipadas (no caso de FGTS, serão os anos antecipados)
        "startDate": "2023-11-22T03:00:00.000Z", //Data de início da operação (não é possível enviar data passada)
        "requestedAmount": 0, //Valor solicitado (para FGTS sempre será 0)
        "amortizationType": "fgts", //Tipo de amortização, sempre fixo
        "legalPerson": false //Indica que a operação é para pessoa física (para FGTS será sempre false)
    }
}
Example Request
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/CreditNote' \
--data '{
    "productId": "a3770bf5-fc8b-4668-ba54-4bfecd089b69", //Identificador do produto
    "personId": "311ae9b2-a751-4819-a9f0-6d839b373172", //Tomador: Identificador único da pessoa física
    "beneficiaryId": "311ae9b2-a751-4819-a9f0-6d839b373172", //Beneficiário: Mesmo identificador único de "personId"
    "bankAccountId": "5ebb2924-9849-4d6b-a694-6fa0160f4539", //Identificador único da conta bancária ou PIX da pessoa física
    "liquidationType": "EletronicTransfer", //Indica que a operação será paga eletronicamente
    "amortization": {
        "agentCommission": {
            "amount": 0, //Valor da comissão
            "type": "Percentage", //Absolute: Valor fixo por operação | Percentage: Valor percentual em relação ao valor da dívida
            "baseValue": "InitialValue" //InitialValue: Valor inicial da dívida | RequestedValue: Valor solicitado pelo tomador
        },
        "apr": 0.0204, //Taxa de juros
        "termInMonths": 10, //Quantidade de parcelas a serem antecipadas (no caso de FGTS, serão os anos antecipados)
        "startDate": "2023-11-22T03:00:00.000Z", //Data de início da operação (não é possível enviar data passada)
        "requestedAmount": 0, //Valor solicitado (para FGTS sempre será 0)
        "amortizationType": "fgts", //Tipo de amortização, sempre fixo
        "legalPerson": false //Indica que a operação é para pessoa física (para FGTS será sempre false)
    }
}'
Example Response
200 OK
				
					"7d69baf7-1f20-48bc-b1b5-9a2ca5620a65" //Identificador único da operação de crédito
Content-Length
38
Content-Type
application/json; charset=utf-8
Date
Wed, 22 Nov 2023 12:13:48 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/CreditNote' \
--data '{
    "productId": "a3770bf5-fc8b-4668-ba54-4bfecd089b61", //Identificador do produto
    "personId": "311ae9b2-a751-4819-a9f0-6d839b373172", //Tomador: Identificador único da pessoa física
    "beneficiaryId": "311ae9b2-a751-4819-a9f0-6d839b373172", //Beneficiário: Mesmo identificador único de "personId"
    "bankAccountId": "5ebb2924-9849-4d6b-a694-6fa0160f4539", //Identificador único da conta bancária ou PIX da pessoa física
    "liquidationType": "EletronicTransfer", //Indica que a operação será paga eletronicamente
    "amortization": {
        "agentCommission": {
            "amount": 0, //Valor da comissão
            "type": "Percentage", //Absolute: Valor fixo por operação | Percentage: Valor percentual em relação ao valor da dívida
            "baseValue": "InitialValue" //InitialValue: Valor inicial da dívida | RequestedValue: Valor solicitado pelo tomador
        },
        "apr": 0.0204, //Taxa de juros
        "termInMonths": 10, //Quantidade de parcelas a serem antecipadas (no caso de FGTS, serão os anos antecipados)
        "startDate": "2023-11-22T03:00:00.000Z", //Data de início da operação (não é possível enviar data passada)
        "requestedAmount": 0, //Valor solicitado (para FGTS sempre será 0)
        "amortizationType": "fgts", //Tipo de amortização, sempre fixo
        "legalPerson": false //Indica que a operação é para pessoa física (para FGTS será sempre false)
    }
}'
Example Response
400 BAD REQUEST
				
					{
  "code": "INVALID_FORM",
  "message": "Não foi possível validar os dados do formulário",
  "details": {
    "formErrors": [
      {
        "message": "Produto não encontrado",
        "key": "productId"
      },
      {
        "message": "Produto não encontrado",
        "key": "productId"
      }
    ]
  }
}
Content-Length
225
Content-Type
application/json; charset=utf-8
Date
Wed, 22 Nov 2023 12:15:17 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70

POST Enviar Operação de Crédito para Análise

https://web-credit-api.azurewebsites.net/v1/CreditNote/7d69baf7-1f20-48bc-b1b5-9a2ca5620a65/SubmitApproval

AUTHORIZATION Bearer Token
Token
Example Request
				
					curl --location --request POST 'https://web-credit-api.azurewebsites.net/v1/CreditNote/7d69baf7-1f20-48bc-b1b5-9a2ca5620a65/SubmitApproval'
Example Response
200 OK
No response body
This request doesn't return any response body
Content-Length
0
Date
Wed, 22 Nov 2023 14:42:54 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location --request POST 'https://web-credit-api.azurewebsites.net/v1/CreditNote/7d69baf7-1f20-48bc-b1b5-9a2ca5620a65/SubmitApproval'
Example Response
401 UNAUTHORIZED
No response body
This request doesn't return any response body
Content-Length
0
Date
Wed, 22 Nov 2023 14:36:30 GMT
Server
Kestrel
WWW-Authenticate
Bearer
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location --request DELETE 'https://web-credit-api.azurewebsites.net/v1/NaturalPerson/311ae9b2-a751-4819-a9f0-6d839b373172/BankAccount/14cdba56-2a51-410a-9084-3573bd74871b'
Example Response
400 BAD REQUEST
				
					{
  "code": "RECORD_IS_DELETED",
  "message": "A conta bancária selecionada foi excluída. Selecione outra conta para prosseguir.",
  "details": {
    "recordId": "5ebb2924-9849-4d6b-a694-6fa0160f4539"
  },
  "correlationId": "#2fe421e76a8d4e67e25437e4a22510cb"
}
Content-Length
238
Content-Type
application/json; charset=utf-8
Date
Wed, 22 Nov 2023 14:36:47 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location --request POST 'https://web-credit-api.azurewebsites.net/v1/CreditNote/7d69baf7-1f20-48bc-b1b5-9a2ca5620a65/SubmitApproval'
Example Response
400 BAD REQUEST
				
					{
  "code": "INVALID_FORM",
  "message": "Erro ao validar operação",
  "details": {
    "formErrors": [
      {
        "message": "Data de início não pode estar no passado",
        "key": "Amortization"
      }
    ]
  },
  "correlationId": "#a951257a4fb50b1efc4adbe763df648d"
}
Content-Length
219
Content-Type
application/json; charset=utf-8
Date
Wed, 22 Nov 2023 14:41:57 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70

POST Revisão de Pagamento

https://web-credit-api.azurewebsites.net/v1/CreditNote/e41f42ad-8360-4b46-96fe-2402079cb0d6/donePaymentRevision

AUTHORIZATION Bearer Token
Token
Body raw (json)
				
					{
    "bankAccount": {
        "bankCode": "33",
        "account": "123456789",
        "agency": "1234",
        "type": "NaturalCheckingAccount",
        "jointAccount": false,
        "operationTypeValue": "Transfer"
    }
}
Example Request
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/CreditNote/e41f42ad-8360-4b46-96fe-2402079cb0d6/donePaymentRevision' \
--data '{
    "bankAccount": {
        "bankCode": "33",
        "account": "123456789",
        "agency": "1234",
        "type": "NaturalCheckingAccount",
        "jointAccount": false,
        "operationTypeValue": "Transfer"
    }
}'
Example Response
403 FORBIDDEN
				
					{
  "code": "RECORD_NOT_EXISTS_OR_MISSING_PERMISSION",
  "message": "Acesso negado. Registro não existe ou você não possui o nível de permissão necessário para acessá-lo",
  "details": {
    "resourceId": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "permissionType": "LiquidationPaymentRevision",
    "resource": "CreditNote"
  },
  "correlationId": "#89bbff318d1c49cc24960874bfa9e6db"
}
Content-Length
356
Content-Type
application/json; charset=utf-8
Date
Mon, 27 Nov 2023 14:20:33 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70
				
					curl --location 'https://web-credit-api.azurewebsites.net/v1/CreditNote/e41f42ad-8360-4b46-96fe-2402079cb0d6/donePaymentRevision' \
--data '{
    "bankAccount": {
        "bankCode": "33",
        "account": "123456789",
        "agency": "1234",
        "type": "NaturalCheckingAccount",
        "jointAccount": false,
        "operationTypeValue": "Transfer"
    }
}'
Example Response
400 BAD REQUEST
				
					{
  "code": "INVALID_ACTION_FOR_STATUS",
  "message": "Ação permitida apenas para operações em 'Revisão de Pagamento'",
  "details": {
    "currentStatus": "Liquidation"
  },
  "correlationId": "#988f825b28817e9d7452328666a0be0b"
}
Content-Length
210
Content-Type
application/json; charset=utf-8
Date
Mon, 27 Nov 2023 14:24:26 GMT
Server
Kestrel
Request-Context
appId=cid-v1:fdab46e8-2370-457d-ae37-8d1ccae19e70

5.0 - Webhooks

POST Aprovação de Compliance

https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20

Body raw (json)
				
					{
    "eventCode": 2,
    "eventCodeDisplay": "Status da solicitação atualizado",
    "eventValue": 9,
    "eventValueDisplay": "Outros andamentos",
    "type": "CreditNoteOp",
    "typeDisplay": "Alteração de Status Operação de Crédito",
    "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "parameters": {
        "message": "Aprovação de Compliance.",
        "oldStatus": 0,
        "oldStatusDisplay": "Rascunho",
        "newStatus": 1,
        "newStatusDisplay": "Aprovação de Compliance"
    }
}
Example Request
				
					curl --location 'https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20' \
--data '{
    "eventCode": 2,
    "eventCodeDisplay": "Status da solicitação atualizado",
    "eventValue": 9,
    "eventValueDisplay": "Outros andamentos",
    "type": "CreditNoteOp",
    "typeDisplay": "Alteração de Status Operação de Crédito",
    "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "parameters": {
        "message": "Aprovação de Compliance.",
        "oldStatus": 0,
        "oldStatusDisplay": "Rascunho",
        "newStatus": 1,
        "newStatusDisplay": "Aprovação de Compliance"
    }
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POST Aprovação de Crédito

https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20

Body raw (json)
				
					{
    "eventCode": 2,
    "eventCodeDisplay": "Status da solicitação atualizado",
    "eventValue": 9,
    "eventValueDisplay": "Outros andamentos",
    "type": "CreditNoteOp",
    "typeDisplay": "Alteração de Status Operação de Crédito",
    "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "parameters": {
        "message": "Aprovação de Crédito.",
        "oldStatus": 1,
        "oldStatusDisplay": "Aprovação de Compliance",
        "newStatus": 8,
        "newStatusDisplay": "Aprovação de Crédito"
    }
}
Example Request
				
					curl --location 'https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20' \
--data '{
    "eventCode": 2,
    "eventCodeDisplay": "Status da solicitação atualizado",
    "eventValue": 9,
    "eventValueDisplay": "Outros andamentos",
    "type": "CreditNoteOp",
    "typeDisplay": "Alteração de Status Operação de Crédito",
    "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "parameters": {
        "message": "Aprovação de Crédito.",
        "oldStatus": 1,
        "oldStatusDisplay": "Aprovação de Compliance",
        "newStatus": 8,
        "newStatusDisplay": "Aprovação de Crédito"
    }
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POST Coleta de Assinatura

https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20

Body raw (json)
				
					{
      "eventCode": 2,
      "eventCodeDisplay": "Status da solicitação atualizado",
      "eventValue": 9,
      "eventValueDisplay": "Outros andamentos",
      "type": "CreditNoteOp",
      "typeDisplay": "Alteração de Status Operação de Crédito",
      "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
      "parameters": {
         "message": "Coleta de Assinaturas.",
         "oldStatus": 8,
         "oldStatusDisplay": "Aprovação de Crédito",
         "newStatus": 2,
         "newStatusDisplay": "Coleta de Assinaturas"
      }
   }
Example Request
				
					curl --location 'https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20' \
--data '{
      "eventCode": 2,
      "eventCodeDisplay": "Status da solicitação atualizado",
      "eventValue": 9,
      "eventValueDisplay": "Outros andamentos",
      "type": "CreditNoteOp",
      "typeDisplay": "Alteração de Status Operação de Crédito",
      "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
      "parameters": {
         "message": "Coleta de Assinaturas.",
         "oldStatus": 8,
         "oldStatusDisplay": "Aprovação de Crédito",
         "newStatus": 2,
         "newStatusDisplay": "Coleta de Assinaturas"
      }
   }'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POST Validação de Assinatura

https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20

Body raw (json)
				
					{
    "eventCode": 2,
    "eventCodeDisplay": "Status da solicitação atualizado",
    "eventValue": 9,
    "eventValueDisplay": "Outros andamentos",
    "type": "CreditNoteOp",
    "typeDisplay": "Alteração de Status Operação de Crédito",
    "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "parameters": {
        "message": "Coleta de assinaturas concluída com sucesso",
        "oldStatus": 2,
        "oldStatusDisplay": "Coleta de Assinaturas",
        "newStatus": 12,
        "newStatusDisplay": "Validação de Assinaturas"
    }
}
Example Request
				
					curl --location 'https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20' \
--data '{
    "eventCode": 2,
    "eventCodeDisplay": "Status da solicitação atualizado",
    "eventValue": 9,
    "eventValueDisplay": "Outros andamentos",
    "type": "CreditNoteOp",
    "typeDisplay": "Alteração de Status Operação de Crédito",
    "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "parameters": {
        "message": "Coleta de assinaturas concluída com sucesso",
        "oldStatus": 2,
        "oldStatusDisplay": "Coleta de Assinaturas",
        "newStatus": 12,
        "newStatusDisplay": "Validação de Assinaturas"
    }
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POST Liquidação

https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20

Body raw (json)
				
					{
    "eventCode": 2,
    "eventCodeDisplay": "Status da solicitação atualizado",
    "eventValue": 9,
    "eventValueDisplay": "Outros andamentos",
    "type": "CreditNoteOp",
    "typeDisplay": "Alteração de Status Operação de Crédito",
    "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "parameters": {
        "message": "Liquidação.",
        "oldStatus": 12,
        "oldStatusDisplay": "Validação de Assinaturas",
        "newStatus": 3,
        "newStatusDisplay": "Liquidação"
    }
}
Example Request
				
					curl --location 'https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20' \
--data '{
    "eventCode": 2,
    "eventCodeDisplay": "Status da solicitação atualizado",
    "eventValue": 9,
    "eventValueDisplay": "Outros andamentos",
    "type": "CreditNoteOp",
    "typeDisplay": "Alteração de Status Operação de Crédito",
    "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "parameters": {
        "message": "Liquidação.",
        "oldStatus": 12,
        "oldStatusDisplay": "Validação de Assinaturas",
        "newStatus": 3,
        "newStatusDisplay": "Liquidação"
    }
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POST Liquidação Manual

https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20

Body raw (json)
				
					{
    "eventCode": 2,
    "eventCodeDisplay": "Status da solicitação atualizado",
    "eventValue": 5,
    "eventValueDisplay": "Liquidação",
    "type": "CreditNoteOp",
    "typeDisplay": "Alteração de Status Operação de Crédito",
    "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "parameters": {
        "message": "Aguardando liquidação manual.",
        "oldStatus": 3,
        "oldStatusDisplay": "Liquidação",
        "newStatus": 14,
        "newStatusDisplay": "Liquidação Manual"
    }
}
Example Request
				
					curl --location 'https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20' \
--data '{
    "eventCode": 2,
    "eventCodeDisplay": "Status da solicitação atualizado",
    "eventValue": 5,
    "eventValueDisplay": "Liquidação",
    "type": "CreditNoteOp",
    "typeDisplay": "Alteração de Status Operação de Crédito",
    "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "parameters": {
        "message": "Aguardando liquidação manual.",
        "oldStatus": 3,
        "oldStatusDisplay": "Liquidação",
        "newStatus": 14,
        "newStatusDisplay": "Liquidação Manual"
    }
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POST Revisão de Pagamento

https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20

Body raw (json)
				
					{
    "eventCode": 2,
    "eventCodeDisplay": "Status da solicitação atualizado",
    "eventValue": 5,
    "eventValueDisplay": "Liquidação",
    "type": "CreditNoteOp",
    "typeDisplay": "Alteração de Status Operação de Crédito",
    "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "parameters": {
        "message": null,
        "oldStatus": 3,
        "oldStatusDisplay": "Liquidação",
        "newStatus": 13,
        "newStatusDisplay": "Revisão de Pagamento"
    }
}
Example Request
				
					curl --location 'https://webhook.site/ee40dbd5-490b-4423-8921-31afa12e3b20' \
--data '{
    "eventCode": 2,
    "eventCodeDisplay": "Status da solicitação atualizado",
    "eventValue": 5,
    "eventValueDisplay": "Liquidação",
    "type": "CreditNoteOp",
    "typeDisplay": "Alteração de Status Operação de Crédito",
    "id": "e41f42ad-8360-4b46-96fe-2402079cb0d6",
    "parameters": {
        "message": null,
        "oldStatus": 3,
        "oldStatusDisplay": "Liquidação",
        "newStatus": 13,
        "newStatusDisplay": "Revisão de Pagamento"
    }
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

Damos valor à sua privacidade

Nós e os nossos parceiros armazenamos ou acedemos a informações dos dispositivos, tais como cookies, e processamos dados pessoais, tais como identificadores exclusivos e informações padrão enviadas pelos dispositivos, para as finalidades descritas abaixo. Poderá clicar para consentir o processamento por nossa parte e pela parte dos nossos parceiros para tais finalidades. Em alternativa, poderá clicar para recusar o consentimento, ou aceder a informações mais pormenorizadas e alterar as suas preferências antes de dar consentimento. As suas preferências serão aplicadas apenas a este website.

Cookies estritamente necessários

Estes cookies são necessários para que o website funcione e não podem ser desligados nos nossos sistemas. Normalmente, eles só são configurados em resposta a ações levadas a cabo por si e que correspondem a uma solicitação de serviços, tais como definir as suas preferências de privacidade, iniciar sessão ou preencher formulários. Pode configurar o seu navegador para bloquear ou alertá-lo(a) sobre esses cookies, mas algumas partes do website não funcionarão. Estes cookies não armazenam qualquer informação pessoal identificável.

Cookies de desempenho

Estes cookies permitem-nos contar visitas e fontes de tráfego, para que possamos medir e melhorar o desempenho do nosso website. Eles ajudam-nos a saber quais são as páginas mais e menos populares e a ver como os visitantes se movimentam pelo website. Todas as informações recolhidas por estes cookies são agregadas e, por conseguinte, anónimas. Se não permitir estes cookies, não saberemos quando visitou o nosso site.

Cookies de funcionalidade

Estes cookies permitem que o site forneça uma funcionalidade e personalização melhoradas. Podem ser estabelecidos por nós ou por fornecedores externos cujos serviços adicionámos às nossas páginas. Se não permitir estes cookies algumas destas funcionalidades, ou mesmo todas, podem não atuar corretamente.

Cookies de publicidade

Estes cookies podem ser estabelecidos através do nosso site pelos nossos parceiros de publicidade. Podem ser usados por essas empresas para construir um perfil sobre os seus interesses e mostrar-lhe anúncios relevantes em outros websites. Eles não armazenam diretamente informações pessoais, mas são baseados na identificação exclusiva do seu navegador e dispositivo de internet. Se não permitir estes cookies, terá menos publicidade direcionada.