Exirom Payment API Documentation

Payment Method Identifier: PIX_QR | Payment Type: BANK_TRANSFER

PIX QR is a Brazilian bank-transfer payment method. It is available for BRL payments through POST /api/v1/payments/apm.

#Request Payload

PIX QR has no method-specific direct request fields.

#Request Fields

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

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

#Direct Response

When customer action is required, apmResponseData.actionType is QR. Render qrData as the QR image and offer qrValue as the copy-and-paste value. The transaction remains in CUSTOMER_VERIFICATION until the customer pays or the payment expires.

{
  "paymentMethod": "PIX_QR",
  "paymentType": "BANK_TRANSFER",
  "actionType": "QR",
  "providerTransactionId": "pix-order-123456",
  "qrData": "data:image/png;base64,iVBORw0KGgo...",
  "qrValue": "00020101021226850014br.gov.bcb.pix...",
  "customerInstructionsByLanguage": {
    "en": "## How to pay\n\n### Method 1\n\nScan the QR code with your payment app and complete the transaction\n\n### Method 2\n\n1. Click the button and copy the code to clipboard\n2. Open your payment app and paste the copied code\n3. Confirm the payment in the app",
    "pt": "## Como pagar\n\n### Método 1\n\nEscaneie o código QR com seu aplicativo de pagamentos e conclua a transação\n\n### Método 2\n\n1. Clique no botão e copie o código\n2. Abra seu aplicativo de pagamentos e cole o código copiado\n3. Confirme o pagamento no aplicativo"
  }
}

#Response Fields

Field	Type	Description
`paymentMethod`	Enum	Always `PIX_QR`
`paymentType`	Enum	Always `BANK_TRANSFER`
`actionType`	Enum	`QR` when the customer must complete the payment
`providerTransactionId`	String	Provider transaction identifier, when available
`qrData`	String	Base64-encoded QR image data, when available
`qrDeepLink`	String	Optional deep link for a compatible payment app
`qrValue`	String	PIX copy-and-paste payment value
`customerInstructionsByLanguage`	Object	Markdown instructions keyed by language: `en` (English), `pt` (Portuguese)

Show the selected language, falling back to English and then the first available translation. When the map is absent or empty, omit the instructions block. Render Markdown safely with raw HTML disabled. The hosted checkout offers language selection for payment instructions only; payment details and other checkout labels do not change.

#Internal Redirect Response

If the internal APM redirect flow is required, the initial response has actionType: REDIRECTION. Redirect the customer to redirectUrl to continue the same transaction.

{
  "paymentMethod": "PIX_QR",
  "paymentType": "BANK_TRANSFER",
  "actionType": "REDIRECTION",
  "redirectUrl": "https://checkout.example.com/?token=...",
  "providerTransactionId": "pix-order-123456"
}

#See Also

APM Payment API — Full request and response schema
QR Payments — QR handling guidance
PIX Payout Payload — PIX payout fields