amortizationTypePriceCCB

Tipo de operação · Price

Price — Payload e campos

Quais campos envio em cada objeto.

Campos do cálculo

São 20 campos no total, 4 obrigatório(s), organizados da base comum até o que é exclusivo deste tipo. Só o que se aplica a ele aparece aqui.

Identificação, início e taxa

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`amortizationType`	`string`	opcional	Indica o tipo de tabela de amortização utilizada	—	`"texto"`
`startDate`	`string (date-time)`	opcional	Data de início	—	`"2025-08-11T13:45:00Z"`
`includePaymentFixedCosts`	`boolean`	opcional	Incluir valor da parcela fixa na simulação	—	`true`
`validationErrors`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`agentCommissions`	`array de objeto`	opcional	Comissões devidas ao CORBAN/Parceiro originador da operação. Utilizado para compor o Custo de Emissão (TAC), observados os limites estabelecidos no produto	objeto — ver detalhe abaixo	`[ … ]`
`agentCommission`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`

Valor, IOF e indexador

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`requestedAmount`	`integer (int64)`	opcional	Valor solicitado	—	`0`
`financeTaxExempted`	`boolean`	opcional	Isenção de IOF	—	`true`
`fiduciaryGuarantee`	`number (double)`	opcional	Percentual de Garantia fiduciária	—	`1000`
`indexer`	`string`	opcional	Indexador Pós-Fixado que deve ser aplicado à cada parcela	—	`"texto"`
`indexerValue`	`number (double)`	opcional	Percentual Indexador Pós-fixado que deve ser aplicado à cada parcela	—	`1000`

Forma de cálculo do valor

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`calculateByValueType`	`string`	opcional	—	`Gross`, `Liquid`, `Payment`	`"Gross"`

Cronograma por data da primeira parcela exclusivo deste tipo

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`firstPaymentDate`	`string (date-time)`	obrigatório	Data de início	—	`"2025-08-11T13:45:00Z"`
`numberOfPayments`	`integer`	obrigatório	Número de parcelas	—	`0`
`numberOfInterestPayments`	`integer`	opcional	Parcelas de pagamento de juros	—	`0`
`apr`	`number (double)`	opcional	Taxa de Juros em base mensal	—	`1.99`
`calculationType`	`string`	obrigatório	—	`V252DiasUteis`, `V252MesesX21`, `V360DiasCorridos`, `V360Meses`, `V365DiasCorridos`, `V365Meses`, `Irregular`	`"V252DiasUteis"`
`dueDateOnBusinessDays`	`boolean`	opcional	Datas de vencimento são ajustadas para o próximo dia útil	—	`true`
`paymentPeriodicity`	`objeto`	obrigatório	—	objeto — ver detalhe abaixo	`{ … }`

Regras e valores aceitos

Os campos abaixo aceitam um conjunto fechado de valores. A lista é a do contrato para este tipo — outros tipos podem aceitar conjuntos diferentes.

`calculateByValueType`

Valor	Significado
`Gross`	Valor bruto - O valor de principal informado será considerado o valor de face da dívida emitida, sem realizar o financiamento das tarifas (TACs e IOF). O valor líquido final será menor que o valor do principal.
`Liquid`	Valor líquido - O valor de principal informado será considerado o valor líquido final desejado pelo tomador. Para tanto, será realizado o financiamento das tarifas (TACs e IOF), majorando o valor de face da dívida emitida.
`Payment`	Valor da parcela - o valor da parcela que será pago pelo cliente em cada vencimento. Só é válido para cálculos do tipo PRICE

`calculationType`

Valor	Significado
`V252DiasUteis`	V252 Dias Uteis
`V252MesesX21`	V252 Meses X21
`V360DiasCorridos`	V360 Dias Corridos
`V360Meses`	V360 Meses
`V365DiasCorridos`	V365 Dias Corridos
`V365Meses`	V365 Meses
`Irregular`	Irregular

Exemplo de objeto de cálculo

Gerado do contrato. Valores são amostras: troque pelos dados reais da operação.

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amortizationType": "texto",
  "startDate": "2025-08-11T13:45:00Z",
  "apr": 1.99,
  "includePaymentFixedCosts": true,
  "validationErrors": [
    {
      "memberNames": [
        "Fulano de Tal"
      ],
      "errorMessage": "texto"
    }
  ],
  "agentCommissions": [
    {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true
    }
  ],
  "agentCommission": {
    "name": "Fulano de Tal",
    "amount": 1000,
    "type": "Absolute",
    "baseValue": "InitialValue",
    "chargeCommissionFrom": "All",
    "financeCost": true,
    "totalValue": 0
  },
  "requestedAmount": 0,
  "financeTaxExempted": true,
  "fiduciaryGuarantee": 1000,
  "indexer": "texto",
  "indexerValue": 1000,
  "calculateByValueType": "Gross",
  "firstPaymentDate": "2025-08-11T13:45:00Z",
  "numberOfPayments": 0,
  "numberOfInterestPayments": 0,
  "calculationType": "V252DiasUteis",
  "dueDateOnBusinessDays": true,
  "paymentPeriodicity": {
    "every": 0,
    "periodicity": "Monthly"
  }
}

Campos da garantia

A garantia vai na lista warranty do mesmo corpo de criação, ao lado do objeto de cálculo. Cada item leva o discriminador warrantyType, e uma operação pode ter mais de uma garantia.

Crédito do Trabalhador — `DataprevEmployee`

Consignado privado (crédito do trabalhador): margem consignável do vínculo empregatício, com dados do empregador, competência de início de desconto e autorização da CTPS digital. Pode incluir saldo e multa rescisória do FGTS como reforço de garantia.

Averbação: DataPrevCreditoTrabalhador. A operação passa pela etapa de garantia aguardando o retorno do órgão averbador antes de seguir na esteira.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Vínculo e valor da margem

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`employeeCode`	`string`	opcional	—	—	`"texto"`
`admissionDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`

Vínculo empregatício e margem consignável

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`dataprev_EmployeeCode`	`string`	obrigatório	Matrícula do trabalhador	—	`"texto"`
`dataprev_EmployerRegistrationCode`	`integer`	obrigatório	Código de inscrição do empregador	—	`0`
`dataprev_EmployerName`	`string`	obrigatório	Nome do empregador	—	`"Fulano de Tal"`
`dataprev_EmployerRegistrationNumber`	`string`	obrigatório	Número inscrição do Empregador	—	`"texto"`
`dataprev_DiscountStartPeriod`	`string`	obrigatório	Competência início de desconto	—	`"texto"`
`dataprev_OriginalMargin`	`number (double)`	opcional	Valor original da margem consignável	—	`1000`
`dataprev_EmployeePositionCBOCode`	`integer`	opcional	CBO - Classificação Brasileira de Ocupações	—	`0`
`dataprev_EmployeeAdmissionDate`	`string (date-time)`	obrigatório	Data de admissão do trabalhador	—	`"2025-08-11T13:45:00Z"`
`dataprev_HasWarranty`	`boolean`	opcional	Indica se o contrato utiliza garantias do FGTS (Solução de Garantias - Manual 003). Campo temGarantias.	—	`true`
`dataprev_WarrantyFgtsBalanceInCents`	`integer (int64)`	opcional	Saldo FGTS oferecido como garantia, em centavos. Campo valorSaldoDisponivelGarantiaFgts vem em reais (NÚMERO 10,2) e é convertido para centavos na escrita.	—	`0`
`dataprev_WarrantyFgtsRescissionPenaltyInCents`	`integer (int64)`	opcional	Multa rescisória FGTS oferecida como garantia, em centavos. Campo valorMultaRescisoriaGarantiaFgts vem em reais (NÚMERO 10,2) e é convertido para centavos na escrita.	—	`0`
`dataprev_WarrantyRescissionBenefitPercentage`	`number (double)`	opcional	Percentual da verba rescisória para garantia, até 35%. Campo percVerbaRescisoriaGarantia (NÚMERO 3,2).	—	`1.99`
`dataprev_CtpsDigitalAuthorizationNumber`	`string`	opcional	Número da autorização da CTPS Digital. Campo numeroAutorizacaoCtpsDigital.	—	`"texto"`
`dataprev_ProposalNumber`	`string`	opcional	Número da proposta do leilão (proposalNumber). Nulo em operações internas.	—	`"texto"`
`totalValue`	`number (double)`	obrigatório	Valor da margem	—	`1000`

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Consultas e ofertas próprias deste lastro

Use antes de criar a operação, para obter margem, ficha do bem ou ofertas elegíveis.

POST /v{version}/Amortization/DataprevEmployeeOffersCria um novo registro de Amortization.

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "employeeCode": "texto",
  "admissionDate": "2025-08-11T13:45:00Z",
  "totalValue": 1000,
  "dataprev_EmployeeCode": "texto",
  "dataprev_EmployerRegistrationCode": 0,
  "dataprev_EmployerName": "Fulano de Tal",
  "dataprev_EmployerRegistrationNumber": "texto",
  "dataprev_DiscountStartPeriod": "texto",
  "dataprev_OriginalMargin": 1000,
  "dataprev_EmployeePositionCBOCode": 0,
  "dataprev_EmployeeAdmissionDate": "2025-08-11T13:45:00Z",
  "dataprev_HasWarranty": true,
  "dataprev_WarrantyFgtsBalanceInCents": 0,
  "dataprev_WarrantyFgtsRescissionPenaltyInCents": 0,
  "dataprev_WarrantyRescissionBenefitPercentage": 1.99,
  "dataprev_CtpsDigitalAuthorizationNumber": "texto",
  "dataprev_ProposalNumber": "texto"
}

Abrir o guia deste produto

Crédito Trabalhador Refinanciamento — `DataprevEmployeeRefinance`

Refinanciamento do Consignado privado: mesma estrutura de margem e vínculo do contrato original, aplicada à substituição de contrato vigente.

Averbação: DataPrevCreditoTrabalhador. A operação passa pela etapa de garantia aguardando o retorno do órgão averbador antes de seguir na esteira.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Vínculo e valor da margem

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`employeeCode`	`string`	opcional	—	—	`"texto"`
`admissionDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`

Vínculo empregatício e margem consignável

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`dataprev_EmployeeCode`	`string`	obrigatório	Matrícula do trabalhador	—	`"texto"`
`dataprev_EmployerRegistrationCode`	`integer`	obrigatório	Código de inscrição do empregador	—	`0`
`dataprev_EmployerName`	`string`	obrigatório	Nome do empregador	—	`"Fulano de Tal"`
`dataprev_EmployerRegistrationNumber`	`string`	obrigatório	Número inscrição do Empregador	—	`"texto"`
`dataprev_DiscountStartPeriod`	`string`	obrigatório	Competência início de desconto	—	`"texto"`
`dataprev_OriginalMargin`	`number (double)`	opcional	Valor original da margem consignável	—	`1000`
`dataprev_EmployeePositionCBOCode`	`integer`	opcional	CBO - Classificação Brasileira de Ocupações	—	`0`
`dataprev_EmployeeAdmissionDate`	`string (date-time)`	obrigatório	Data de admissão do trabalhador	—	`"2025-08-11T13:45:00Z"`
`dataprev_HasWarranty`	`boolean`	opcional	Indica se o contrato utiliza garantias do FGTS (Solução de Garantias - Manual 003). Campo temGarantias.	—	`true`
`dataprev_WarrantyFgtsBalanceInCents`	`integer (int64)`	opcional	Saldo FGTS oferecido como garantia, em centavos. Campo valorSaldoDisponivelGarantiaFgts vem em reais (NÚMERO 10,2) e é convertido para centavos na escrita.	—	`0`
`dataprev_WarrantyFgtsRescissionPenaltyInCents`	`integer (int64)`	opcional	Multa rescisória FGTS oferecida como garantia, em centavos. Campo valorMultaRescisoriaGarantiaFgts vem em reais (NÚMERO 10,2) e é convertido para centavos na escrita.	—	`0`
`dataprev_WarrantyRescissionBenefitPercentage`	`number (double)`	opcional	Percentual da verba rescisória para garantia, até 35%. Campo percVerbaRescisoriaGarantia (NÚMERO 3,2).	—	`1.99`
`dataprev_CtpsDigitalAuthorizationNumber`	`string`	opcional	Número da autorização da CTPS Digital. Campo numeroAutorizacaoCtpsDigital.	—	`"texto"`
`dataprev_ProposalNumber`	`string`	opcional	Número da proposta do leilão (proposalNumber). Nulo em operações internas.	—	`"texto"`
`totalValue`	`number (double)`	obrigatório	Valor da margem	—	`1000`

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Consultas e ofertas próprias deste lastro

Use antes de criar a operação, para obter margem, ficha do bem ou ofertas elegíveis.

POST /v{version}/Amortization/DataprevEmployeeOffersCria um novo registro de Amortization.

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "employeeCode": "texto",
  "admissionDate": "2025-08-11T13:45:00Z",
  "totalValue": 1000,
  "dataprev_EmployeeCode": "texto",
  "dataprev_EmployerRegistrationCode": 0,
  "dataprev_EmployerName": "Fulano de Tal",
  "dataprev_EmployerRegistrationNumber": "texto",
  "dataprev_DiscountStartPeriod": "texto",
  "dataprev_OriginalMargin": 1000,
  "dataprev_EmployeePositionCBOCode": 0,
  "dataprev_EmployeeAdmissionDate": "2025-08-11T13:45:00Z",
  "dataprev_HasWarranty": true,
  "dataprev_WarrantyFgtsBalanceInCents": 0,
  "dataprev_WarrantyFgtsRescissionPenaltyInCents": 0,
  "dataprev_WarrantyRescissionBenefitPercentage": 1.99,
  "dataprev_CtpsDigitalAuthorizationNumber": "texto",
  "dataprev_ProposalNumber": "texto"
}

Abrir o guia deste produto

Consignado INSS — `DataprevInss`

INSS: margem consignável do benefício previdenciário. Traz número e espécie do benefício, conta de pagamento, margem disponível, prazo máximo e o resultado do crivo de elegibilidade.

Averbação: SemearInss. A operação passa pela etapa de garantia aguardando o retorno do órgão averbador antes de seguir na esteira.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Vínculo e valor da margem

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`employeeCode`	`string`	opcional	—	—	`"texto"`
`admissionDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`totalValue`	`number (double)`	opcional	Valor total	—	`1000`

