PIX

Brazilian instant payment system. Used for pay-in and pay-out in Brazil.

PIX is Brazil's instant payment rail operated by the Banco Central do Brasil. When used as an origin, it generates a QR code and a PIX copy-paste code that the user scans or copies to complete the payment.

Country: Brazil | Currency: BRL | Direction: Pay-in / Pay-out

Required fields

Field	Type	Description
type	string	Must be "PIX"
currency	string	Must be "BRL"
pix.customer.firstName	string	Payer's first name
pix.customer.lastName	string	Payer's last name
pix.customer.email	string	Payer's email
pix.customer.documentNumber	string	Brazilian CPF (11 digits)
pix.successUrl	string	Redirect URL on success
pix.failedUrl	string	Redirect URL on failure

Example

{
  "type": "PIX",
  "currency": "BRL",
  "pix": {
    "successUrl": "https://yourapp.com/success",
    "failedUrl": "https://yourapp.com/failed",
    "customer": {
      "firstName": "João",
      "lastName": "Silva",
      "email": "[email protected]",
      "documentNumber": "12345678901"
    }
  }
}

Response fields

After the payment is created, the pix object in the response includes:

Field	Description
qrCode	Base64-encoded QR code image
data	PIX copy-paste code (EMV string)
expiredAt	Expiration timestamp (UTC)

Show the qrCode or data to your user so they can complete the payment in their banking app.

Schema

The pix object

Attributes

PIX rail payload for Brazil pay-ins and payouts.

datastringRequired

The actual PIX code (EMV-compliant string) that represents the payment. This is what is known as the 'PIX' in Brazil and can be copied and pasted instead of scanning.

qrCodestringOptional

The rendered QR code string that can be scanned for PIX payments.

expiredAtstring · date-timeOptional

The expiration date and time of the QR code. UTC format.

instructionsstringOptional

Optional instructions displayed to the user for completing the PIX payment.

successUrlstringOptional

Redirect url in case of success

failedUrlstringOptional

Redirect url in case of failure

The pix object

{
  "data": "text",
  "qrCode": "text",
  "expiredAt": "2026-03-05T21:31:35.244Z",
  "instructions": "text",
  "customer": {
    "id": "text",
    "firstName": "text",
    "email": "text",
    "lastName": "text",
    "phoneNumber": "text",
    "phoneNumberPrefix": "text",
    "documentType": "text",
    "documentNumber": "text",
    "address": {
      "administrativeAreaLevel1": "text",
      "administrativeAreaLevel2": "text",
      "administrativeAreaLevel3": "text",
      "street": "text",
      "streetNumber": "text",
      "optionalAddress": "text",
      "country": "text",
      "zipcode": "text"
    }
  },
  "successUrl": "text",
  "failedUrl": "text"
}