# Saque

**Descrição do saque PIX**

O **saque PIX** permite realizar o pagamento via **PIX** a partir de uma conta virtual, utilizando os detalhes fornecidos na requisição. Com isso, o sistema facilita a transferência de valores diretamente para uma chave PIX específica, que pode ser um e-mail, CPF, CNPJ ou número de telefone, de acordo com o tipo de chave fornecido.

Essa funcionalidade é ideal para empresas ou plataformas que desejam realizar pagamentos rápidos e automáticos aos seus usuários ou parceiros por meio do sistema de pagamento instantâneo PIX. Além disso, ela permite o envio de informações adicionais, como descrição da transação e referência, o que facilita o controle e a identificação do pagamento.

#### Como Funciona o saque PIX

O saque PIX é uma operação **POST** realizada na URL:

```
https://api.aurixpay.ws/banking/v1/cashout/pix
```

Ao fazer uma requisição para essa URL, o sistema inicia um pagamento de PIX, utilizando os seguintes dados:

1. **Detalhes da Conta Virtual**:
   * **bank\_account\_id**: ID da conta bancária associada à conta virtual de origem.
   * **virtual\_account\_id**: ID da conta virtual de onde o dinheiro será transferido.
2. **Valor e Moeda**:
   * **amount**: Valor da transação em centavos.
   * **currency**: Moeda utilizada para a transação (exemplo: "BRL" para reais).
3. **Chave PIX**:
   * **pix\_key**: Chave PIX do destinatário (pode ser um e-mail, CPF, CNPJ, número de telefone, etc.).
   * **pix\_type**: Tipo da chave PIX (por exemplo, "email", "cpf", "cnpj").
4. **Informações Adicionais**:
   * **description**: Descrição opcional da transação, que pode ser usada para identificar o pagamento.
   * **reference**: Referência opcional que pode ser utilizada para controle interno da transação.

Quando a requisição é bem-sucedida, o sistema retorna um **txid** (identificador da transação), que pode ser usado para rastrear e confirmar o pagamento. O código de resposta HTTP 201 indica que o pagamento foi iniciado com sucesso.

#### Exemplo de Requisição

```json
{
  "bank_account_id": "0197676a-012d-725c-95fa-b9a54a4536b1",
  "virtual_account_id": "0197676a-013e-7121-b1a5-e720b44c5c95",
  "amount": 1000,
  "currency": "BRL",
  "pix_key": "teste@email.com",
  "pix_type": "email",
  "description": "PIX payment",
  "reference": "PIX-2025-001234"
}
```

#### Respostas da API

* **201 Success**: O pagamento foi iniciado com sucesso e um **txid** será retornado para identificação da transação.
* **403 Forbidden**: Erro de autenticação ou autorização (verifique o API Key).
* **422 Validation**: Falha na validação dos dados enviados (verifique os parâmetros, como chave PIX ou valor da transação).
* **500 Internal Server Error**: Erro interno no servidor.

#### Utilização

O saque PIX é uma excelente opção para pagamentos rápidos e seguros, especialmente para plataformas de pagamento, e-commerces ou soluções que necessitam de uma maneira eficiente de transferir valores aos usuários. A transação é realizada instantaneamente, sem a necessidade de intermediários ou tempos de espera típicos de métodos tradicionais, como transferências bancárias.