Benefício INSS e margem

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`inss_RegistrationNumber`	`string`	opcional	CPF do beneficiário (11 dígitos).	—	`"texto"`
`inss_BenefitNumber`	`string`	opcional	Número do benefício (NB).	—	`"texto"`
`inss_Name`	`string`	opcional	Nome do beneficiário.	—	`"Fulano de Tal"`
`inss_BenefitType`	`string`	opcional	Espécie do benefício.	—	`"texto"`
`inss_BenefitTypeDescription`	`string`	opcional	Descrição da espécie do benefício.	—	`"texto"`
`inss_PaymentAccountType`	`string`	opcional	Tipo da conta bancária.	—	`"texto"`
`inss_PaymentAccountTypeDescription`	`string`	opcional	Descrição do tipo da conta bancária.	—	`"texto"`
`inss_PaymentBankCode`	`string`	opcional	Código do banco pagador.	—	`"texto"`
`inss_PaymentBankAgency`	`string`	opcional	Agência bancária.	—	`"texto"`
`inss_PaymentBankAccountNumber`	`string`	opcional	Número da conta bancária.	—	`"texto"`
`inss_AvailableMargin`	`number (double)`	opcional	Margem consignável disponível.	—	`1000`
`inss_OriginalMargin`	`number (double)`	opcional	Margem consignável original.	—	`1000`
`inss_MarginValue`	`number (double)`	opcional	Margem consignável utilizada na averbação.	—	`1000`
`inss_MaximumInstallments`	`integer`	opcional	Prazo máximo permitido.	—	`0`
`inss_IsIneligible`	`boolean`	opcional	Indica se o beneficiário é inelegível (resultado do crivo, vindo da consulta de margem).	—	`true`
`inss_IneligibilityReason`	`string`	opcional	Motivo da inelegibilidade do beneficiário.	—	`"texto"`

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Consultas e ofertas próprias deste lastro

