Creating a Pix Transaction

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
float
required
Defaults to 1000.85
string
enum
required
Defaults to USD

Currency in which the merchant will receive the funds in your country.

Allowed:
string
required
Defaults to 81594800081

Brazilian Tax ID number, known as "CPF" or "CNPJ" will be used to pay this transaction.

string
Defaults to 123141241231

Your system internal reference.

string
Defaults to 1091

Merchant identifier. Use the identifier of a previously registered merchant, or provide merchant details in the optional merchant object to create or update the merchant in the same request. The identifier may be supplied here or in merchant.merchant_id. If both are provided, they must match.

string
int32
Defaults to 1800
string

Optional field used to display the final merchant’s name to the customer. After the PIX QR Code is scanned, the soft_descriptor is shown to help the customer confirm the transaction recipient before completing the payment.

merchant
object

Optional merchant details. Creates a merchant or updates its name, city and industry for the authenticated account, using merchant_id from the request or this object. The merchant is linked to the transaction. Provide name, city, and either industry or iso_industry. When both industry fields are provided, industry takes precedence.

Headers
string
required
Defaults to 7c6adaa5-2eac-43d1-89d2-46a41cedbe22
Responses

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