Create a Pix charge

Creates a PIX charge and returns the data needed to display the QR Code and complete the payment.


  • The CPF field 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 expired and a webhook notification is triggered.
  • The birth_date field 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_allowed array restricts which banks are authorized to pay the charge.
  • The tag field 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_message is not sent, the gateway automatically fills it with Deposit to: {processor alias}".
  • Transactions with a CNPJ in document_number are 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 amount field respects global limits ("greater than 0 and less than 99,999,999.), but each processor may have its own min_amount and max_amount.
  • The fields email, first_name, last_name, and mobile_phone are optional by default, but may become required depending on the processor's configuration.

Body Params
float
required

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

string
required

Transaction id on the side of the merchant

string

First name of the one being charged. Highly recommended

string

Last name of the one being charged. Highly recommended

string

Email address for the one being charged. Highly recommended

string
required

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

string

Message sent along with the PIX payment.

string

IP address of the one being charged

string

Phone number of the one being charged

bank_accounts_allowed
array of objects

Bank accounts authorized to make the payment.

bank_accounts_allowed
string

Depends on merchant config.

For betting merchants: Tag for categorizing transactions, free to use by the merchant.

For other merchants: Required field. Must contain the CNPJ of the establishment responsible for the transaction.

string

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

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json