Solicitar saque

curl --request POST \
  --url https://api.alphagateway.com.br/v1/pix-out/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "idempotency": "saque-2001",
  "value": 250,
  "description": "Saque para conta da empresa",
  "destination": {
    "pixKey": "financeiro@exemplo.com.br",
    "pixType": "EMAIL"
  },
  "customer": {
    "fullName": "Exemplo Serviços Ltda",
    "document": "11222333000181"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotency: 'saque-2001',
    value: 250,
    description: 'Saque para conta da empresa',
    destination: {pixKey: 'financeiro@exemplo.com.br', pixType: 'EMAIL'},
    customer: {fullName: 'Exemplo Serviços Ltda', document: '11222333000181'}
  })
};

fetch('https://api.alphagateway.com.br/v1/pix-out/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.alphagateway.com.br/v1/pix-out/create"

payload = {
    "idempotency": "saque-2001",
    "value": 250,
    "description": "Saque para conta da empresa",
    "destination": {
        "pixKey": "financeiro@exemplo.com.br",
        "pixType": "EMAIL"
    },
    "customer": {
        "fullName": "Exemplo Serviços Ltda",
        "document": "11222333000181"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alphagateway.com.br/v1/pix-out/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotency' => 'saque-2001',
    'value' => 250,
    'description' => 'Saque para conta da empresa',
    'destination' => [
        'pixKey' => 'financeiro@exemplo.com.br',
        'pixType' => 'EMAIL'
    ],
    'customer' => [
        'fullName' => 'Exemplo Serviços Ltda',
        'document' => '11222333000181'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "message": "Saque solicitado com sucesso! Aguardando processamento.",
  "response": {
    "transactionId": "01961234-abcd-7000-8000-000000000002",
    "status": "ANALYSIS",
    "idempotency": "saque-2001",
    "valueRequested": 250,
    "valueFee": 0.35,
    "valueLiquid": 250.35
  }
}

{
  "response": null,
  "errors": [
    "O valor da transação deve ser maior ou igual a R$1,00"
  ]
}

{
  "response": null,
  "errors": [
    "API key inválida ou expirada"
  ]
}

{
  "response": null,
  "errors": [
    "Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."
  ]
}

{
  "response": null,
  "errors": [
    "Limite de requisições excedido"
  ]
}

{
  "response": null,
  "errors": [
    "Erro interno"
  ]
}

{
  "response": null,
  "errors": [
    "Este serviço está temporariamente indisponível devido a manutenção"
  ]
}

POST

pix-out

create

Solicitar saque

curl --request POST \
  --url https://api.alphagateway.com.br/v1/pix-out/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "idempotency": "saque-2001",
  "value": 250,
  "description": "Saque para conta da empresa",
  "destination": {
    "pixKey": "financeiro@exemplo.com.br",
    "pixType": "EMAIL"
  },
  "customer": {
    "fullName": "Exemplo Serviços Ltda",
    "document": "11222333000181"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotency: 'saque-2001',
    value: 250,
    description: 'Saque para conta da empresa',
    destination: {pixKey: 'financeiro@exemplo.com.br', pixType: 'EMAIL'},
    customer: {fullName: 'Exemplo Serviços Ltda', document: '11222333000181'}
  })
};

fetch('https://api.alphagateway.com.br/v1/pix-out/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.alphagateway.com.br/v1/pix-out/create"

payload = {
    "idempotency": "saque-2001",
    "value": 250,
    "description": "Saque para conta da empresa",
    "destination": {
        "pixKey": "financeiro@exemplo.com.br",
        "pixType": "EMAIL"
    },
    "customer": {
        "fullName": "Exemplo Serviços Ltda",
        "document": "11222333000181"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alphagateway.com.br/v1/pix-out/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotency' => 'saque-2001',
    'value' => 250,
    'description' => 'Saque para conta da empresa',
    'destination' => [
        'pixKey' => 'financeiro@exemplo.com.br',
        'pixType' => 'EMAIL'
    ],
    'customer' => [
        'fullName' => 'Exemplo Serviços Ltda',
        'document' => '11222333000181'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "message": "Saque solicitado com sucesso! Aguardando processamento.",
  "response": {
    "transactionId": "01961234-abcd-7000-8000-000000000002",
    "status": "ANALYSIS",
    "idempotency": "saque-2001",
    "valueRequested": 250,
    "valueFee": 0.35,
    "valueLiquid": 250.35
  }
}

{
  "response": null,
  "errors": [
    "O valor da transação deve ser maior ou igual a R$1,00"
  ]
}

{
  "response": null,
  "errors": [
    "API key inválida ou expirada"
  ]
}

{
  "response": null,
  "errors": [
    "Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."
  ]
}

{
  "response": null,
  "errors": [
    "Limite de requisições excedido"
  ]
}

{
  "response": null,
  "errors": [
    "Erro interno"
  ]
}

{
  "response": null,
  "errors": [
    "Este serviço está temporariamente indisponível devido a manutenção"
  ]
}

Autorizações

x-api-key

string

header

obrigatório

API Key da organização

Corpo

application/json

idempotency

string

obrigatório

Identificador único do saque por organização. Garante que o mesmo saque não seja criado duas vezes.

Minimum string length: 1

value

number

obrigatório

Valor do saque em reais, com até duas casas decimais (ex.: 250.00). Mínimo R$ 1,00 e máximo R$ 10.000,00 por saque.

Intervalo obrigatório: 1 <= x <= 10000

destination

object

obrigatório

Chave PIX de destino do saque.

Show child attributes

customer

object

obrigatório

Titular da chave de destino: fullName e document (CPF/CNPJ) são obrigatórios.

Show child attributes

description

string

Descrição opcional do saque.

Resposta

Requisição processada com sucesso

response

object

obrigatório

Dados retornados pela operação; null quando não há conteúdo.

Show child attributes

message

string

obrigatório

Mensagem que descreve o resultado.