Make a Pix payment

post

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

Creates a new Pix Payment request for a given pix key destination.

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

pix_key_type

string

pix_key_value

string

pix_message

string

first_name

string

First name of the one being charged. Highly recommended

last_name

string

Last name of 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.

string

Email address for the one being charged. Highly recommended

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 receive the payment.

bank_accounts_allowed

birth_date

string

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

Responses

Language

Credentials

Bearer

Loading…

Response

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

application/json

200

422Unprocessable Entity