PIX_QR

PixQrPayload

Payment Method Identifier

PIX_QR

Description

This method allows you to accept Pix QR payments in Brazil. Pix is the instant payment system regulated by the Brazilian Central Bank. Customers scan a dynamically generated QR code using any Pix-enabled banking or payment app to complete the transfer instantly.

Currency Support

✅ BRL only (`Brazilian Real`)

✅ Required Request Fields

Top-Level Fields

Field	Type	Description
`callbackUrl`	String	URL to receive transaction status updates
`successRedirectUrl`	String	URL to redirect the customer after successful payment
`failureRedirectUrl`	String	URL to redirect the customer after failed payment

Billing Details (ApmBillingDetails)

Field	Type	Description
`firstName`	String	Customer's first name
`lastName`	String	Customer's last name
`address1`	String	First line of the billing address
`city`	String	City of the billing address
`country`	String	Country code in ISO Alpha-2 format
`postalCode`	String	Postal/ZIP code
`phone`	String	Customer's phone number
`email`	String	Customer's email address

Device Information (Device)

Field	Type	Description
`ip`	String	Customer's IP address

Payload Structure

{
  "paymentMethod": "PIX_QR",
  "paymentType": "E_WALLET"
}

Fields

Field	Type	Required	Description
`paymentMethod`	Enum	Yes	Must be `"PIX_QR"`
`paymentType`	Enum	Yes	Must be `"E_WALLET"`

No additional fields are required. All necessary user interaction is handled within the customer's Pix-enabled banking or payment app.

Expected `apmResponseData` (PixQrResponseData)

{
  "paymentMethod": "PIX_QR",
  "paymentType": "E_WALLET",
  "redirectUrl": null,
  "iframeUrl": null,
  "providerTransactionId": "payment-code-external-id",
  "actionType": "QR",
  "qrData": "data:image/png;base64,iVBORw0KGgoAAAA...CYII=",
  "qrDeepLink": "https://transfer-gateway.example.com/v1/notification/transfer"
}

Response Fields

Field	Type	Description
`paymentMethod`	Enum	`"PIX_QR"`
`paymentType`	Enum	`"E_WALLET"`
`redirectUrl`	String (nullable)	Always `null` for `PIX_QR`
`iframeUrl`	String (nullable)	Always `null` for `PIX_QR`
`providerTransactionId`	String (nullable)	Transaction ID from the payment provider
`actionType`	String	Always `"QR"`
`qrData`	String (nullable)	QR code image encoded as a base64 data URI (`data:image/png;base64,...`). Can be used directly in an `<img>` tag: `<img src="$qrData" width="200" height="200" alt="QR Code">`
`qrDeepLink`	String (nullable)	Deep link URL that can be opened on a mobile device to forward the customer to their Pix-enabled app. May be `null` if not returned by the provider.