PIX

Rail overview

Use PIX for Brazilian instant payments. As an origin, Conomy returns QR and copy-paste data; as a destination, it routes funds to the recipient key or account.

Pay-ins wait for payer action and provider confirmation. Pay-outs move from an internal ACCOUNT through capture into the PIX network.

Region Brazil

Currency BRL

Direction Pay-in / Pay-out

Model Instant payment rail

For pay-ins, display both the QR code and copy-paste string and listen for payment webhooks instead of polling the banking app state.

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": "joao@example.com",
      "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.

Object

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.

qrCodestring

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

expiredAtstring

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

instructionsstring

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

customerobjectrequired

Details of the customer initiating the payment.

idstring

Unique identifier for the internal service.

firstNamestringrequired

Payer's name

emailstring

Payer's email

lastNamestring

Payer's last name

phoneNumberstring

Payer's phone number without prefix

phoneNumberPrefixstring

Phone number prefix (e.g., +57)

documentTypestring

Documeny type of the entity (e.g., RUT, CURP, CURL). Go to the Supported Identity document types page for the complete list of supported values.

documentNumberstring

The document number associated with the documentType

addressobjectshow 8 properties

The entity’s address information.

successUrlstring

Redirect url in case of success

failedUrlstring

Redirect url in case of failure