Skip to main content
POST
/
v1.1
/
checkout
/
transparent
Semi-transparent wire-transfer, pix and credit card and openbanking checkout
curl --request POST \
  --url https://api.paymee.com.br/v1.1/checkout/transparent \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data '
{
  "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"
    }
  }
}
'
{
  "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\n6008BRASILIA62190515RP12345678-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"
        ]
      }
    }
  }
}

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.

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Body

application/json
​
currency
string
required

ISO-4217 currency code

Maximum string length: 3
Example:

"BRL"

​
amount
number<float>
required

Order Amount

Example:

11

​
referenceCode
string
required

Unique order identifier

Maximum string length: 50
Example:

"019922112127617"

​
paymentMethod
enum<string>
required

Chosen payment method

Available options:
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
Example:

"PIX"

​
shopper
object
required
​
maxAge
number

Sale max age in minutes

Required range: x <= 43200
Example:

120

​
callbackURL
string<uri>

Callback URL for transaction updates

Maximum string length: 255
Example:

"https://foo.bar/paymeeListener"

​
redirectURL
string<uri>

Confirmation redirect URL

Maximum string length: 255
Example:

"https://foo.bar/paymeeRedirect"

​
observation
string

Any internal reference

Maximum string length: 255
Example:

"Internal Transaction ID 999"

​
recurrence
number

Recurrence in months (required when paymentMethod is INITIATOR)

Required range: x <= 999
Example:

12

​
brand_id
string<uuid>

Brand ID of the bank (required when paymentMethod is INITIATOR)

Response

success response / semi-transparent checkout (outros bancos example) / pix-success-response / pix-success-response split

​
message
string
Example:

"success"

​
response
object
​
status
number
Example:

0