Use antes de criar a operação, para obter margem, ficha do bem ou ofertas elegíveis.

POST /v{version}/Amortization/InssOffersCria um novo registro de Amortization.

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "employeeCode": "texto",
  "admissionDate": "2025-08-11T13:45:00Z",
  "totalValue": 1000,
  "inss_RegistrationNumber": "texto",
  "inss_BenefitNumber": "texto",
  "inss_Name": "Fulano de Tal",
  "inss_BenefitType": "texto",
  "inss_BenefitTypeDescription": "texto",
  "inss_PaymentAccountType": "texto",
  "inss_PaymentAccountTypeDescription": "texto",
  "inss_PaymentBankCode": "texto",
  "inss_PaymentBankAgency": "texto",
  "inss_PaymentBankAccountNumber": "texto",
  "inss_AvailableMargin": 1000,
  "inss_OriginalMargin": 1000,
  "inss_MarginValue": 1000,
  "inss_MaximumInstallments": 0,
  "inss_IsIneligible": true,
  "inss_IneligibilityReason": "texto"
}

Consignado Público — `PublicPayroll`

Consignado público: averbação da margem do servidor no órgão empregador. Traz matrícula, código do órgão, código de averbação, dia do repasse, situação funcional e prazo limite de averbação.

Averbação: Siape. A operação passa pela etapa de garantia aguardando o retorno do órgão averbador antes de seguir na esteira.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Averbação no órgão público

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`employeeCode`	`string`	opcional	Código da Matrícula	—	`"texto"`
`agreementCode`	`string`	opcional	Código do Convênio	—	`"texto"`
`governmentDepartmentCode`	`string`	opcional	Código do Orgão	—	`"texto"`
`employeerInstCode`	`string`	opcional	Órgão + Matrícula do Instituidor	—	`"texto"`
`warrantyCode`	`string`	opcional	Código de averbação	—	`"texto"`
`paymentTransferDay`	`integer`	opcional	Dia do repasse	—	`0`
`paymentAmountInCents`	`integer (int64)`	opcional	Valor da Margem	—	`0`
`employmentStatusCode`	`string`	opcional	Código do tipo da situação funcional do vínculo funcional	—	`"texto"`
`employmentStatusDescription`	`string`	opcional	Descrição do tipo da situação funcional do vínculo funcional	—	`"texto"`
`previousAdeNumber`	`string`	opcional	Número ADE anterior	—	`"texto"`
`warrantyDeadline`	`string (date-time)`	opcional	Data limite de averbação	—	`"2025-08-11T13:45:00Z"`
`warrantyOption`	`string`	opcional	—	`None`, `FreeMargin`, `Portability`, `Peculio`	`"None"`
`simulationRegistrationNumber`	`string`	opcional	—	—	`"texto"`
`termInMonths`	`integer`	opcional	Prazo	—	`0`
`adeIdentifier`	`string`	opcional	Ade identificador da operação na zetra	—	`"texto"`
`governmentDepartmentWarrantyStatus`	`string`	opcional	—	`WaitingPurchase`, `WaitingBalance`, `WaitingPayment`, `WaitingLiquidation`, `Finished`, `Error`, `Deleted`, `Unified`, `WaitingForApproval`, `WaitingForPortedContractClosure`, `ConsentRefused`, `Canceled`, `PaymentRejection`	`"WaitingPurchase"`
`governmentDepartmentWarrantyStatusDisplay`	`string`	opcional	Descrição da situação	—	`"texto"`
`payingSourceRegistrationNumber`	`string`	opcional	—	—	`"texto"`
`payingSourceName`	`string`	opcional	Nome da Fonte Pagadora	—	`"Fulano de Tal"`

