Usando a Chave Pix

Considerando que uma chave Pix representa uma conta bancária no arranjo Pix, esta é a forma mais direta de realizar um pagamento utilizando o Pix. A única informação que você precisa do cliente é a chave Pix dele. Atualmente, suportamos 5 tipos de chaves e usamos expressões regulares (RegEx) para validar o formato:

Tipo	Expressão Regular (RegEx)	Exemplo
Email	^[a-z0-9.!#$&'*+\/=?^_\{\}~-]+@[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)*$	[email protected]
Telefone	^\+[1-9][0-9]\d{1,14}$	[phone]
CPF (Pessoa Física)	^[0-9]{11}$	12345678901
CNPJ (Pessoa Jurídica)	^[0-9]{14}$	12345678901234
Chave Aleatória	[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}	123e4567-e89b-12d3-a456-426655440000

Gerando um Novo Payout

Ao gerar um novo payout, preste atenção nos seguintes parâmetros (campos obrigatórios):

• bank_account_id (obrigatório): Identificador único da conta bancária associada à conta virtual. Exemplo: "123"

• virtual_account_id (obrigatório): Identificador único da conta virtual que enviará o dinheiro. Exemplo: "456"

• amount (obrigatório): Valor da transação em centavos. Exemplo: 10000

• currency (obrigatório): Moeda da transação. Exemplo: "BRL"

• pix_key (obrigatório): Chave Pix do destinatário (pode ser e-mail, CPF, telefone, etc). Exemplo: "[email protected]"

• pix_type (obrigatório): Tipo da chave Pix. Valores possíveis: "key", "brcode" ou "manual" Exemplo: "key"

• description (opcional): Descrição da transação. Exemplo: "Saque via PIX"

• reference (obrigatório): Identificador único para controle de idempotência. Exemplo: "ref-001"

Requisição:

POST https://api.sandbox.aurixpay.ws/banking/v1/cashout/pix

Payload de Exemplo:

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

Respostas

Sucesso (HTTP 201):

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