POST
/
v1.1
/
checkout
curl --request POST \
  --url https://api.paymee.com.br/v1.1/checkout \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data '{
  "amount": 1.99,
  "callbackURL": "https://foo.bar/paymeeListener",
  "currency": "BRL",
  "maxAge": 120,
  "paymentMethod": "ITAU_TRANSFER_PFF",
  "referenceCode": "refcode12345",
  "shopper": {
    "bankDetails": {
      "account": "12345-6",
      "branch": "1234"
    },
    "document": {
      "number": "00000000000",
      "type": "CPF"
    },
    "email": "foo@bar.com.br",
    "name": "JOHN DOE",
    "phone": {
      "number": "11999990000",
      "type": "WORK"
    }
  }
}'
{
  "status": 0,
  "message": "success",
  "response": {
    "amount": 1.99,
    "gatewayURL": "https://secure.paymee.com.br/redir/55f6bb4e-d1aa-361e-bce3-758fd57ab6d0",
    "referenceCode": "refcode12345",
    "saleCode": "0002405",
    "shopper": {
      "bankDetails": {
        "account": "12345-6",
        "branch": "1234"
      },
      "document": {
        "number": "00000000000",
        "type": "CPF"
      },
      "email": "foo@bar.com.br",
      "name": "JOHN DOE",
      "phone": {
        "number": "11999990000",
        "type": "MOBILE"
      }
    },
    "uuid": "55f6bb4e-d1aa-361e-bce3-758fd57ab6d0"
  }
}

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 length: 3
Example:

"BRL"

​
amount
number
required

Order Amount

Example:

1.99

​
referenceCode
string
required

Unique order identifier

Maximum length: 50
Example:

"refcode12345"

​
shopper
object
required
​
maxAge
number

Sale max age in minutes

Required range: x <= 43200
Example:

120

​
paymentMethod
string

Chosen payment method

Example:

"ITAU_TRANSFER_PFF"

​
callbackURL
string

Callback URL for transaction updates

Maximum length: 255
Example:

"https://foo.bar/paymeeListener"

​
observation
string

Any internal reference

Maximum length: 255

Response

200
application/json
Success response
​
message
string
Example:

"success"

​
response
object
​
status
number
Example:

0