Skip to main content
POST
Redirect checkout

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
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
status
number
Example:

0