Skip to main content
POST
/
v1.1
/
loans
/
simulation
Simulation
curl --request POST \
  --url https://api.paymee.com.br/v1.1/loans/simulation \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data '
{
  "amount": 10000,
  "customer": {
    "address": {
      "city": "City",
      "complement": "Apt 4",
      "number": "123",
      "state": "ST",
      "street": "Main Street",
      "zipcode": "12345678"
    },
    "birth": "1980-01-01",
    "document": {
      "number": "00000000000",
      "type": "CPF"
    },
    "email": "foo@bar.com",
    "income": 5000,
    "name": "John Doe",
    "phone": "11999999999"
  },
  "products": [
    {
      "amount": 2,
      "id": "prod1",
      "name": "Product 1",
      "value": 5000
    }
  ],
  "times": 12
}
'
{ "hasProposal": true, "proposals": [ { "amount": 10000, "max_term_months": 12, "monthly_interest_rate": 0.02, "partner": "Bank A", "product": "Personal Loan", "proposal_id": "abc123", "terms": [ { "amount": 10000, "down_payment": false, "down_payment_value": 0, "final_amount": 10500, "first_due_date": "2024-06-01", "grace_period": 0, "interest_rate": 0.24, "label": "Standard Term", "monthly_interest_rate": 0.02, "proposal_id": "abc123", "quotas": 12, "times": 12, "total_iof": 50 } ] } ] }

Headers

​
x-api-key
string
required

API authentication key

Example:

"your-api-key-here"

​
x-api-token
string
required

API authentication token

Example:

"your-api-token-here"

Body

application/json
​
amount
number
required

Total loan amount requested

Example:

10000

​
customer
object
required
​
times
number
required

Number of installments requested

Example:

12

​
products
object[]

List of products being financed (optional)

Response

Successful Response

​
hasProposal
boolean

Indicates if any financing proposals are available

Example:

true

​
proposals
object[]

List of available financing proposals