> ## 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.
# Semi-transparent wire-transfer, pix and credit card and openbanking checkout
> To generate a transaction throught PayMee, it is necessary to send a request using the POST method to the **checkout** resource, as shown. This example covers the minimum of fields required to be submitted for authorization.
## OpenAPI
````yaml post /v1.1/checkout/transparent
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/checkout/transparent:
post:
tags:
- Checkouts
summary: >-
Semi-transparent wire-transfer, pix and credit card and openbanking
checkout
description: >-
To generate a transaction throught PayMee, it is necessary to send a
request using the POST method to the **checkout** resource, as shown.
This example covers the minimum of fields required to be submitted for
authorization.
operationId: semiTransparentWireTransferPixAndCreditCardAndOpenbankingCheckout
parameters:
- name: x-api-key
in: header
required: true
schema:
type: string
example: your-x-api-key
- name: x-api-token
in: header
required: true
schema:
type: string
example: your-x-api-token
requestBody:
required: true
content:
application/json:
examples:
PIX example:
summary: PIX payment example
value:
currency: BRL
amount: 11
referenceCode: refcode12345
maxAge: 120
paymentMethod: PIX
callbackURL: https://foo.bar/paymeeListener
shopper:
id: '24391203'
email: foo@bar.com
name: JOHN DOE
document:
type: CPF
number: '00000000000'
phone:
type: MOBILE
number: '11999990000'
bankDetails:
branch: '0001'
account: 00011-0
schema:
type: object
required:
- currency
- amount
- referenceCode
- paymentMethod
- shopper
properties:
currency:
type: string
description: ISO-4217 currency code
example: BRL
maxLength: 3
amount:
type: number
description: Order Amount
example: 11
format: float
referenceCode:
type: string
description: Unique order identifier
example: '019922112127617'
maxLength: 50
maxAge:
type: number
description: Sale max age in minutes
example: 120
maximum: 43200
paymentMethod:
type: string
description: Chosen payment method
example: PIX
enum:
- BB_TRANSFER
- BB_DI
- BRADESCO_TRANSFER
- ITAU_TRANSFER_GENERIC
- ITAU_TRANSFER_PF
- ITAU_TRANSFER_PJ
- ITAU_DI
- CEF_TRANSFER
- ORIGINAL_TRANSFER
- SANTANDER_TRANSFER
- SANTANDER_DI
- INTER_TRANSFER
- BS2_TRANSFER
- OUTROS_BANCOS
- PIX
- CREDIT_CARD
- INITIATOR
callbackURL:
type: string
description: Callback URL for transaction updates
example: https://foo.bar/paymeeListener
format: uri
maxLength: 255
redirectURL:
type: string
description: Confirmation redirect URL
format: uri
maxLength: 255
example: https://foo.bar/paymeeRedirect
observation:
type: string
description: Any internal reference
example: Internal Transaction ID 999
maxLength: 255
recurrence:
type: number
example: 12
description: >-
Recurrence in months (required when paymentMethod is
INITIATOR)
maximum: 999
brand_id:
type: string
description: >-
Brand ID of the bank (required when paymentMethod is
INITIATOR)
format: uuid
shopper:
type: object
required:
- name
- email
- document
- phone
- bankDetails
properties:
id:
type: string
description: Internal shopper identifier
example: '24391203'
maxLength: 255
name:
type: string
description: Shopper's name
example: JOHN DOE
maxLength: 255
email:
type: string
description: Shopper's email
example: foo@bar.com
format: email
maxLength: 50
document:
type: object
required:
- type
- number
properties:
type:
type: string
description: Shopper's document type
example: CPF
enum:
- CPF
- CNPJ
- OTHER
number:
type: string
description: Shopper's document number
example: '00000000000'
maxLength: 25
phone:
type: object
required:
- type
- number
properties:
type:
type: string
description: Shopper's phone type
example: MOBILE
enum:
- MOBILE
- HOME
- WORK
- OTHER
number:
type: string
description: Shopper's phone number
example: '11999990000'
maxLength: 25
bankDetails:
type: object
required:
- branch
- account
properties:
branch:
type: string
description: Shopper's branch number
example: '0001'
maxLength: 8
account:
type: string
description: Shopper's account number
example: 00011-0
maxLength: 25
responses:
'200':
description: >-
success response / semi-transparent checkout (outros bancos example)
/ pix-success-response / pix-success-response split
headers:
Date:
schema:
type: string
example: Thu, 28 Oct 2021 22:41:22 GMT
Transfer-Encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: success
response:
type: object
properties:
amount:
type: number
example: 11
id:
type: number
example: 2423
instructions:
type: object
properties:
beneficiary_account:
type: string
example: 13002973-8
beneficiary_branch:
type: string
example: '0386'
beneficiary_document:
type: string
example: 28.683.892/0001-91
beneficiary_name:
type: string
example: PayMee Brasil Serviços de Pagamentos S.A
beneficiary_op:
type: string
example: ''
chosen:
type: string
example: SANTANDER_TRANSFER
identification:
type: string
example: '2423'
keys:
type: object
properties:
document:
type: string
example: '00000000000000'
email:
type: string
example: pix-sandbox@paymee.com.br
label:
type: string
example: transferência entre contas Santander Brasil
name:
type: string
example: Santander Brasil
need_identification:
type: boolean
example: false
qrCode:
type: object
properties:
base64:
type: string
example: >-
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAIAAAAHjs1qAAAEvklEQVR42u3ayXXDMBBEQeWftJ2ATzIw3QDqn7VwqeFhHj8/0jN9XALhLuEu4S7hLuEu4S7hLuEu4S7hLuEu3CXcJdwl3CXcJdwl3CXcJdwl3CXchbuEu4T7Xz8X7bsj3Hhxo+ee/Z3Je4o77rjjjjvuuOOOO+6444477rg3YPruVq361uQVmxz+tnuKO+6444477rjjjjvuuOOOO+647ya47zZkV5zZ85o85sl7ijvuuOOOO+6444477rjjjjvuuHdemraL3ong9EcY7rjjjjvuuOOOO+6444477rjjfu6l2XfMk6vSfUeIO+6444477rjjjjvuuOOOO+6438Q9O1qrjnlyAFYtNCevT6cf3HHHHXfccccdd9xxxx133HF/jfuJSzSfab6nuCOIO+6Y4o67z+COu8/gjrvP4P5aky88TS5Gn7uPKOOOu3DHHXfccccdd9xxx/1q7tklY9tCM/sCVvaY214+wx133HHHHXfccccdd9xxxx33F7hPDsm+BWLb+rJtaM9dleKOO+6444477rjjjjvuuOOO+2vcJy9fdj3XtkCcPNMGyrjjjjvuuOOOO+6444477rjjjnv2lCZfGlvF9MTVbXahiTvuuOOOO+6444477rjjjjvuuO9eDu5bok2i7F/h7Ru/zocj7rjjjjvuuOOOO+6444477rjfzX1yXZgdgP6FXfZ49t0L3HHHHXfccccdd9xxxx133HHH/W7K/QvESSiTr7Udv3fHHXfccccdd9xxxx133HHHHfcy7pO/0zZsd6Bc9a0nFpG444477rjjjjvuuOOOO+644x7l3r8K7F9oTg5bdgl7/CISd9xxxx133HHHHXfccccdd9zrua8aklNWXTvOtL/sgw933HHHHXfccccdd9xxxx133HFfu6Lat0TLLuyyS9jsGF+4iMQdd9xxxx133HHHHXfccccd9/pF5InLryzuycdB9uW8wNoXd9xxxx133HHHHXfccccdd9wf455F2X9jToHy/zv4xCISd9xxxx133HHHHXfccccdd9yj3PcRzNJp++XJ63zTgwZ33HHHHXfccccdd9xxxx133HFvI9g2ANlV4OT4BRamuOOOO+6444477rjjjjvuuOP+PPd9A7Dvv/aNaPZBkz3C+QHAHXfccccdd9xxxx133HHHHXfc2+hkobSde+erXbjjjjvuuOOOO+6444477rjjjvuJnfLqUgrl5Ng0rCZxxx133HHHHXfccccdd9xxx/1u7p9obbche177/mvV8Vy4d8cdd9xxxx133HHHHXfccccd9zLu2SXj5I2ZfPVtkvJNC1/ccccdd9xxxx133HHHHXfccce9bUHWj6BtbCYfGbjjjjvuuOOOO+6444477rjjjvvd3Pt/Jzv8+x4i86+R4Y477rjjjjvuuOOOO+6444477idyz55F/xifEu6444477rjjjjvuuOOOO+64454drVX/Nbn4y16N7GDjjjvuuOOOO+6444477rjjjjvua1nsq23pmX1AZAl2DgDuuOOOO+6444477rjjjjvuuN/NXWoOd+Eu4S7hLuEu4S7hLuEu4S7hLuEu4S7cJdwl3CXcJdwl3CXcJdwl3CXcJdyFu4S7dEm/llibksuxCZcAAAAASUVORK5CYII=
plain:
type: string
example: >-
00020101021226720014br.gov.bcb.pix2550bx.com.br/pix/0fa55bba-cb0d-3e5a-8dd3-88af60f2a324520400005303986540647.925802BR5913PayMee
Brasil
6008BRASILIA62190515RP12345678-2019630445C8
url:
type: string
example: >-
https://api.paymee.com.br/payments/pix/qrcode/14fe1d3d-26f9-3790-8161-df091e8585da
redirect_urls:
type: object
properties:
android:
type: string
example: >-
https://play.google.com/store/apps/details?id=com.santander.app&hl=pt_BR
desktop:
type: string
example: https://www.santander.com.br/
ios:
type: string
example: >-
https://itunes.apple.com/br/app/santander-brasil/id613365711?mt=8
windows_phone:
type: string
nullable: true
example: >-
https://www.microsoft.com/pt-br/store/p/minha-conta-pf/9wzdncrdc5g4
steps:
anyOf:
- type: array
items:
type: string
example:
- >-
ATENÇÃO: Não aceitamos pagamentos de contas
de terceiros, pague o valor exato!
- Acesse o APP ou o site do Banco Santander
- >-
No menu de serviços, selecione
'Transferência entre Contas Santander'
- >-
Informe a agência: 0386 e conta-corrente:
13002973-8
- >-
Confirme o nome do favorecido: PayMee
Brasil Serviços de Pagamentos S.A.
- >-
Efetue o pagamento no valor exato de R$
11,00.
- type: object
properties:
key:
type: array
items:
type: string
example:
- >-
Acesse o APP ou o Internet Banking do
seu Banco
- Acesse o menu PIX
- >-
Informe a chave
pix-sandbox@paymee.com.br ou se preferir
o nosso CNPJ 00000000000000
- >-
Siga os passos no seu APP e finalize a
transação
qrCode:
type: array
items:
type: string
example:
- >-
Acesse o APP ou o Internet Banking do
seu Banco
- Acesse o menu PIX
- >-
Abra o leitor de QRCode no APP e
escaneie o código informado
- >-
Siga os passos no APP e finalize a
transação
referenceCode:
type: string
example: refcode12345
saleCode:
type: string
example: '00027736'
shopper:
type: object
properties:
bankDetails:
type: object
properties:
account:
type: string
example: 00011-0
branch:
type: string
example: '0001'
document:
type: object
properties:
number:
type: string
example: '00000000000'
type:
type: string
example: CPF
email:
type: string
example: foo@bar.com
id:
type: string
example: '24391203'
name:
type: string
example: JOHN DOE
phone:
type: object
properties:
number:
type: string
example: '11999990000'
type:
type: string
example: MOBILE
status:
type: string
example: PAID
uuid:
type: string
example: 81d588cb-4fec-3088-960d-6881b8749247
status:
type: number
example: 0
examples:
Success response - PIX:
value:
status: 0
message: success
response:
amount: 11
id: 33200
uuid: 14fe1d3d-26f9-3790-8161-df091e8585da
referenceCode: '0199221121276150'
saleCode: '00033200'
shopper:
document:
number: '00000000000'
type: CPF
email: foo@bar.com
id: '24391203'
name: JOHN DOE
phone:
number: '11999990000'
type: MOBILE
instructions:
chosen: PIX
label: Transferência via PIX
name: PIX
qrCode:
base64: >-
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAIAAAAHjs1qAAAEvklEQVR42u3ayXXDMBBEQeWftJ2ATzIw3QDqn7VwqeFhHj8/0jN9XALhLuEu4S7hLuEu4S7hLuEu4S7hLuEu3CXcJdwl3CXcJdwl3CXcJdwl3CXchbuEu4T7Xz8X7bsj3Hhxo+ee/Z3Je4o77rjjjjvuuOOOO+6444477rg3YPruVq361uQVmxz+tnuKO+6444477rjjjjvuuOOOO+647ya47zZkV5zZ85o85sl7ijvuuOOOO+6444477rjjjjvuuHdemraL3ong9EcY7rjjjjvuuOOOO+6444477rjjfu6l2XfMk6vSfUeIO+6444477rjjjjvuuOOOO+6438Q9O1qrjnlyAFYtNCevT6cf3HHHHXfccccdd9xxxx133HF/jfuJSzSfab6nuCOIO+6Y4o67z+COu8/gjrvP4P5aky88TS5Gn7uPKOOOu3DHHXfccccdd9xxx/1q7tklY9tCM/sCVvaY214+wx133HHHHXfccccdd9xxxx33F7hPDsm+BWLb+rJtaM9dleKOO+6444477rjjjjvuuOOO+2vcJy9fdj3XtkCcPNMGyrjjjjvuuOOOO+6444477rjjjnv2lCZfGlvF9MTVbXahiTvuuOOOO+6444477rjjjjvuuO9eDu5bok2i7F/h7Ru/zocj7rjjjjvuuOOOO+6444477rjfzX1yXZgdgP6FXfZ49t0L3HHHHXfccccdd9xxxx133HHH/W7K/QvESSiTr7Udv3fHHXfccccdd9xxxx133HHHHfcy7pO/0zZsd6Bc9a0nFpG444477rjjjjvuuOOOO+644x7l3r8K7F9oTg5bdgl7/CISd9xxxx133HHHHXfccccdd9zrua8aklNWXTvOtL/sgw933HHHHXfccccdd9xxxx133HFfu6Lat0TLLuyyS9jsGF+4iMQdd9xxxx133HHHHXfccccd9/pF5InLryzuycdB9uW8wNoXd9xxxx133HHHHXfccccdd9wf455F2X9jToHy/zv4xCISd9xxxx133HHHHXfccccdd9yj3PcRzNJp++XJ63zTgwZ33HHHHXfccccdd9xxxx133HFvI9g2ANlV4OT4BRamuOOOO+6444477rjjjjvuuOP+PPd9A7Dvv/aNaPZBkz3C+QHAHXfccccdd9xxxx133HHHHXfc2+hkobSde+erXbjjjjvuuOOOO+6444477rjjjvuJnfLqUgrl5Ng0rCZxxx133HHHHXfccccdd9xxx/1u7p9obbche177/mvV8Vy4d8cdd9xxxx133HHHHXfccccd9zLu2SXj5I2ZfPVtkvJNC1/ccccdd9xxxx133HHHHXfccce9bUHWj6BtbCYfGbjjjjvuuOOOO+6444477rjjjvvd3Pt/Jzv8+x4i86+R4Y477rjjjjvuuOOOO+6444477idyz55F/xifEu6444477rjjjjvuuOOOO+64454drVX/Nbn4y16N7GDjjjvuuOOOO+6444477rjjjjvua1nsq23pmX1AZAl2DgDuuOOOO+6444477rjjjjvuuN/NXWoOd+Eu4S7hLuEu4S7hLuEu4S7hLuEu4S7cJdwl3CXcJdwl3CXcJdwl3CXcJdyFu4S7dEm/llibksuxCZcAAAAASUVORK5CYII=
plain: >-
00020101021226720014br.gov.bcb.pix2550bx.com.br/pix/0fa55bba-cb0d-3e5a-8dd3-88af60f2a324520400005303986540647.925802BR5913PayMee
Brasil
6008BRASILIA62190515RP12345678-2019630445C8
url: >-
https://api.paymee.com.br/payments/pix/qrcode/14fe1d3d-26f9-3790-8161-df091e8585da
steps:
key:
- Acesse o APP ou o Internet Banking do seu Banco
- Acesse o menu PIX
- >-
Informe a chave pix-sandbox@paymee.com.br ou se
preferir o nosso CNPJ 00000000000000
- Siga os passos no seu APP e finalize a transação
qrCode:
- Acesse o APP ou o Internet Banking do seu Banco
- Acesse o menu PIX
- >-
Abra o leitor de QRCode no APP e escaneie o código
informado
- Siga os passos no APP e finalize a transação
Success response - other payments methods:
value:
status: 0
message: success
response:
amount: 11
id: 27736
uuid: 56087f1f-9944-3d52-ac3d-50f23ad74ec2
referenceCode: refcode12345
saleCode: '00027736'
shopper:
bankDetails:
account: 00011-0
branch: '0001'
document:
number: '00000000000'
type: CPF
email: foo@bar.com
id: '24391203'
name: JOHN DOE
phone:
number: '11999990000'
type: MOBILE
instructions:
beneficiary_account: 13000000-1
beneficiary_branch: '0001'
beneficiary_document: 28.683.892/0001-91
beneficiary_name: PayMee Brasil Serviços de Pagamentos S.A
beneficiary_op: ''
chosen: OUTROS_BANCOS
identification: '50027'
label: TED para Santander Brasil S.A
name: TED para Santander
need_identification: false
redirect_urls:
android: >-
https://portal.febraban.org.br/pagina/3164/12/pt-br/associados
desktop: >-
https://www.febraban.org.br/associados/utilitarios/bancos.asp
ios: >-
https://www.febraban.org.br/associados/utilitarios/bancos.asp
windows_phone: null
steps:
- Acesse o site ou APP do seu banco
- >-
No menu de serviços, selecione 'Transferências >
TED'
- 'Informe a agência: 0001 e conta-corrente: 13000000-1'
- 'Informe o nosso documento: 28.683.892/0001-91'
- >-
Informe o nosso nome (caso necessário): PayMee
Brasil
- Efetue o pagamento no valor exato de R$ 11,00.
- >-
PRONTO! O pagamento do seu pedido será confirmado ao
comércio XXXXX
Success response - GENERIC:
value:
status: 0
message: success
response:
amount: 11
id: 2423
uuid: 81d588cb-4fec-3088-960d-6881b8749247
referenceCode: refcode12345
shopper:
bankDetails:
account: 00011-0
branch: '0001'
document:
number: '00000000000'
type: CPF
email: foo@bar.com
id: '24391203'
name: JOHN DOE
phone:
number: '11999990000'
type: MOBILE
instructions:
beneficiary_account: 13002973-8
beneficiary_branch: '0386'
beneficiary_name: PayMee Brasil Serviços de Pagamentos S.A
chosen: SANTANDER_TRANSFER
identification: '2423'
label: transferência entre contas Santander Brasil
name: Santander Brasil
need_identification: false
redirect_urls:
android: >-
https://play.google.com/store/apps/details?id=com.santander.app&hl=pt_BR
desktop: https://www.santander.com.br/
ios: >-
https://itunes.apple.com/br/app/santander-brasil/id613365711?mt=8
windows_phone: >-
https://www.microsoft.com/pt-br/store/p/minha-conta-pf/9wzdncrdc5g4
steps:
- >-
ATENÇÃO: Não aceitamos pagamentos de contas de
terceiros, pague o valor exato!
- Acesse o APP ou o site do Banco Santander
- >-
No menu de serviços, selecione 'Transferência entre
Contas Santander'
- 'Informe a agência: 0386 e conta-corrente: 13002973-8'
- >-
Confirme o nome do favorecido: PayMee Brasil
Serviços de Pagamentos S.A.
- Efetue o pagamento no valor exato de R$ 11,00.
'400':
description: duplicated referenceCode response / validation failure response
headers:
Connection:
schema:
type: string
example: close
Date:
schema:
type: string
example: Thu, 28 Oct 2021 22:30:31 GMT
Transfer-Encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
properties:
errorCount:
type: number
example: 1
errors:
type: array
items:
type: object
properties:
field:
type: string
example: referenceCode
message:
type: string
example: referenceCode duplicated para o comércio.
example:
- field: referenceCode
message: referenceCode duplicated para o comércio.
message:
type: string
example: field validation failure
status:
type: number
example: -1
examples:
Duplicated reference code response:
value:
errorCount: 1
errors:
- field: referenceCode
message: referenceCode duplicated para o comércio.
message: field validation failure
status: -1
Field validation failure response:
value:
errorCount: 12
errors:
- field: shopper.name
message: may not be empty
- field: shopper.bankDetails.branch
message: may not be empty
- field: shopper.document.type
message: may not be null
- field: shopper.phone.number
message: may not be null
- field: shopper.email
message: may not be empty
- field: shopper.document.number
message: may not be null
- field: shopper.email
message: may not be null
- field: shopper.bankDetails.branch
message: may not be null
- field: shopper.bankDetails.account
message: may not be empty
- field: shopper.phone.type
message: may not be null
- field: shopper.bankDetails.account
message: may not be null
- field: referenceCode
message: referenceCode duplicated para o comércio.
message: field validation failure
status: -1
'403':
description: Unauthorized response
headers:
Date:
schema:
type: string
example: Wed, 04 Jul 2018 18:36:39 GMT
Transfer-Encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
properties:
errorCount:
type: number
example: 1
errors:
type: array
items:
type: object
properties:
error:
type: string
example: Forbidden
message:
type: string
example: Access Denied
example:
- error: Forbidden
message: Access Denied
message:
type: string
example: field validation failure
status:
type: number
example: -1
examples:
Unauthorized access:
value:
errorCount: 1
errors:
- error: Forbidden
message: Access Denied
message: field validation failure
status: -1
security:
- {}
````