Create a Pix charge

post

https://gateway.prd.pppay.cloud/api/pix/charge

Generate a dynamic Pix charge with a QR Code for the user to scan and pay.

Body Params

amount

float

required

Decimal value of the amount being charged (in R$)

merchant_transaction_id

string

required

Transaction id on the side of the merchant

first_name

string

First name of the one being charged. Highly recommended

last_name

string

Last name of the one being charged. Highly recommended

string

Email address for the one being charged. Highly recommended

document_number

string

required

Document number for the one being charged. Usually CPF for people and CNPJ for companies.

message

string

Pix message

ip_address

string

IP address of the one being charged

player_id

string

The player's account number on the platform

phone_number

string

Phone number of the one being charged

bank_accounts_allowed

array of objects

Bank accounts authorized to make the payment.

bank_accounts_allowed

tag

string

Tag for categorizing transactions, free to use by the merchant.

birth_date

string

Format: yyyy-mm-dd. Available only for businesses authorized to transact with minors.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200