Skip to main content
POST
Semi-transparent wire-transfer, pix and credit card and openbanking 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:

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