`governmentDepartmentWarrantyStatus`

Valor	Significado
`WaitingPurchase`	Aguardando Compra do Contrato
`WaitingBalance`	Aguardando Informação Saldo Devedor
`WaitingPayment`	Aguardando Pagamento Saldo Devedor
`WaitingLiquidation`	Aguardando Liberação da Margem
`Finished`	Averbado
`Error`	Erro
`Deleted`	Excluído
`Unified`	Contrato unificado
`WaitingForApproval`	Aguardando Anuência
`WaitingForPortedContractClosure`	Aguardando Encerramento do Contrato Portado
`ConsentRefused`	Anuência Recusada
`Canceled`	Cancelado
`PaymentRejection`	Rejeição de Pagamento do Saldo Devedor

`warrantyOption`

Valor	Significado
`None`	Nenhum
`FreeMargin`	Margem Livre
`Portability`	Portabilidade
`Peculio`	Pecúlio

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "employeeCode": "texto",
  "agreementCode": "texto",
  "governmentDepartmentCode": "texto",
  "employeerInstCode": "texto",
  "warrantyCode": "texto",
  "paymentTransferDay": 0,
  "paymentAmountInCents": 0,
  "employmentStatusCode": "texto",
  "employmentStatusDescription": "texto",
  "previousAdeNumber": "texto",
  "warrantyDeadline": "2025-08-11T13:45:00Z",
  "warrantyOption": "None",
  "simulationRegistrationNumber": "texto",
  "termInMonths": 0,
  "adeIdentifier": "texto",
  "governmentDepartmentWarrantyStatus": "WaitingPurchase",
  "governmentDepartmentWarrantyStatusDisplay": "texto",
  "payingSourceRegistrationNumber": "texto",
  "payingSourceName": "Fulano de Tal"
}

