POST
/
v1.1
/
loans
/
create
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

Response

200
application/json

Loan creation response

The response is of type object.