PIX

Gerar um pagamento PIX

post

Inicia um pagamento PIX de uma conta virtual. Envie detalhes da conta, valor, chave PIX e descrição. Requer autenticação via API Key. Retorna um txid em caso de sucesso (HTTP 201).

scope: pix.cashout

Header parameters

Content-TypestringOptionalExample: application/json

X-API-KeystringRequiredExample: {{API_KEY}}

Body

bank_account_idstringRequired

virtual_account_idstringRequired

amountintegerRequired

currencystringRequired

pix_keystringRequired

pix_typestring · enumRequiredExample: emailPossible values:

descriptionstringRequired

referencestringRequired

Responses

201

Sucesso

application/json

403

Proibido

application/json

422

Validation

application/json

500

Erro Interno do Servidor

application/json

post

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

{
  "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"
}

PreviousSaque NextTransferência