Pular para o conteúdo principal

Criar operações

POST/api/operations

Esse endpoint permite que um originador autenticado crie uma operação.

Dados da requisição​

Atenção!

Para o cedente pessoa jurídica (type: J), os dados pessoais deverão ser preenchidos com as informações do sócio solicitante, e os dados referentes ao endereço deverão ser preenchidos com as informações da Empresa.

CampoTipoDescriçãoObrigatório
namestringNome completo do cedente ou sócio solicitante.Sim
typestringTipo de pessoa: F (Física) ou J (Jurídica).Sim
cpfstringCPF do cedente ou sócio solicitante.Sim
idNumberstringRG - Identidade do cedente ou sócio solicitante.Sim
issuingAgencystringÓrgão Expedidor do RG do cedente ou sócio solicitante.Sim
tradeNamestring, nullRazão social da empresa. Necessário de o type for J.Condicional
cnpjstring, nullCNPJ da empresa. Necessário de o type for J.Condicional
nationalitystringNacionalidade do cedente ou sócio solicitante.Sim
maritalStatusstringEstado civil do cedente ou sócio solicitante. Opções disponíveis: solteiro, casado, divorciado, viúvo e separado.Sim
occupationstringOcupação/Profissão do cedente ou sócio solicitante.Sim
cellphonestringNúmero de celular do cedente ou sócio solicitante.Sim
emailstringE-mail do cedente ou sócio solicitante.Sim
bank.codestringCódigo do banco.Sim
bank.typestringTipo de conta bancária. Opções disponíveis: CC, CP e SA.Sim
bank.accountstringNúmero da conta bancária.Sim
bank.agencystringNúmero da agência.Sim
bank.keyPixstringChave Pix para recebimento.Não
adress.zipCodestringCEP.Sim
adress.streetstringRua.Sim
adress.numberstringNúmero do endereço.Sim
adress.complementstringComplemento.Não
adress.neighborhoodstringBairro.Sim
adress.citystringCidade.Sim
adress.statestringEstado.Sim
adress.countrystringPaís.Sim
taxesobjectObjeto de definição de taxas.Não
taxes.defaultTaxnumber, nullTaxa acordada da Operação (em porcentagem).Não
taxes.fixedTacnumber, nullTaxa fixa acordada da Operação (valor em reais).Não
taxes.variableTacnumber, nullTaxa que varia com o tempo (valor em porcentagem).Não
taxes.floatingDaysnumber, nullDias extras que devem ser considerados para o cálculo da taxas.Não
receivablesarrayLista de recebíveis.Sim
receivables.externalIdnumberIdentificador externo do recebível.Sim
receivables.identifierstringIdentificador interno do recebível.Sim
receivables.payerNamestringNome/Razão Social do pagador/sacado.Sim
receivables.payerDocumentstringDocumento do pagador/sacado (CPF ou CNPJ).Sim
receivables.valuenumberValor de antecipação do recebível.Sim
receivables.totalAssetBackingnumberValor total da NF/recebível, caso o (receivables.value) seja uma parcela de um pagamento maior.Sim
receivables.expectedDatestringData prevista de pagamento (Formato yyyy-MM-dd).Sim
Observação

Caso opte por não informar a taxa específica na operação, e usar a taxa pré-cadastrada, deve-se deixar o campo como 'null' ou não informar a taxa no objeto. Se for colocado uma taxa = zero ('0') será usada a taxa padrão do originador. As taxas não podem ser menor do que as taxas do originador (taxa padrão mínima).

Observação

É possível informar como taxa personalizada apenas uma das opções, não é obrigatório passar no objeto todas as taxas disponíveis.

info

O variableTac é sempre a taxa nominal - Ex: se a taxa cobrada for 3% do recebedor no variável, tem que ser informado a variableTac = 3. Se for 0,3%, deve ser informado o variableTac = 0.3.

nota

Os campos referentes as taxas, podem ser utilizados na API de simulação de proposta / operação.

Exemplo de body (JSON)​

{
  "name": "John Wick",
  "type": "F",
  "cpf": "12345678901",
  "idNumber": "123456789",
  "issuingAgency": "SSP/SP",
  "tradeName": null,
  "cnpj": null,
  "nationality": "Brasileiro",
  "maritalStatus": "solteiro",
  "occupation": "Desenvolvedor",
  "cellphone": "92999998888",
  "email": "wick@zemobank.com",
  "bank": {
    "code": "001",
    "account": "123456-7",
    "type": "CC",
    "agency": "0001",
    "keyPix": "email@pix.com"
  },
  "address": {
    "zipCode": "09961050",
    "street": "Rua Jovelim",
    "number": "999",
    "complement": "AP 47",
    "neighborhood": "Jardim Bela Vista",
    "city": "São Paulo",
    "state": "SP",
    "country": "Brasil"
  },
  "taxes": {
    "defaultTax": null,
    "fixedTac": null,
    "variableTac": null,
    "floatingDays": null
  },
  "receivables": [
    {
      "externalId": 101,
      "identifier": "REC001",
      "payerName": "Cliente XPTO",
      "payerDocument": "12345678000199",
      "value": 1000,
      "totalAssetBacking": 1000,
      "expectedDate": "2024-05-15"
    }
  ]
}

Exemplos de resposta

{
  "id": "01970dc6-61cb-721a-9f4b-1bde936a0503",
  "proposalId": null,
  "operationNumber": 2119,
  "status": "CREATED",
  "totalValue": 10000,
  "liquidValue": 7553.33,
  "discountedValue": 2266.67,
  "fixedTac": 150,
  "variableTac": 30,
  "totalTac": 180,
  "averageDaysInAdvance": 85,
  "sentPaymentDate": null,
  "contractDetails": {
    "type": "FULL_CONTRACT",
    "signatureDate": null,
    "signerToken": null
  },
  "titles": [
    {
      "id": "01970dc6-641d-72ce-b433-b0e26ee79e3f",
      "operationId": "01970dc6-61cb-721a-9f4b-1bde936a0503",
      "proposalId": null,
      "receivableId": null,
      "status": "WAITING_PAYMENT",
      "returningMoneyDate": null,
      "externalId": 1,
      "description": "REC001",
      "dueDate": "2025-08-15T15:00:00.000Z",
      "paymentDay": "2025-08-18T12:00:00.000Z",
      "originalValue": 10000,
      "totalAssetBacking": 10000,
      "defaultTax": 8,
      "variableTac": 30,
      "floatingDays": 2,
      "qtdDaysAdvanced": 85,
      "discountedValue": 2266.67,
      "liquidTotalValue": 7733.33,
      "percentageTotalEffectiveCost": 0
    }
  ]
}
Nota

Os dados de resposta de sucesso são iguais independentes do type do cedente.