Pix Biometric

post

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

Creates a transaction and a widget to initiate the biometric Pix payment flow.

Body Params

amount

float

required

Total amount to be paid

merchant_transaction_id

string

required

ID of the associated merchant

first_name

string

required

Customer’s first name

last_name

string

required

Customer’s last name

string

required

Customer’s email address

document_number

string

required

Customer’s document number

birth_date

string

Customer’s date of birth in the format Y-M-D. Required when the customer is a minor

widget_description

string

required

Description that will appear in the widget for the customer at the time of payment

payer_bank_description

string

required

Description that will appear on the customer’s bank statement

urls_callback

string

Array containing callback URLs

urls_callback.success

string

URL to redirect the customer after the payment is successfully completed in the widget. Required when urls_callback is sent

urls_callback.failure

string

URL to redirect the customer after the payment fails in the widget. Required when urls_callback is sent

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

401Unauthorized

422Unprocessable Entity

500Internal Server Error