> ## Documentation Index
> Fetch the complete documentation index at: https://developer.paymee.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Simulation
> Create a loan simulation based on customer information and requested amount
## OpenAPI
````yaml post /v1.1/loans/simulation
openapi: 3.0.3
info:
title: API PayMee 1.1
description: >-
# Overview
The purpose of this documentation is to guide the developer on how to
integrate with PayMee, describing the features and methods to be used,
listing information to be sent and received as well as providing examples.
The integration mechanism with PayMee is simple, so only intermediate
knowledge in Web programming language, HTTP/HTTPS requests and JSON file
manipulation are required to successfully deploy the PayMee solution.
In this manual you will find reference to all operations available on the
API REST of the PayMee API. These operations must be performed using
specific keys (**x-api-key** and **x-api-token**) on the respective
environment endpoints:
Production Environment
[https://api.paymee.com.br/](https://api.paymee.com.br/)
Sandbox Environment
[https://apisandbox.paymee.com.br/](https://apisandbox.paymee.com.br/)
To perform an operation, combine the base URL of the environment with the
resource (URI) of the desired operation and send it using the HTTP verb as
described in the operation.
# Solution features
The API solution of the PayMee platform was developed with REST technology,
which is the market standard and also independent from the technology used
by other parties. This way, it is possible to integrate it through the great
majority of programming languages, such as: ASP, ASP. Net, Java, PHP, Ruby,
Python, etc.
Amongst other features, the attributes that stand out the most in the PayMee
platform are:
**No proprietary apps**: it is not necessary to install any applications in
the virtual shop environment, under no circumstances.
**Simplicity**: the protocol used is purely HTTPS.
**Ease of testing**: the PayMee platform offers a publicly accessible
Sandbox environment, which allows the developer to create a [test
account](https://sandbox.paymee.com.br/register) making it easier and faster
to start integration.
**Credentials**: handling of the customer’s credentials (**x-api-key** and
**x-api-token**) traffics in the header of the HTTP request of the message.
**Safety**: the information exchange always takes place between the store's
Server and PayMee's Server, that is, without the buyer’s browser in between.
**Multiplatform**: the integration is performed through the REST Web
Service.
# Architecture
Integration is performed through Web Services. The model employed is quite
simple: There are two URLs (endpoints) available: a specific one for
production (real time operation), and a specific one for testing, called
sandbox.
These URLs receive the HTTP messages through the **POST**, **GET** or
**PUT** methods. Each message type must be sent to a resource identified
through the path.
| **METHOD** | **DESCRIPTION** |
| --- | --- |
| POST | The **POST** HTTP method is used in the creation of resources or
sending information that will be processed. For example, creation of a
transaction. |
| PUT | The **PUT** HTTP method is used to update an already existing
resource. For example, refunding or cancelation of a previous transaction. |
| GET | The **GET** HTTP method is used for querying already existing
resources. For example, transaction query. |
## Supported Payment Methdos
The current version of PayMee Webservice supports the following payment
methods:
| BANK | WIRE TRANSFER | CASH | CREDIT CARD |
| --- | --- | --- | --- |
| 001 - BANCO DO BRASIL | YES | YES | NO |
| 237 - BANCO BRADESCO | YES | NO | NO |
| 104 - BANCO CAIXA ECONOMICA FEDERAL | YES | NO | NO |
| 341 - BANCO ITAÚ-UNIBANCO | YES | YES | NO |
| 033 - BANCO SANTANDER BRASIL | YES | YES | NO |
| 212 - BANCO ORIGINAL | YES | NO | NO |
| 077 - BANCO INTER | YES | NO | NO |
| 218 - BANCO BS2 | YES | NO | NO |
| PIX | YES | NO | NO |
| CREDIT CARD | NO | NO | YES |
# Sandbox and Tools
## About Sandbox
To facilitate testing during integration, PayMee offers a Sandbox
environment, which is composed by two areas:
- Test account register
- Transactional Endpoint
- Request: [https://apisandbox.paymee.com.br](https://apisandbox.paymee.com.br)
Advantages of using the Sandbox
No affiliation is required to use PayMee's Sandbox. You just have to access
the Sandbox Registration, create an account and, with it, receive a
**x-api-key** and a **x-api-token**, which are the credentials required for
the API methods.
You can create your sandbox account here:
[https://sandbox.paymee.com.br/register](https://sandbox.paymee.com.br/register)
# Webhook
## Notification Post
The Notification Post is sent based on a selection of events to be made in
the PayMee registry.
The events that can be notified are:
| EVENT TYPE | EVENT |
| --- | --- |
| SALE | PAID |
| REVERSAL | CREATE/PAID |
PayMee's send the notifications to the URL that you have configured using
the HTTP protocol, by the POST method.
**Authentication**
Basic http auth.
The username is your **x-api-key** and password is your **x-api-token**
**Base64 Basic Auth reference:**
**x-api-key** = af38b751-30d7-4261-a9fb-ea30f6ece609
**x-api-token** = 28331f43-e2b3-4078-9502-5f656fb66cdf
### TRANSFER/WALK-IN NOTIFICATION (PAYMENT CONFIRMATION)
Here is an example of a notification sent by PayMee (the lines have been
broken for ease of reading):
```
POST /callback HTTP/1.1
Authorization: Basic
YWYzOGI3NTEtMzBkNy00MjYxLWE5ZmItZWEzMGY2ZWNlNjA5OjI4MzMxZjQzLWUyYjMtNDA3OC05NTAyLTVmNjU2ZmI2NmNkZg==
Content-Length:272
Content-Type:application/json
{
"saleToken": "d59b39ce-bffd-3f6d-80c4-c376a242afd1",
"referenceCode":"0000000000014",
"currency": "BRL",
"amount":100.00,
"shopper":{
"id": "12911",
"firstName":"Teste",
"lastName":"Silva",
"email":"teste@teste.com.br",
"agency": "1234",
"account": "123456-0"
},
"date":"2017-07-28 10:48:56",
"newStatus": "PAID"
}
```
A Payment Status URL must be registered, so that the notification POST is
executed.
The callback URL should return the HTTP status 200. Otherwise PayMee will
try again in 60-seconds interval for a maximum of 5 (five) attempts.
## Response
| **PROPERTY** | **TYPE** | **DESCRIPTION** |
| --- | --- | --- |
| saleToken | string | transaction UUID |
| referenceCode | string | order identification |
| amount | number | order amount |
| shopper.firstName | string | shopper's first name |
| shopper.firstName | string | shopper's last name |
| shopper.email | string | shopper's email |
| shopper.agency | string | shopper's agency |
| shopper.account | string | shopper's account |
| date | string | payment date and time (yyyy-MM-dd HH:mm:ss) |
| newStatus | string | payment PAID status |
### REVERSAL NOTIFICATION
Here is an example of a notification sent by PayMee (the lines have been
broken for ease of reading):
```
POST /callback?reversing=true&type=reversing HTTP/1.1
Authorization: Basic
YWYzOGI3NTEtMzBkNy00MjYxLWE5ZmItZWEzMGY2ZWNlNjA5OjI4MzMxZjQzLWUyYjMtNDA3OC05NTAyLTVmNjU2ZmI2NmNkZg==
Content-Length:272
Content-Type:application/json
{
"id": 611212,
"uuid": "d19b39ce-bffd-3f6d-80c4-c376a242afd3",
"currency": "BRL",
"originalAmount":100.00,
"reversedAmount":100.00,
"status": "PENDING",
"bankDetails":{
"bank": "341 - BANCO ITAÚ-UNIBANCO S.A.",
"branch":"0000",
"account":"00000-0"
},
"sale": {
"id": 611210,
"uuid": "75e0b5e2-bc3f-4e75-9c52-24096f2e004d"
}
"creation": "2018-04-15 08:33:22",
"receipt": null,
"reason": "amount greater than total of sale"
}
```
A Reversal Status URL must be registered (just like the payment
notification) and you **must enable** this feature on your [merchant
panel](https://www2.paymee.com.br/merchants/API), so the notification POST
is executed.
This notification occurs two moments:
- when we cannot approve or identify the sale - In this case, we send the
status attribute as **PENDING**;
- when we revert the amount successfully to the customer - In this case, we
send the status attribute as **PAID**
The callback URL should return the HTTP status 200. Otherwise PayMee will
try again in 60-seconds interval for a maximum of 5 (five) attempts.
## Response
| **PROPERTY** | **TYPE** | **DESCRIPTION** |
| --- | --- | --- |
| id | number | transaction id |
| uuid | string | transaction uuid |
| currency | string | order currency |
| originalAmount | number | original order amount |
| reversedAmount | number | reversed amount |
| bankDetails.bank | string | credit bank |
| bankDetails.branch | string | credit branch |
| bankDetails.account | string | credit account |
| receipt | string | reversal receipt (under development) |
| status | string | reversal status (PENDING/PAID/CANCELLED) |
| reason | string | reversal reason |
| date | string | reversal date (yyyy-MM-dd HH:mm:ss) |
### REFUND NOTIFICATION
Here is an example of a notification sent by PayMee (the lines have been
broken for easy reading):
```
POST /callback?refund=true&type=refund HTTP/1.1
Authorization: Basic
YWYzOGI3NTEtMzBkNy00MjYxLWE5ZmItZWEzMGY2ZWNlNjA5OjI4MzMxZjQzLWUyYjMtNDA3OC05NTAyLTVmNjU2ZmI2NmNkZg==
Content-Length:272
Content-Type:application/json
{
"saleToken": "d19b39ce-bffd-3f6d-80c4-c376a242afd3",
"referenceCode":"0000000000014",
"currency": "BRL",
"originalAmount":150.00,
"reversedAmount":50.00,
"bankDetails":{
"bank": "341 - BANCO ITAÚ-UNIBANCO S.A.",
"branch":"0000",
"account":"00000-0"
},
"receipt": "null",
"status": "PAID",
"refund": {
"id": 611211,
"uuid": fbebcd28-ae51-11e9-a2a3-2a2ae2dbcce4,
"status": "PAID",
"amount": 50.00,
"creation": "2018-04-15 08:33:22",
"creditDate": "2018-04-16 10:48:56"
}
"reason": "amount greater than total of sale",
"date":"2018-04-16 10:48:56"
}
```
A Refund Status URL must be registered (The same as the payment
notification) and you **must enable** this feature on your **merchant
panel**, so the notification POST is executed.
This notification occurs when:
- Refund the amount successfully - In this case, we send the status
attribute as **PAID**
The callback URL should return the HTTP status 200. Otherwise PayMee will
try again in 60-seconds interval for a maximum of 5 (five) attempts.
## Response
| **PROPERTY** | **TYPE** | **DESCRIPTION** |
| --- | --- | --- |
| saleToken | string | transaction UUID |
| referenceCode | string | order identification |
| currency | string | order currency |
| originalAmount | number | original order amount |
| amountRefunded | number | refund amount |
| bankDetails.bank | string | credit bank |
| bankDetails.branch | string | credit branch |
| bankDetails.account | string | credit account |
| receipt | string | refund receipt (under development) |
| status | string | refund status (PENDING/PAID/CANCELLED) |
| reason | string | refund reason |
| date | string | refund date (yyyy-MM-dd HH:mm:ss) |
### PAYOUT NOTIFICATION
Here is a success example of a notification sent by PayMee (the lines have
been broken for ease of reading):
```
POST /callback?type=payout HTTP/1.1
Authorization: Basic
YWYzOGI3NTEtMzBkNy00MjYxLWE5ZmItZWEzMGY2ZWNlNjA5OjI4MzMxZjQzLWUyYjMtNDA3OC05NTAyLTVmNjU2ZmI2NmNkZg==
Content-Length:272
Content-Type:application/json
{
"success": true,
"message": "success"
"id": 611212,
"uuid": "d19b39ce-bffd-3f6d-80c4-c376a242afd3",
"currency": "BRL",
"amount":100.00,
"status": "PAID",
"referenceCode": "XPADOA",
"bankDetails":{
"bank": "341 - BANCO ITAÚ-UNIBANCO S.A.",
"branch":"0000",
"account":"00000-0"
},
"creation": "2018-04-15 08:33:22",
"receipt": "https://receipts.paymee.com.br/transaction/23e49aa1f7f193395a7f30900f8aeb40a65a9d7dd85e8d05456847b800713546/d19b39ce-bffd-3f6d-80c4-c376a242afd3",
}
```
Here is a error example of a notification sent by PayMee (the lines have
been broken for ease of reading):
```
POST /callback?payout=true HTTP/1.1
Authorization: Basic
YWYzOGI3NTEtMzBkNy00MjYxLWE5ZmItZWEzMGY2ZWNlNjA5OjI4MzMxZjQzLWUyYjMtNDA3OC05NTAyLTVmNjU2ZmI2NmNkZg==
Content-Length:272
Content-Type:application/json
{
"success": false,
"message": "Os dados informados não são validos",
"error_code": "PE0001"
"id": 611212,
"uuid": "d19b39ce-bffd-3f6d-80c4-c376a242afd3",
"currency": "BRL",
"amount":100.00,
"status": "PENDING",
"referenceCode": "XPADOA",
"bankDetails":{
"bank": "341 - BANCO ITAÚ-UNIBANCO S.A.",
"branch":"0000",
"account":"00000-0"
},
"creation": "2018-04-15 08:33:22",
"receipt": "https://receipts.paymee.com.br/transaction/23e49aa1f7f193395a7f30900f8aeb40a65a9d7dd85e8d05456847b800713546/d19b39ce-bffd-3f6d-80c4-c376a242afd3",
}
```
A webhook URL must be registered (just like the payment notification) and
you **must enable** this feature on your [merchant
panel](https://www2.paymee.com.br/merchants/API), so the notification POST
is executed.
## Response
| **PROPERTY** | **TYPE** | **DESCRIPTION** |
| --- | --- | --- |
| success | boolean | payments status flag |
| message | string | return message |
| error_code | string | response error code |
| id | number | PayMee's transaction id |
| uuid | string | PayMee's transaction uuid |
| currency | string | transaction currency |
| amount | number | transaction amount |
| status | string | refund status (PENDING/PAID/CANCELLED) |
| bankDetails.bank | string | credit bank |
| bankDetails.branch | string | credit branch |
| bankDetails.account | string | credit account |
| receipt | string | payment receipt |
| date | string | transaction date (yyyy-MM-dd HH:mm:ss) |
| receiptDate | string | receipt date (yyyy-MM-dd HH:mm:ss) |
## Error codes
| **PROPERTY** | **DESCRIPTION** |
| --- | --- |
| PE0001 | Os dados bancarios fornecidos não validos |
| PE0002 | A titularidade da conta não pertence ao documento informado |
| PE0003 | A conta nao aceita movimentacoes - (MOTIVOS) |
| PE0004 | OUTROS - (MOTIVOS) |
# Resources
version: 1.0.0
contact: {}
servers:
- url: https://api.paymee.com.br
- url: https://apisandbox.paymee.com.br
security: []
tags:
- name: Checkouts
description: '**Our API collections for checkout requests**'
- name: loans
- name: Payouts
description: '**Our API collection for Payouts requests**'
paths:
/v1.1/loans/simulation:
post:
tags:
- Checkouts
- loans
summary: Simulation
description: >-
Create a loan simulation based on customer information and requested
amount
operationId: simulation
parameters:
- name: x-api-key
in: header
required: true
schema:
type: string
example: your-api-key-here
description: API authentication key
- name: x-api-token
in: header
required: true
schema:
type: string
example: your-api-token-here
description: API authentication token
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- amount
- customer
- times
properties:
amount:
type: number
description: Total loan amount requested
example: 10000
customer:
type: object
required:
- name
- document
- birth
- email
- phone
- income
properties:
address:
type: object
properties:
city:
type: string
example: City
complement:
type: string
example: Apt 4
number:
type: string
example: '123'
state:
type: string
example: ST
street:
type: string
example: Main Street
zipcode:
type: string
example: '12345678'
birth:
type: string
format: date
description: Customer's birth date in YYYY-MM-DD format
example: '1980-01-01'
document:
type: object
required:
- number
- type
properties:
number:
type: string
description: Document number (CPF for individuals)
example: '00000000000'
type:
type: string
enum:
- CPF
- CNPJ
description: >-
Document type (CPF for individuals, CNPJ for
companies)
example: CPF
email:
type: string
format: email
description: Customer's email address
example: foo@bar.com
income:
type: number
description: Customer's monthly income
example: 5000
name:
type: string
description: Customer's full name
example: John Doe
phone:
type: string
description: Customer's phone number
example: '11999999999'
products:
type: array
description: List of products being financed (optional)
items:
type: object
required:
- id
- name
- amount
- value
properties:
amount:
type: number
description: Quantity of this product
example: 2
id:
type: string
description: Product identifier
example: prod1
name:
type: string
description: Product name
example: Product 1
value:
type: number
description: Price per unit
example: 5000
times:
type: number
description: Number of installments requested
example: 12
examples:
StandardSimulation:
summary: Standard simulation request
value:
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
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
properties:
hasProposal:
type: boolean
description: Indicates if any financing proposals are available
example: true
proposals:
type: array
description: List of available financing proposals
items:
type: object
properties:
amount:
type: number
description: Total loan amount
example: 10000
max_term_months:
type: number
description: Maximum term in months
example: 12
monthly_interest_rate:
type: number
description: Monthly interest rate (decimal)
example: 0.02
partner:
type: string
description: Financing partner/bank name
example: Bank A
product:
type: string
description: Financial product name
example: Loan Product
proposal_id:
type: string
description: Unique proposal identifier
example: abc123
terms:
type: array
description: Available term options
items:
type: object
properties:
amount:
type: number
description: Principal amount
example: 10000
down_payment:
type: boolean
description: Whether down payment is required
example: false
down_payment_value:
type: number
description: Down payment amount if required
example: 0
final_amount:
type: number
description: Total amount to be paid
example: 10500
first_due_date:
type: string
description: First installment due date
format: date
example: '2024-06-01'
grace_period:
type: number
description: Grace period in months
example: 0
interest_rate:
type: number
description: Annual interest rate (decimal)
example: 0.24
label:
type: string
description: Term plan label/name
example: Standard Term
monthly_interest_rate:
type: number
description: Monthly interest rate (decimal)
example: 0.02
proposal_id:
type: string
description: Reference to parent proposal
example: abc123
quotas:
type: number
description: Number of installments
example: 12
times:
type: number
description: Number of installments (alias)
example: 12
total_iof:
type: number
description: Total IOF tax
example: 50
examples:
Success response:
summary: Standard loan proposal
value:
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
No proposals found response:
summary: No proposals found
value:
status: -1
message: no proposals were found
hasProposal: false
'400':
description: Error Response
content:
application/json:
schema:
type: object
properties:
errorCount:
type: number
description: Number of validation errors
example: 1
errors:
type: array
description: List of validation errors
items:
type: object
properties:
field:
type: string
description: Field that failed validation
example: customer.name
message:
type: string
description: Error message
example: must not be empty
main_error_message:
type: string
description: Primary error message
example: must not be empty
message:
type: string
description: General error message
example: Validation failed
status:
type: string
description: Error status code
example: VALIDATION_FAILURE
examples:
Field validation error response:
summary: Field validation error response
value:
errorCount: 1
errors:
- field: customer.name
message: must not be empty
main_error_message: must not be empty
message: field validation failure
status: -1
'403':
description: Unauthorized access
content:
application/json:
schema:
type: object
properties:
errorCount:
type: number
errors:
type: array
items:
type: object
properties:
error:
type: string
message:
type: string
message:
type: string
status:
type: number
examples:
Unauthorized access:
summary: Unauthorized access
value:
errorCount: 1
errors:
- error: Forbidden
message: Access Denied
message: field validation failure
status: -1
````