Registro de Cartão de Benefício — `BenefitCardRegistration`

Cartão consig. saque: margem consignada no cartão, com código de averbação, valor da parcela e vigência da garantia.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Cartão de benefício

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`benefitCardMarginAmountInCents`	`integer (int64)`	opcional	Valor da margem disponível para consignação em centavos	—	`0`
`benefitCardEmployeeCode`	`string`	opcional	Código do colaborador/beneficiário do cartão de benefício	—	`"texto"`
`benefitCardStartDate`	`string (date-time)`	opcional	Data de início da vigência da garantia do cartão de benefício	—	`"2025-08-11T13:45:00Z"`
`benefitCardWarrantyCode`	`string`	opcional	Código de averbação da garantia (endorsment_code do payload BYX)	—	`"texto"`
`benefitCardCcbNumber`	`string`	opcional	Número do contrato/CCB informado pela esteira BYX (ccb_number do payload)	—	`"texto"`
`benefitCardInstallmentValueInCents`	`integer (int64)`	opcional	Valor da parcela em centavos (installment_value do payload BYX)	—	`0`

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "benefitCardMarginAmountInCents": 0,
  "benefitCardEmployeeCode": "texto",
  "benefitCardStartDate": "2025-08-11T13:45:00Z",
  "benefitCardWarrantyCode": "texto",
  "benefitCardCcbNumber": "texto",
  "benefitCardInstallmentValueInCents": 0
}

Veículo — `Vehicle`

Veículos (financiamento): o bem financiado é a garantia. Traz a ficha completa do veículo, o fornecedor/revenda, o valor de entrada e as UFs de emplacamento e de registro do gravame.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Dados do veículo financiado

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`renavam`	`string`	opcional	RENAVAM do Veículo	—	`"texto"`
`typeOfVehicle`	`string`	opcional	Tipo do Veículo	—	`"texto"`
`chassis`	`string`	opcional	Chassi do Veículo	—	`"texto"`
`board`	`string`	opcional	Placa do Veículo	—	`"texto"`
`supplier`	`string`	opcional	Fornecedor do Veículo	—	`"texto"`
`taxNumberOfSupplier`	`string`	opcional	CNPJ do Fornecedor	—	`"texto"`
`brand`	`string`	opcional	Marca do Veículo	—	`"texto"`
`color`	`string`	opcional	Cor do Veículo	—	`"texto"`
`model`	`string`	opcional	Modelo do Veículo	—	`"texto"`
`yearOfManufacture`	`integer`	opcional	Ano de Fabricação do Veículo	—	`0`
`yearOfModel`	`integer`	opcional	Ano de Modelo do Veículo	—	`0`
`typeOfFuel`	`string`	opcional	Tipo de Combustível do Veículo	—	`"texto"`
`downPayment`	`integer (int64)`	opcional	Valor de entrada	—	`0`
`sellerCompanyName`	`string`	opcional	Revenda	—	`"Fulano de Tal"`
`sellerRegistrationNumber`	`string`	opcional	CNPJ de quem efetuou a venda	—	`"texto"`
`valueInCash`	`integer (int64)`	opcional	Valor veículo à vista	—	`0`
`subtotalAmount`	`integer (int64)`	opcional	Subtotal (Veículo + acessórios + outras despesas incluídas na operação a pedido do consumidor)	—	`0`
`totalAmountFinancedTaxFree`	`integer (int64)`	opcional	Valor total a ser financiado sem impostos	—	`0`
`plateState`	`string`	opcional	UF de emplacamento do veículo (sigla, ex.: "MG"). Origem do siglaEstadoPlaca no registro do gravame.	—	`"texto"`
`operationState`	`string`	opcional	UF da operação / Detran de registro do gravame (sigla, ex.: "MG"). Origem do siglaEstadoOperacao.	—	`"texto"`

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Consultas e ofertas próprias deste lastro

Use antes de criar a operação, para obter margem, ficha do bem ou ofertas elegíveis.

