Redirect checkout

POST

v1.1

checkout

Redirect 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": "[email protected]",
    "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": "[email protected]",
      "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 string length: 3

Example:

"BRL"

amount

number<float>

required

Order Amount

Example:

1.99

referenceCode

string

required

Unique order identifier

Maximum string length: 50

Example:

"refcode12345"

shopper

object

required

Show child attributes

shopper.email

string<email>

required

Shopper's email

Maximum string length: 50

Example:

"[email protected]"

shopper.id

string

Internal shopper identifier

Maximum string length: 255

Example:

"24391203"

shopper.name

string

Shopper's name

Maximum string length: 255

Example:

"JOHN DOE"

shopper.document

object

Show child attributes

shopper.document.type

enum<string>

Shopper's document type

Available options:

CPF,

CNPJ,

OTHER

Example:

"CPF"

shopper.document.number

string

Shopper's document number

Maximum string length: 25

Example:

"00000000000"

shopper.phone

object

Show child attributes

shopper.phone.type

enum<string>

Shopper's phone type

Available options:

MOBILE,

HOME,

WORK,

OTHER

Example:

"WORK"

shopper.phone.number

string

Shopper's phone number

Maximum string length: 25

Example:

"11999990000"

shopper.bankDetails

object

Show child attributes

shopper.bankDetails.branch

string

Shopper's branch number

Maximum string length: 8

Example:

"1234"

shopper.bankDetails.account

string

Shopper's account number

Maximum string length: 25

Example:

"12345-6"

maxAge

number

Sale max age in minutes

Required range: x <= 43200

Example:

120

paymentMethod

string

Chosen payment method

Example:

"ITAU_TRANSFER_PFF"

callbackURL

string<uri>

Callback URL for transaction updates

Maximum string length: 255

Example:

"https://foo.bar/paymeeListener"

observation

string

Any internal reference

Maximum string length: 255

Response

Success response

message

string

Example:

"success"

response

object

Show child attributes

response.amount

number

Example:

1.99

response.gatewayURL

string

Example:

"https://api.paymee.com.br/redir/55f6bb4e-d1aa-361e-bce3-758fd57ab6d0"

response.referenceCode

string

Example:

"refcode12345"

response.saleCode

string

Example:

"0002405"

response.shopper

object

Show child attributes

response.shopper.bankDetails

object

Show child attributes

response.shopper.bankDetails.account

string

Example:

"12345-6"

response.shopper.bankDetails.branch

string

Example:

"1234"

response.shopper.document

object

Show child attributes

response.shopper.document.number

string

Example:

"00000000000"

response.shopper.document.type

string

Example:

"CPF"

response.shopper.email

string

Example:

"[email protected]"

response.shopper.name

string

Example:

"JOHN DOE"

response.shopper.phone

object

Show child attributes

response.shopper.phone.number

string

Example:

"11999990000"

response.shopper.phone.type

string

Example:

"MOBILE"

response.uuid

string

Example:

"55f6bb4e-d1aa-361e-bce3-758fd57ab6d0"

status

number

Example:

0

Individual payout requestPayouts at PayMee are cash-out transactions; Before we start, there are some important tips: 1. you must have sufficient funds; 2. you shoud provide a valid and complete beneficiary details 3. Register your server CIDR for production enviroment

⌘I

Redirect 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": "[email protected]",
    "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": "[email protected]",
      "name": "JOHN DOE",
      "phone": {
        "number": "11999990000",
        "type": "MOBILE"
      }
    },
    "uuid": "55f6bb4e-d1aa-361e-bce3-758fd57ab6d0"
  }
}

API Documentation

Checkout

Payouts

Loan

Transactions

Payment Methods

Financial

Webhooks and Callbacks

Payer Information

Pix Automatic (Recurrence)

Headers

Body

Response