POST
/
v1.1
/
loans
/
create
Create a loan
curl --request POST \
  --url https://api.paymee.com.br/v1.1/loans/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data '{
  "proposal_id": "abc1234",
  "reference_code": "ref01234",
  "max_age": 60,
  "discriminator": "John'\''s transaction",
  "final_amount": 10,
  "customer": {
    "name": "John Doe",
    "birth": "1970-01-01",
    "email": "foo@bar.com",
    "mobile_number": "11999999999",
    "document": {
      "type": "CPF",
      "number": "00000000000"
    },
    "address": {
      "zipcode": "12345678",
      "street": "Main Street",
      "number": "123",
      "complement": "Apt 4",
      "neighborhood": "Downtown",
      "city": "City",
      "state": "ST"
    }
  }
}'
{
  "amount": 800,
  "appliedRate": 0,
  "chosen_term": {
    "amount": 800,
    "final_amount": 845.31,
    "interest_rate": 7.17,
    "label": "03x",
    "monthly_interest_rate": 2.39,
    "quotas": 281.77,
    "times": 3
  },
  "creation": "2021-03-17 10:43:49",
  "currency": "BRL",
  "discounts": 0,
  "id": 43863,
  "maxAge": "2021-03-19 02:40:49",
  "message": "success",
  "referenceCode": "5077AXC",
  "shipping": 0,
  "shopper": {
    "bankDetails": {},
    "document": {
      "number": "00000000000",
      "type": "CPF"
    },
    "email": "foo@bar.com",
    "name": "JOHN DOE",
    "phone": {
      "number": "+5511999999999",
      "type": "MOBILE"
    }
  },
  "situation": "PENDING",
  "status": 0,
  "total": 800,
  "type": "SALE",
  "uuid": "d7113995-e683-35b6-bf4f-7846ebc63819"
}

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
​
proposal_id
string
required

Proposal ID from a previous loan simulation

Example:

"abc1234"

​
reference_code
string
required

Merchant reference code for tracking

Example:

"ref01234"

​
max_age
integer
required

Validity period in minutes

Example:

60

​
discriminator
string
required

Optional field for categorization

Example:

"John's transaction"

​
final_amount
number
required

Final amount to be paid

Example:

10

​
customer
object
required

Response

Loan creation response

​
amount
number

Principal loan amount

Example:

800

​
appliedRate
number

Applied rate

Example:

0

​
chosen_term
object

Selected payment term details

​
creation
string

Loan creation date and time

​
currency
string

Currency code

​
discounts
number

Applied discounts

​
id
number

Internal loan ID

​
maxAge
string

Loan expiration date and time

​
message
string

Response message

Example:

"success"

​
referenceCode
string

Merchant reference code

​
shipping
number

Shipping costs if applicable

​
shopper
object

Customer information

​
situation
string

Loan status

Example:

"PENDING"

​
status
number

Response status code

Example:

0

​
total
number

Total loan amount

​
type
string

Transaction type

Example:

"SALE"

​
uuid
string

Unique loan identifier