POST /v{version}/Amortization/VehicleOffersCria um novo registro de Amortization.
POST /v{version}/Amortization/VehicleOffersWithoutLTVCria um novo registro de Amortization.
GET /v{version}/Amortization/VehicleBrandsLista e filtra registros de Amortization.
GET /v{version}/Amortization/VehicleModelsLista e filtra registros de Amortization.
GET /v{version}/Amortization/VehicleByPlate/{plate}Consulta Amortization pelo identificador informado na rota.

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "renavam": "texto",
  "typeOfVehicle": "texto",
  "chassis": "texto",
  "board": "texto",
  "supplier": "texto",
  "taxNumberOfSupplier": "texto",
  "brand": "texto",
  "color": "texto",
  "model": "texto",
  "yearOfManufacture": 0,
  "yearOfModel": 0,
  "typeOfFuel": "texto",
  "downPayment": 0,
  "sellerCompanyName": "Fulano de Tal",
  "sellerRegistrationNumber": "texto",
  "valueInCash": 0,
  "subtotalAmount": 0,
  "totalAmountFinancedTaxFree": 0,
  "plateState": "texto",
  "operationState": "texto"
}

Car Equity — `CarEquity`

Veículos (crédito com garantia do veículo): o veículo do tomador lastreia crédito novo. Exige ficha do veículo completa e acompanha o status da vistoria veicular; o registro do gravame roda dentro da etapa de garantia.

Averbação: CarEquity. A operação passa pela etapa de garantia aguardando o retorno do órgão averbador antes de seguir na esteira.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Dados do veículo e da vistoria

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`renavam`	`string`	obrigatório	RENAVAM do Veículo	—	`"texto"`
`typeOfVehicle`	`string`	obrigatório	Tipo do Veículo	—	`"texto"`
`chassis`	`string`	obrigatório	Chassi do Veículo	—	`"texto"`
`board`	`string`	obrigatório	Placa do Veículo	—	`"texto"`
`brand`	`string`	obrigatório	Marca do Veículo	—	`"texto"`
`color`	`string`	obrigatório	Cor do Veículo	—	`"texto"`
`model`	`string`	obrigatório	Modelo do Veículo	—	`"texto"`
`yearOfManufacture`	`integer`	obrigatório	Ano de Fabricação do Veículo	—	`0`
`yearOfModel`	`integer`	obrigatório	Ano de Modelo do Veículo	—	`0`
`typeOfFuel`	`string`	obrigatório	Tipo de Combustível do Veículo	—	`"texto"`
`inspectionId`	`string`	opcional	Id da Vistoria Veicular	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`inspectionStatus`	`string`	opcional	—	`WAITING_SOLICITATIONS`, `WAITING_FOR_ANALYSIS_OF_INITIAL_INFORMATION`, `WAITING_FOR_INITIAL_API_QUERIES`, `WAITING_FOR_SCHEDULE`, `WAITING_FOR_ANALYSIS_OF_RECEIVED_INFORMATION`, `WAITING_FOR_ADDITIONAL_SOLICITATIONS`, `WAITING_FOR_RISK_ANALYSIS_API_QUERIES`, `WAITING_FOR_PROCESSING`, `PARTIALLY_RECEIVED`, `WAITING_FOR_RESCHEDULE`, `WAITING_FOR_RISK_ANALYSIS`, `WAITING_FOR_AUTOMATIC_ANALYSIS`, `APPROVED`, `DISAPPROVED` +8	`"WAITING_SOLICITATIONS"`
`inspectionUpdatedAt`	`string (date-time)`	opcional	Data Última Atualização da Vistoria Veicular	—	`"2025-08-11T13:45:00Z"`
`plateState`	`string`	opcional	UF de emplacamento do veículo (sigla, ex.: "MG"). Origem do siglaEstadoPlaca no registro do gravame.	—	`"texto"`
`operationState`	`string`	opcional	UF da operação / Detran de registro do gravame (sigla, ex.: "MG"). Origem do siglaEstadoOperacao.	—	`"texto"`

`inspectionStatus`

Valor	Significado
`WAITING_SOLICITATIONS`	WAITING_SOLICITATIONS
`WAITING_FOR_ANALYSIS_OF_INITIAL_INFORMATION`	WAITING_FOR_ANALYSIS_OF_INITIAL_INFORMATION
`WAITING_FOR_INITIAL_API_QUERIES`	WAITING_FOR_INITIAL_API_QUERIES
`WAITING_FOR_SCHEDULE`	WAITING_FOR_SCHEDULE
`WAITING_FOR_ANALYSIS_OF_RECEIVED_INFORMATION`	WAITING_FOR_ANALYSIS_OF_RECEIVED_INFORMATION
`WAITING_FOR_ADDITIONAL_SOLICITATIONS`	WAITING_FOR_ADDITIONAL_SOLICITATIONS
`WAITING_FOR_RISK_ANALYSIS_API_QUERIES`	WAITING_FOR_RISK_ANALYSIS_API_QUERIES
`WAITING_FOR_PROCESSING`	WAITING_FOR_PROCESSING
`PARTIALLY_RECEIVED`	PARTIALLY_RECEIVED
`WAITING_FOR_RESCHEDULE`	WAITING_FOR_RESCHEDULE
`WAITING_FOR_RISK_ANALYSIS`	WAITING_FOR_RISK_ANALYSIS
`WAITING_FOR_AUTOMATIC_ANALYSIS`	WAITING_FOR_AUTOMATIC_ANALYSIS
`APPROVED`	APPROVED
`DISAPPROVED`	DISAPPROVED
`SUBJECT_TO_ANALYSIS`	SUBJECT_TO_ANALYSIS
`CANCELED`	CANCELED
`OUT_OF_VALIDITY_DATE`	OUT_OF_VALIDITY_DATE
`WAITING_STATUS`	WAITING_STATUS
`UNDER_ANALYSIS`	UNDER_ANALYSIS
`OUT_OF_VALIDITY_DATE_WITHOUT_ANALYSIS`	OUT_OF_VALIDITY_DATE_WITHOUT_ANALYSIS
`PARTIALLY_RECEIVED_ADDITIONAL_SOLICITATIONS`	PARTIALLY_RECEIVED_ADDITIONAL_SOLICITATIONS
`WAITING_FOR_PROCESSING_ADDITIONAL_SOLICITATIONS`	WAITING_FOR_PROCESSING_ADDITIONAL_SOLICITATIONS

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Consultas e ofertas próprias deste lastro

