v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Offer

Offer Creation Simulation

Simulation of a new offer with the details provided

Simulação de uma nova oferta com os detalhes fornecidos

post/offers/simulation

Request body

card_networkstring required

expire_datestring required

investorsinteger[] required

minimal_valuenumber required

offer_valuenumber required

receivable_idinteger[] required

Example request

{
  "card_network": "VISA",
  "expire_date": "2025-02-04",
  "investors": [
    2,
    4,
    9
  ],
  "minimal_value": 120.5,
  "offer_value": 250.6,
  "receivable_id": [
    10,
    11,
    28,
    68
  ]
}

Response

Created

card_networkstring

company_idinteger

expire_datestring

higher_date_offer_create_limitstring

idinteger

issuersinteger

lower_date_offer_create_limitstring

max_receivable_due_datestring

min_receivable_due_datestring

receivable_numbersinteger

receivable_total_valuenumber

receivables_idinteger[]

total_transaction_numbersinteger

Example response

{
  "card_network": "VISA",
  "company_id": 2,
  "expire_date": "2025-02-11T00:00:00-03:00",
  "higher_date_offer_create_limit": "2025-02-04T00:00:00-03:00",
  "id": 1,
  "issuers": 1,
  "lower_date_offer_create_limit": "2025-02-04T00:00:00-03:00",
  "max_receivable_due_date": "2025-02-11T00:00:00-03:00",
  "min_receivable_due_date": "2025-02-11T00:00:00-03:00",
  "receivable_numbers": 1,
  "receivable_total_value": 4500.8,
  "receivables": [
    {
      "card_network": "MASTERCARD",
      "company_id": 1,
      "compound_key": "testeCompany/MASTERCARD/Emissor2/2025-02-05 00:00:00 -0300 -03/Installment",
      "created_at": "2020-01-01 12:00:00",
      "due_date": "2025-02-11T00:00:00-03:00",
      "id": 1,
      "issuer": "Emissor2",
      "spreadsheet_id": 62,
      "status": "AVAILABLE",
      "transactions_number": 69,
      "transactions_number_available": 69,
      "updated_at": "2020-01-01 12:00:00",
      "value": 32500.8,
      "value_available": 32500.8
    }
  ],
  "receivables_id": [
    12,
    20,
    35
  ],
  "total_transaction_numbers": 22
}