post
https://gateway.prd.pppay.cloud/api/pix/charge
Creates a PIX charge and returns the data needed to display the QR Code and complete the payment.
- The
CPFfield must be valid. - The generated QR Code expires in 15 minutes.
- The QR Code expires 15 minutes after creation and can no longer be scanned or paid after that point. However, the charge itself remains in the system for up to 2 hours, after which it is marked as
expiredand a webhook notification is triggered.
- The QR Code expires 15 minutes after creation and can no longer be scanned or paid after that point. However, the charge itself remains in the system for up to 2 hours, after which it is marked as
- The
birth_datefield is required for merchants authorized to process transactions involving minors. If provided:- If it matches the CPF submitted, the charge will be created normally.
- If it does not match, a validation error will be returned.
- When provided, the
bank_accounts_allowedarray restricts which banks are authorized to pay the charge. - The
tagfield is used to categorize transactions:- Betting Platforms: Optional. Used solely for transaction categorization.
- Other markets: Required. Must contain the CNPJ of the establishment responsible for the transaction.
Business rule notes
- If
pix_messageis not sent, the gateway automatically fills it with Deposit to: {processor alias}". - Transactions with a CNPJ in
document_numberare subject to the merchant's configuration — the CNPJ may not be allowed or may be restricted to a specific list, returning 422 if unauthorized. - Duplicate transactions (same amount, same payer, within the interval configured by the processor) return 409.
- The
amountfield respects global limits ("greater than 0 and less than 99,999,999.), but each processor may have its ownmin_amountandmax_amount. - The fields
email,first_name,last_name, andmobile_phoneare optional by default, but may become required depending on the processor's configuration.