Use antes de criar a operação, para obter margem, ficha do bem ou ofertas elegíveis.

POST /v{version}/Amortization/VehicleOffersCria um novo registro de Amortization.
GET /v{version}/Amortization/VehicleByPlate/{plate}Consulta Amortization pelo identificador informado na rota.

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "renavam": "texto",
  "typeOfVehicle": "texto",
  "chassis": "texto",
  "board": "texto",
  "brand": "texto",
  "color": "texto",
  "model": "texto",
  "yearOfManufacture": 0,
  "yearOfModel": 0,
  "typeOfFuel": "texto",
  "inspectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "inspectionStatus": "WAITING_SOLICITATIONS",
  "inspectionUpdatedAt": "2025-08-11T13:45:00Z",
  "plateState": "texto",
  "operationState": "texto"
}

Imóvel — `HomeEquity`

Imóvel em garantia (Home Equity): matrícula, cartório de registro, endereço, dimensões e valor do imóvel.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Dados do imóvel e da matrícula

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`registryOffice`	`string`	opcional	Cartório de Registro do Imóvel	—	`"texto"`
`registrationNumber`	`string`	opcional	Número de Matrícula do Imóvel	—	`"12345678909"`
`width`	`number (double)`	opcional	Largura do Imóvel	—	`1000`
`length`	`number (double)`	opcional	Comprimento do Imóvel	—	`1000`
`addressName`	`string`	opcional	Endereço do Imóvel	—	`"Fulano de Tal"`
`zipCodeAddress`	`string`	opcional	Código Postal do Imóvel	—	`"01310930"`
`city`	`string`	opcional	Cidade do Imóvel	—	`"texto"`
`uf`	`string`	opcional	—	`NaoSelecionado`, `AC`, `AL`, `AP`, `AM`, `BA`, `CE`, `DF`, `ES`, `GO`, `MA`, `MT`, `MS`, `MG` +14	`"NaoSelecionado"`
`district`	`string`	opcional	Distrito do Imóvel	—	`"texto"`
`addressNumber`	`string`	opcional	Número do Imóvel	—	`"texto"`
`complementAddress`	`string`	opcional	Complemento do Imóvel	—	`"texto"`
`propertyFeatures`	`string`	opcional	Características do Imóvel	—	`"texto"`
`propertyValue`	`integer (int64)`	opcional	Valor do imóvel	—	`0`

`uf`

Valor	Significado
`NaoSelecionado`	Nao Selecionado
`AC`	AC
`AL`	AL
`AP`	AP
`AM`	AM
`BA`	BA
`CE`	CE
`DF`	DF
`ES`	ES
`GO`	GO
`MA`	MA
`MT`	MT
`MS`	MS
`MG`	MG
`PA`	PA
`PB`	PB
`PR`	PR
`PE`	PE
`PI`	PI
`RJ`	RJ
`RN`	RN
`RS`	RS
`RO`	RO
`RR`	RR
`SC`	SC
`SP`	SP
`SE`	SE
`TO`	TO

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "registryOffice": "texto",
  "registrationNumber": "12345678909",
  "width": 1000,
  "length": 1000,
  "addressName": "Fulano de Tal",
  "zipCodeAddress": "01310930",
  "city": "texto",
  "uf": "NaoSelecionado",
  "district": "texto",
  "addressNumber": "texto",
  "complementAddress": "texto",
  "propertyFeatures": "texto",
  "propertyValue": 0
}

Consórcio — `Consortium`

Cota de consórcio em garantia: administradora, grupo e cota.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Dados da cota de consórcio

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`administratorName`	`string`	opcional	Nome do administrador	—	`"Fulano de Tal"`
`administratorRegistrationNumber`	`string`	opcional	CPF/CNPJ do adminstrador	—	`"texto"`
`quota`	`string`	opcional	Cota	—	`"texto"`
`group`	`string`	opcional	Grupo	—	`"texto"`

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "administratorName": "Fulano de Tal",
  "administratorRegistrationNumber": "texto",
  "quota": "texto",
  "group": "texto"
}

Processo Judicial — `JudiciaryProcess`

Processo judicial em garantia: número, vara, tipo, valor da causa e as partes.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Dados do processo

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`number`	`string`	opcional	Número do Processo	—	`"texto"`
`court`	`string`	opcional	Vara do Processo	—	`"texto"`
`valueOfCause`	`integer (int64)`	opcional	Valor da Causa do Processo	—	`0`
`claimant`	`string`	opcional	Reclamante do Processo	—	`"texto"`
`claimed`	`string`	opcional	Reclamado do Processo	—	`"texto"`
`typeOfProcess`	`string`	opcional	Tipo do Processo	—	`"texto"`

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "number": "texto",
  "court": "texto",
  "valueOfCause": 0,
  "claimant": "texto",
  "claimed": "texto",
  "typeOfProcess": "texto"
}

