Simulation

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": "[email protected]",
    "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

Show child attributes

customer.birth

string<date>

required

Customer's birth date in YYYY-MM-DD format

Example:

"1980-01-01"

customer.document

object

required

Show child attributes

customer.document.number

string

required

Document number (CPF for individuals)

Example:

"00000000000"

customer.document.type

enum<string>

required

Document type (CPF for individuals, CNPJ for companies)

Available options:

CPF,

CNPJ

Example:

"CPF"

customer.email

string<email>

required

Customer's email address

Example:

"[email protected]"

customer.income

number

required

Customer's monthly income

Example:

5000

customer.name

string

required

Customer's full name

Example:

"John Doe"

customer.phone

string

required

Customer's phone number

Example:

"11999999999"

customer.address

object

Show child attributes

customer.address.city

string

Example:

"City"

customer.address.complement

string

Example:

"Apt 4"

customer.address.number

string

Example:

"123"

customer.address.state

string

Example:

"ST"

customer.address.street

string

Example:

"Main Street"

customer.address.zipcode

string

Example:

"12345678"

times

number

required

Number of installments requested

Example:

12

products

object[]

List of products being financed (optional)

Show child attributes

products.amount

number

required

Quantity of this product

Example:

2

products.id

string

required

Product identifier

Example:

"prod1"

products.name

string

required

Product name

Example:

"Product 1"

products.value

number

required

Price per unit

Example:

5000

Response

Successful Response

hasProposal

boolean

Indicates if any financing proposals are available

Example:

true

proposals

object[]

List of available financing proposals

Show child attributes

proposals.amount

number

Total loan amount

Example:

10000

proposals.max_term_months

number

Maximum term in months

Example:

12

proposals.monthly_interest_rate

number

Monthly interest rate (decimal)

Example:

0.02

proposals.partner

string

Financing partner/bank name

Example:

"Bank A"

proposals.product

string

Financial product name

Example:

"Loan Product"

proposals.proposal_id

string

Unique proposal identifier

Example:

"abc123"

proposals.terms

object[]

Available term options

Show child attributes

proposals.terms.amount

number

Principal amount

Example:

10000

proposals.terms.down_payment

boolean

Whether down payment is required

Example:

false

proposals.terms.down_payment_value

number

Down payment amount if required

Example:

0

proposals.terms.final_amount

number

Total amount to be paid

Example:

10500

proposals.terms.first_due_date

string<date>

First installment due date

Example:

"2024-06-01"

proposals.terms.grace_period

number

Grace period in months

Example:

0

proposals.terms.interest_rate

number

Annual interest rate (decimal)

Example:

0.24

proposals.terms.label

string

Term plan label/name

Example:

"Standard Term"

proposals.terms.monthly_interest_rate

number

Monthly interest rate (decimal)

Example:

0.02

proposals.terms.proposal_id

string

Reference to parent proposal

Example:

"abc123"

proposals.terms.quotas

number

Number of installments

Example:

12

proposals.terms.times

number

Number of installments (alias)

Example:

12

proposals.terms.total_iof

number

Total IOF tax

Example:

50

Create a loanCreates a loan based on a previously approved proposal

⌘I

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": "[email protected]",
    "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
        }
      ]
    }
  ]
}

API Documentation

Checkout

Payouts

Loan

Transactions

Payment Methods

Financial

Webhooks and Callbacks

Payer Information

Pix Automatic (Recurrence)

Headers

Body

Response