PIX

Generate a pix payment

post

https://api.aurixpay.wshttps://sandbox.api.aurixpay.ws

/banking/v1/cashout/pix

Initiates a PIX payment from a virtual account. Send account details, amount, PIX key, and description. Requires authentication via API Key. Returns a txid on success (HTTP 201).

scope: pix.cashout

Header parameters

AcceptstringOptionalExample: application/json

Content-TypestringOptionalExample: application/json

X-API-KeystringRequiredExample: {{API_KEY}}

Body

application/json

bank_account_idstringRequired

virtual_account_idstringOptional

amountintegerRequired

currencystringRequired

pix_keystringRequired

pix_typestring · enumRequiredExample: emailPossible values:

descriptionstringRequired

referencestringRequired

Responses

201

Success

application/json

403

Forbidden

application/json

422

Validation

application/json

500

Internal Server Error

application/json

post

/banking/v1/cashout/pix

HTTP

POST /banking/v1/cashout/pix HTTP/1.1
Host: api.aurixpay.ws
X-API-Key: text
Content-Type: application/json
Accept: application/json

{
  "bank_account_id": "0197676a-012d-725c-95fa-b9a54a4536b1",
  "virtual_account_id": "0197676a-013e-7121-b1a5-e720b44c5c95",
  "amount": 1000,
  "currency": "BRL",
  "pix_key": "[email protected]",
  "pix_type": "email",
  "description": "PIX payment",
  "reference": "PIX-2025-001234"
}

{
  "amount": 1000,
  "currency": "BRL",
  "reference": "PIX-2025-001234",
  "pix_key": "[email protected]",
  "pix_type": "email"
}