Carga — `Load`

Carga em garantia: mercadoria com NCM, conhecimento de embarque, fatura, valor em reais e apólice de seguro.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Dados da carga e do seguro

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`ncm`	`string`	opcional	Nomenclatura comum do mercosul (NCM)	—	`"texto"`
`blNumber`	`string`	opcional	Bill of lading - contrato de transporte (importação/exportação) de produtos entre embarcador e transportador	—	`"texto"`
`idInvoice`	`string`	opcional	Id da fatura	—	`"texto"`
`valueBRL`	`integer (int64)`	opcional	Valor do produto BRL (em código ISO 4217 do real brasileiro)	—	`0`
`policyNumber`	`string`	opcional	Numero Da Apolice	—	`"texto"`
`insuranceCompanyName`	`string`	opcional	Nome da Seguradora	—	`"Fulano de Tal"`
`insuranceCompanyCNPJ`	`string`	opcional	CNPJ da seguradora	—	`"12345678000199"`

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "ncm": "texto",
  "blNumber": "texto",
  "idInvoice": "texto",
  "valueBRL": 0,
  "policyNumber": "texto",
  "insuranceCompanyName": "Fulano de Tal",
  "insuranceCompanyCNPJ": "12345678000199"
}

Garantia — `Warranty`

Garantia genérica: registra apenas o tipo, sem campos específicos de bem ou margem. É o que se usa quando o lastro é descrito em texto livre no campo de garantia da operação.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty"
}

IntroduçãoO que é, quando usar e se exige garantia IntegraçãoComo integro, do zero à primeira operação Payload e camposQuais campos envio em cada objeto

Campos do cálculo

Identificação, início e taxa

Valor, IOF e indexador

Forma de cálculo do valor

Cronograma por data da primeira parcela exclusivo deste tipo

Regras e valores aceitos

calculateByValueType

calculationType

Exemplo de objeto de cálculo

Campos da garantia

Crédito do Trabalhador — DataprevEmployee

Tipo de garantia

Vínculo e valor da margem

Vínculo empregatício e margem consignável

warrantyType

Consultas e ofertas próprias deste lastro

Exemplo do objeto de garantia

Crédito Trabalhador Refinanciamento — DataprevEmployeeRefinance

Tipo de garantia

Vínculo e valor da margem

Vínculo empregatício e margem consignável

warrantyType

Consultas e ofertas próprias deste lastro

Exemplo do objeto de garantia

Consignado INSS — DataprevInss

Tipo de garantia

Vínculo e valor da margem

Benefício INSS e margem

warrantyType

Consultas e ofertas próprias deste lastro

Exemplo do objeto de garantia

Consignado Público — PublicPayroll

Tipo de garantia

Averbação no órgão público

governmentDepartmentWarrantyStatus

warrantyOption

warrantyType

Exemplo do objeto de garantia

Registro de Cartão de Benefício — BenefitCardRegistration

Tipo de garantia

Cartão de benefício

warrantyType

Exemplo do objeto de garantia

Veículo — Vehicle

Tipo de garantia

Dados do veículo financiado

warrantyType

Consultas e ofertas próprias deste lastro

Exemplo do objeto de garantia

Car Equity — CarEquity

Tipo de garantia

Dados do veículo e da vistoria

inspectionStatus

warrantyType

Consultas e ofertas próprias deste lastro

Exemplo do objeto de garantia

Imóvel — HomeEquity

Tipo de garantia

Dados do imóvel e da matrícula

uf

warrantyType

Exemplo do objeto de garantia

Consórcio — Consortium

Tipo de garantia

Dados da cota de consórcio

warrantyType

Exemplo do objeto de garantia

Processo Judicial — JudiciaryProcess

Tipo de garantia

Dados do processo

warrantyType

Exemplo do objeto de garantia

Carga — Load

Tipo de garantia

Dados da carga e do seguro

warrantyType

Exemplo do objeto de garantia

Garantia — Warranty

Tipo de garantia

warrantyType

`calculateByValueType`

`calculationType`

Crédito do Trabalhador — `DataprevEmployee`

`warrantyType`

Crédito Trabalhador Refinanciamento — `DataprevEmployeeRefinance`

`warrantyType`

Consignado INSS — `DataprevInss`

`warrantyType`

Consignado Público — `PublicPayroll`

`governmentDepartmentWarrantyStatus`

`warrantyOption`

`warrantyType`

Registro de Cartão de Benefício — `BenefitCardRegistration`

`warrantyType`

Veículo — `Vehicle`

`warrantyType`

Car Equity — `CarEquity`

`inspectionStatus`

`warrantyType`

Imóvel — `HomeEquity`

`uf`

`warrantyType`

Consórcio — `Consortium`

`warrantyType`

Processo Judicial — `JudiciaryProcess`

`warrantyType`

Carga — `Load`

`warrantyType`

Garantia — `Warranty`

`warrantyType`