---
title: "Criar uma operação"
method: POST
path: "/operation"
tags: ["Operation"]
---

# Criar uma operação

`POST /operation`

## Request

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

Essa rota serve para realizar a cessão de crédito ou emprestimo.

## Request body

- object
  - `AgreementId` string: Identificador do convênio
  - `ExternalId` string: Identificador do parceiro para envios de hooks
  - `TaxIdCounterparty` string: Cnpj/Cpf do tomador do emprestimo
  - `Term` number: Quatidade de parcelas
  - `TotalAmount` number, double: Valor total do Empréstimo + Juros + Comissao + Impostos. Soma de todas as PMTs
  - `Interest` object
    - `Index` 'PRE' | 'CDIE' | 'NIPCA': Indexador utilizado
    - `PreIndexRate` number, double: Taxa Pré Fixada do emprestimo
    - `PosIndexPercentage` number, double: Porcentagem do indexador Pós fixado a ser considerado (1 = 100%, 1.2 = 120%)
    - `BaseDayCount` number: Base de dias para o calculo da taxa. Ex. 30, 365, 252, 30360
  - `LatePaymentCharges` object: Juros cobrados por atraso
    - `PosIndexCode` 'PRE' | 'CDIE' | 'NIPCA': Indexador pos utilizado
    - `PreIndexRate` number, double: Taxa Pré Fixada do emprestimo cobrados por atraso
    - `PosIndexPercentage` number, double: Porcentagem do indexador Pós fixado a ser considerado (1 = 100%, 1.2 = 120%) em cobrança por atraso
  - `PurchaseInformation` object
    - `amount` number, double, nullable
    - `interest` object
      - `index` 'PRE' | 'CDIE' | 'NIPCA' | 'PTAX' | 'IGPM' | 'NIGPM' | 'SELIC' | 'TR'
      - `preIndexRate` number, double, nullable
      - `posIndexPercentage` number, double, nullable
      - `baseDayCount` integer, nullable
  - `Amount` number, double: Valor do emprestimo
  - `Rate` number, double: Substituido por "Interest"."PreIndexRate"
  - `AssignmentRate` number, double: Taxa da cessão
  - `Tax` number, double: Valor de imposto aplicada. IOF
  - `Arrears` number, double: Mora
  - `Penalty` number, double: Multa
  - `LatePaymentRate` number, double: Substituido por "LatePaymentCharges"."PreIndexRate" Taxa de juros por atraso
  - `Charges` number, double: Valor dos Encargos. Soma dos FEEs/Ágio/Deságio
  - `Cet` number, double: Custo Efetivo Total
  - `BaseDayCount` number: Substituido por "Interest"."BaseDayCount"
  - `AcquisitionAmount` number, double: Valor de aquisição da operação. Amount + FEEs + Ágio/Deságio
  - `ClientNetAmount` number, double: Valor liquido desembolsado para a contraparte do emprestimo
  - `BaseDate` string, date: Start Accrual da operação
  - `SettlementDate` string, date: Data de vencimento da operação. End Accrual da operação
  - `FundingDate` string, date: Data de Liquidacao para a contraparte
  - `FirtsInstallmentDate` string, date: Data de end accrual da primeira parcela
  - `OperationType` string: Tipo do operação. Ex: NEW, PORTABILITY, REFINANCING.
  - `Settlement` object
    - `Type` 'DebitoEmConta' | 'Boleto': Tipo da liquidação
    - `Account` object
      - `BankCode` string: Código do banco
      - `Agency` string: Número da agência
      - `DigitAgency` string: Dígito da agência
      - `Number` string: Número da conta
      - `DigitAccount` string: Dígito da conta
  - `Disbursement` object
    - `Type` 'Corrente' | 'Poupanca' | 'Salario': Tipo da conta
    - `Account` object
      - `BankCode` string: Código do banco
      - `Agency` string: Número da agência
      - `DigitAgency` string: Dígito da agência
      - `Number` string: Número da conta
      - `DigitAccount` string: Dígito da conta
    - `AdditionalDisbursements` object[]
      - `Type` 'Corrente' | 'Poupanca' | 'Salario' | 'SSIS': Tipo da conta
      - `TaxId` string: Documento Nacional do proprietário da conta
      - `Account` object
        - `BankCode` string: Código do banco
        - `Agency` string: Número da agência
        - `DigitAgency` string: Dígito da agência
        - `Number` string: Número da conta
        - `DigitAccount` string: Dígito da conta
  - `Contract` object
    - `ExternalId` string: Identificador do parceiro para envios de hooks
    - `Number` string: Identificador único do contrato
    - `FormalizationDate` string, date: Data da formalização do contrato
    - `Guarantees` object[]
      - `Name` string: Nome do avalista
      - `TaxId` string: Cnpj/Cpf do avalista
      - `Amount` number, double: Valor Garantido por este Avalista
    - `EmissionType` 'NONE' | 'CARTULAR' | 'ESCRITURAL' | 'ELETRONICA': Tipo de emissao do contrato
  - `Installments` object[]
    - `Code` number: Numero da parcela
    - `Amortization` number, double: Principal da parcela. Amortização
    - `Amount` number, double: Valor da parcela. PMT
    - `Interest` number, double: Juros da parcela
    - `Tax` number, double: Valor do IOF na parcela
    - `IsPaid` boolean: Indicador se houve pagamento completo anteriormente da parcela
    - `PaidValue` number, double: Valor anteriormente pago da parcela
    - `StartAccrual` string, date: Data de inicio de accrual da parcela
    - `EndAccrual` string, date: Data de termino de accrual da parcela
    - `PaymentDate` string, date: Data de pagamento da parcela
    - `MaturityDate` string, date: Data de vencimento da parcela
  - `OtherFees` object[]: Taxas adicionais de cessão. Obrigatório se custos por cessão forem aplicáveis.
    - `Type` 'REGISTRATOR' | 'BROKER' | 'RCO' | 'CIP' | 'TAC': Tipo do Fee
    - `Value` number, double: Valor Nominal
  - `Fees` object[]: Taxas adicionais de bancarização. Se aplicável (Obrigatorio se houver Fee)
    - `Type` 'REGISTRATOR' | 'BROKER' | 'RCO' | 'CIP' | 'TAC': Tipo do Fee
    - `Value` number, double: Valor Nominal
  - `GenericIdentifiers` object[]: Informações adicionais
    - `Type` 'IPOC' | 'CessionNumber' | 'EndorsementNumber' | 'ConciliationIdentifier' | 'CCIIdentifier' | 'SNGRegistry' | 'ConsigCode' | 'SignatureDate' | 'FederativeUnit' | 'RATING' | 'STORE_ID' | 'SEGMENT' | 'ConsignedEntity' | 'ConsignedEntityPayer': Tipo da informação do campo generico
    - `Value` string: Valor do campo generico
  - `RelatedOperations` object[]
    - `PositionAmount` number: Valor da posição
    - `PositionDate` string, date: Data da posição
    - `ContractNumber` string: Código do contrato
  - `WarrantyIdentification` string: Identificador da garantia

## Response `200`

Sucesso

- SucessSchema
  - `message` string: Mesagem de sucesso

## Other responses

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

---

[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)
