Exirom Payment API Documentation

Payment Method Identifier: PIX_QR | Payment Type: BANK_TRANSFER

PIX payouts send BRL to a recipient's PIX key through POST /api/v1/payouts/apm.

#Request Payload

#Request Fields

Field	Type	Required	Description
`paymentMethod`	String	Yes	Must be `PIX_QR`
`paymentType`	String	Yes	Must be `BANK_TRANSFER`
`pixKeyType`	String	Yes	`Email`, `CPF`, `EVP`, or `Phone`; values are case-insensitive
`pixKey`	String	Yes	Recipient key matching `pixKeyType`

{
  "paymentMethod": "PIX_QR",
  "paymentType": "BANK_TRANSFER",
  "pixKeyType": "Phone",
  "pixKey": "+5511999999999"
}

#Direct Response

The direct response has actionType: NONE; no customer action is required.

{
  "paymentMethod": "PIX_QR",
  "paymentType": "BANK_TRANSFER",
  "actionType": "NONE",
  "providerTransactionId": "pix-payout-123456"
}

#Response Fields

Field	Type	Description
`paymentMethod`	Enum	Always `PIX_QR`
`paymentType`	Enum	Always `BANK_TRANSFER`
`actionType`	Enum	`NONE` for a direct payout
`providerTransactionId`	String	Provider transaction identifier, when available

The initial transaction status may still be asynchronous, so use your callback endpoint or retrieve the payout status.

#Internal Redirect Response

If APM Data Collection is configured, missing recipient fields can be collected through the hosted checkout. You can also request the internal APM redirect flow explicitly. In either case, the initial response has actionType: REDIRECTION; redirect the customer to redirectUrl to continue the same payout.

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

#See Also

APM Payout API — Full request and response schema
Payout Flow — End-to-end payout handling
PIX QR Payment Payload — PIX payment response