v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Proposals | Propostas

Create a new proposal | Criar uma nova proposta

Creates a new loan proposal based on the provided data | Cria uma nova proposta de crédito baseada nos dados fornecidos

post/proposals

Request body

customer_idstring required

Customer ID

emailstring required
phonestring required

E.g., 11999998888 or (11) 99999-8888

product_idstring required

Product ID

Example request

{
  "customer_id": "d9ece0d8-ffdb-45d7-abd1-48047a6c192d",
  "destination_account": {
    "account_type": "0",
    "bank": "001",
    "bank_account": "1",
    "bank_account_digit": "1",
    "bank_branch": "001",
    "document": "887.011.120-23",
    "name": "Luan Leandro Pereira",
    "receiver_pix_key": "renata.ana.pereira@orthoi.com.br",
    "receiver_pix_key_type": "2"
  },
  "email": "renata.ana.pereira@orthoi.com.br",
  "phone": "556299931553",
  "product_id": "eebb64c0-1bc6-44c7-91c9-e7ddeb25dabe",
  "simulation_input": {
    "customer_type": "PF",
    "first_due_date": "2025-08-04",
    "include_iof": true,
    "interest_rate": 0.015,
    "iof_handling_type": "FINANCED",
    "loan_amount": 20.54,
    "number_of_installments": 3,
    "periodicity_interval": 1,
    "periodicity_unit": "MONTH",
    "registration_fee_handling_type": "FINANCED",
    "release_date": "2025-07-04",
    "simulation_type": "PRICE"
  }
}

Response

Proposal created successfully | Proposta criada com sucesso

codestring
messagestring
request_idstring

Example response

{
  "code": "success",
  "data": {
    "code": "20250715-000001",
    "created_at": "2025-07-15T15:24:48.333074-03:00",
    "customer_data": {
      "dados_adcionais": "vas",
      "mail": "lucas@mail.com",
      "phone": "88982333576"
    },
    "destination_account": {
      "account_type": "0",
      "bank": "001",
      "bank_account": "1",
      "bank_account_digit": "1",
      "bank_branch": "001",
      "document": "70379522155",
      "name": "Fulando d'Tal",
      "receiver_pix_key": "703.795.221-55",
      "receiver_pix_key_type": "0"
    },
    "document": "28854243000106",
    "id": "0d304256-730f-4540-93bf-89115ff1f4fd",
    "simulation": {
      "cet_annual": 19.89,
      "cet_monthly": 1.523,
      "customer_type": "PF",
      "first_due_date": "2025-08-04T00:00:00Z",
      "include_iof": true,
      "installments": [
        {
          "balance": 9590.8,
          "due_date": "2025-07-01T00:00:00Z",
          "installment_number": 1,
          "interest_amount": 155.81,
          "payment_amount": 952.31,
          "principal_amount": 796.5
        }
      ],
      "interest_rate": 1.5,
      "iof_amount": 76.82,
      "iof_handling_type": "FINANCED",
      "loan_amount": 20000,
      "net_amount_released": 20000,
      "number_of_installments": 3,
      "periodicity_interval": 1,
      "periodicity_unit": "MONTH",
      "registration_fee": 250,
      "registration_fee_handling_type": "FINANCED",
      "release_date": "2025-07-04T00:00:00Z",
      "simulation_type": "PRICE",
      "total_amount_paid": 21183.6,
      "total_financed_amount": 20326.82
    },
    "status": "DocumentsPending",
    "step": "Documentation",
    "updated_at": "2025-07-15T15:24:48.367306-03:00"
  },
  "message": "Proposal created successfully",
  "request_id": "1504ebd7-fa91-4087-965f-e05021775b38"
}