---
title: "Criar uma garantia"
method: POST
path: "/warranty"
tags: ["Warranty"]
---

# Criar uma garantia

`POST /warranty`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/warranty`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://id.btgpactual.com/oauth2/token` scopes: `empresas.btgpactual.com/loans`

O objetivo dessa rota é criar uma garantia

## Request body

- object
  - `files` object[]
    - `name` string: Nome do arquivo com extensão
    - `type` 'TERMO_ENDOSSO' | 'COMPLEMENTO_AUXILIAR': Tipo de arquivo
    - `downloadUri` string: Link para download do arquivo
  - `warranties` object[]
    - `type` 'CesFidConta' | 'CesFidDirCred' | 'Vehicle' | 'AliFidImovel' | 'HipotecaImovel' | 'AliFidMercantil' | 'PenhorMercantil' | 'AliFidAgricola' | 'PenhorAgricola': Tipo de garantia
    - `acquisitionDate` string: Data de aquisição da garantia
    - `value` number: Valor total da garantia
    - `details` union
      - AccountFiduciaryAssignmentSchema
        - `currency` string: Moeda
        - `amount` number: Valor da garantia
        - `bankCode` string: Código do banco
        - `agency` string: Identificador da Agência
        - `account` string: Identificador da Conta
        - `isInternal` boolean: Identificador se é uma conta interna
        - `linkedAccount` boolean: Identificador se é uma conta vínculada
      - CreditRightFiduciaryAssignmentSchema
        - `description` string[]
        - `amount` number: Valor
        - `currency` string: Moeda
      - VehicleSchema
        - `Renavam` string: Número do renavam
        - `Chassi` string: Identificador do chassi
        - `LicensePlate` string: Placa
        - `Model` string: Modelo
        - `ModelYear` number: Ano Modelo
        - `ProductionYear` number: Ano de produção
        - `StateCode` string: Estado de compra do veículo
        - `Feeder` string: Tabela referência
        - `CodFeeder` string: Código da tabela
        - `ValueFeeder` number: Valor de tabela
        - `IsChassiRemarked` boolean: Identificador de chassi remarcado
        - `VehicleType` string: Tipo de veículo
        - `FundedMonths` number: Parcelas devidas
        - `IsZeroKilometer` boolean: Identificador se é veículo é zero quilometro
      - PropertyFiduciaryAssignmentSchema
        - `propertyRegistration` string: Número do registro do imóvel
        - `rgi` string: Número do RGI
        - `guaranteedPercentage` number: Percentual garantido
        - `amount` number: Valor da garantia
        - `marketValue` number: Valor de mercado
        - `zone` 'urban' | 'rural': Tipo de zona do imóvel
        - `georeferencing` boolean: Identificador se o imóvel está georreferenciado. Se verdadeiro, zona deve ser rural.
        - `type` 'house' | 'apartment' | 'land' | 'industrial' | 'farm' | 'other': Tipo do imóvel
        - `address` object: Dados de endereço do imóvel
          - `zipcode` string: Código postal
          - `number` integer: Número do endereço
          - `complement` string: Complemento do endereço
          - `state` string: Estado
          - `street` string: Nome da rua
          - `city` string: Nome da cidade
      - HipotecaImovelSchema
        - `grade` integer: Classificação ou nota atribuída ao imóvel
        - `propertyRegistration` string: Número do registro do imóvel
        - `rgi` string: Número do RGI
        - `guaranteedPercentage` number: Percentual garantido
        - `amount` number: Valor da garantia
        - `marketValue` number: Valor de mercado
        - `zone` 'urban' | 'rural': Tipo de zona do imóvel
        - `georeferencing` boolean: Identificador se o imóvel está georreferenciado. Se verdadeiro, zona deve ser rural.
        - `type` 'house' | 'apartment' | 'land' | 'industrial' | 'farm' | 'other': Tipo do imóvel
        - `address` object: Dados de endereço do imóvel
          - `zipcode` string: Código postal
          - `number` integer: Número do endereço
          - `complement` string: Complemento do endereço
          - `state` string: Estado
          - `street` string: Nome da rua
          - `city` string: Nome da cidade
      - AliFidMercantilSchema
        - `subProductType` 'Algodão em Pluma' | 'Açúcar Cristal' | 'Açúcar VHP' | 'Biodiesel' | 'Boi Gordo' | 'Café Arábica' | 'Café Robusta' | 'Etanol Anidro' | 'Etanol Hidratado' | 'Farelo de Soja' | 'Fertilizantes' | 'Milho Seco' | 'Soja em Grão' | 'Óleo de Soja': Tipo de subproduto
        - `monitoring` 'none' | 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'bimonthly' | 'quarterly' | 'semiannual' | 'annual': Frequência de monitoramento
        - `quantity` number: Quantidade do produto
        - `pu` number: Preço unitário
        - `unit` 'm³' | 'Litro' | 'Quilo (Kg)' | 'Sacas (50kg)' | 'Sacas (60kg)' | 'Tonelada' | 'Cabeça' | 'Caixa': Unidade de medida
        - `amount` number: Valor total. Deve ser maior que 0.
        - `priceSource` object: Fonte de preço do produto
          - `sourceName` string: Nome da fonte
          - `product` 'Algodão em Pluma' | 'Açúcar Cristal' | 'Açúcar VHP' | 'Biodiesel' | 'Boi Gordo' | 'Café Arábica' | 'Café Robusta' | 'Etanol Anidro' | 'Etanol Hidratado' | 'Farelo de Soja' | 'Fertilizantes' | 'Milho Seco' | 'Soja em Grão' | 'Óleo de Soja': Produto referenciado
          - `unit` 'm³' | 'Litro' | 'Quilo (Kg)' | 'Sacas (50kg)' | 'Sacas (60kg)' | 'Tonelada' | 'Cabeça' | 'Caixa': Unidade de medida do preço
          - `location` object: Local de origem do preço
            - `state` string: Estado
            - `city` string: Cidade
        - `storageLocation` object[]: Locais de armazenamento
          - `zipcode` string: Código postal
          - `number` integer: Número do endereço
          - `complement` string: Complemento do endereço
          - `state` string: Estado
          - `street` string: Nome da rua
          - `city` string: Nome da cidade
        - `harvestDate` string[]: Datas da safra. Devem ser informadas no formato "ano/proxAno"
        - `dueDiligence` 'in progress' | 'concluded' | 'waived': Status de due diligence
      - PenhorMercantilSchema
        - `subProductType` 'Algodão em Pluma' | 'Açúcar Cristal' | 'Açúcar VHP' | 'Biodiesel' | 'Boi Gordo' | 'Café Arábica' | 'Café Robusta' | 'Etanol Anidro' | 'Etanol Hidratado' | 'Farelo de Soja' | 'Fertilizantes' | 'Milho Seco' | 'Soja em Grão' | 'Óleo de Soja': Tipo de subproduto
        - `monitoring` 'none' | 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'bimonthly' | 'quarterly' | 'semiannual' | 'annual': Frequência de monitoramento
        - `quantity` number: Quantidade do produto
        - `pu` number: Preço unitário
        - `unit` 'm³' | 'Litro' | 'Quilo (Kg)' | 'Sacas (50kg)' | 'Sacas (60kg)' | 'Tonelada' | 'Cabeça' | 'Caixa': Unidade de medida
        - `amount` number: Valor total
        - `priceSource` object: Fonte de preço do produto
          - `sourceName` string: Nome da fonte
          - `product` 'Algodão em Pluma' | 'Açúcar Cristal' | 'Açúcar VHP' | 'Biodiesel' | 'Boi Gordo' | 'Café Arábica' | 'Café Robusta' | 'Etanol Anidro' | 'Etanol Hidratado' | 'Farelo de Soja' | 'Fertilizantes' | 'Milho Seco' | 'Soja em Grão' | 'Óleo de Soja': Produto referenciado
          - `unit` 'm³' | 'Litro' | 'Quilo (Kg)' | 'Sacas (50kg)' | 'Sacas (60kg)' | 'Tonelada' | 'Cabeça' | 'Caixa': Unidade de medida do preço
          - `location` object: Local de origem do preço
            - `state` string: Estado
            - `city` string: Cidade
        - `storageLocation` object[]: Locais de armazenamento
          - `zipcode` string: Código postal
          - `number` integer: Número do endereço
          - `complement` string: Complemento do endereço
          - `state` string: Estado
          - `street` string: Nome da rua
          - `city` string: Nome da cidade
        - `harvestDate` string[]: Datas da safra. Devem ser informadas no formato "ano/proxAno"
        - `dueDiligence` 'in progress' | 'concluded' | 'waived': Status de due diligence
      - AliFidAgricolaSchema
        - `productType` 'Boi' | 'Café' | 'Laranja' | 'Soja' | 'Milho' | 'Cana de Açúcar' | 'Madeira Pinus': Tipo de produto agrícola
        - `monitoring` 'none' | 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'bimonthly' | 'quarterly' | 'semiannual' | 'annual': Frequência de monitoramento
        - `pu` number: Preço unitário
        - `unit` 'm³' | 'Litro' | 'Quilo (Kg)' | 'Sacas (50kg)' | 'Sacas (60kg)' | 'Tonelada' | 'Cabeça' | 'Caixa': Unidade de medida
        - `priceSource` object: Fonte de preço do produto
          - `sourceName` string: Nome da fonte
          - `product` 'Boi' | 'Café' | 'Laranja' | 'Soja' | 'Milho' | 'Cana de Açúcar' | 'Madeira Pinus': Produto referenciado
          - `unit` 'm³' | 'Litro' | 'Quilo (Kg)' | 'Sacas (50kg)' | 'Sacas (60kg)' | 'Tonelada' | 'Cabeça' | 'Caixa': Unidade de medida do preço
          - `location` object: Local de origem do preço
            - `state` string: Estado
            - `city` string: Cidade
        - `quantity` number: Quantidade do produto
        - `priceATR` number: Preço ATR. Apenas caso o produto seja "Cana de Açúcar"
        - `priceATRSource` object: Fonte de preço por ATR. Apenas caso o produto seja "Cana de Açúcar"
          - `sourceName` string: Nome da fonte
          - `product` 'Boi' | 'Café' | 'Laranja' | 'Soja' | 'Milho' | 'Cana de Açúcar' | 'Madeira Pinus': Produto referenciado
          - `unit` 'm³' | 'Litro' | 'Quilo (Kg)' | 'Sacas (50kg)' | 'Sacas (60kg)' | 'Tonelada' | 'Cabeça' | 'Caixa': Unidade de medida do preço
          - `location` object: Local de origem do preço
            - `state` string: Estado
            - `city` string: Cidade
        - `dueDiligence` 'in progress' | 'concluded' | 'waived': Status de due diligence
        - `harvestDate` string[]: Datas da safra. Devem ser informadas no formato "ano/proxAno"
      - PenhorAgricolaSchema
        - `productType` 'Boi' | 'Café' | 'Laranja' | 'Soja' | 'Milho' | 'Cana de Açúcar' | 'Madeira Pinus': Tipo de produto agrícola
        - `monitoring` 'none' | 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'bimonthly' | 'quarterly' | 'semiannual' | 'annual': Frequência de monitoramento
        - `pu` number: Preço unitário
        - `unit` 'm³' | 'Litro' | 'Quilo (Kg)' | 'Sacas (50kg)' | 'Sacas (60kg)' | 'Tonelada' | 'Cabeça' | 'Caixa': Unidade de medida
        - `priceSource` object: Fonte de preço do produto
          - `sourceName` string: Nome da fonte
          - `product` 'Boi' | 'Café' | 'Laranja' | 'Soja' | 'Milho' | 'Cana de Açúcar' | 'Madeira Pinus': Produto referenciado
          - `unit` 'm³' | 'Litro' | 'Quilo (Kg)' | 'Sacas (50kg)' | 'Sacas (60kg)' | 'Tonelada' | 'Cabeça' | 'Caixa': Unidade de medida do preço
          - `location` object: Local de medida do preço
            - `state` string: Estado
            - `city` string: Cidade
        - `quantity` number: Quantidade do produto
        - `priceATR` number: Preço ATR. Apenas caso o produto seja "Cana de Açúcar"
        - `priceATRSource` object: Fonte de preço por ATR. Apenas caso o produto seja "Cana de Açúcar"
          - `sourceName` string: Nome da fonte
          - `product` 'Boi' | 'Café' | 'Laranja' | 'Soja' | 'Milho' | 'Cana de Açúcar' | 'Madeira Pinus': Produto referenciado
          - `unit` 'm³' | 'Litro' | 'Quilo (Kg)' | 'Sacas (50kg)' | 'Sacas (60kg)' | 'Tonelada' | 'Cabeça' | 'Caixa': Unidade de medida do preço
          - `location` object: Local de origem do preço
            - `state` string: Estado
            - `city` string: Cidade
        - `dueDiligence` string: Status de due diligence
        - `harvestDate` string[]: Datas da safra. Devem ser informadas no formato "ano/proxAno"

## Response `201`

Sucesso

- WarrantyCreatedSchema
  - `identification` string: Identificador da garantia

## Other responses

- `400`: Erro
- `401`: Não autorizado

---

[API](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos.md) - [All operations](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/llms.txt) - [OpenAPI document](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/revisions/2a24d3da114c?raw)
