💸 Documentação da API Royal Gate – Cash Out (Pix de Saída)

Solicitação de Saques (Pix de Saída)

Endpoint: https://api.royalgate.com.br/c1/cashout/

🔍 Descrição

Este endpoint permite realizar requisições de saque via Pix, com:

• 🔹 Autenticação por API Key em Basic Auth.
• 🔹 Validação de IP autorizado.
• 🔹 Cálculo de taxas e saldo líquido antes do saque.

📥 Parâmetros da Requisição (JSON)

Campo	Tipo	Obrigatório	Descrição
api_key	string	Sim	Chave de API do usuário para autenticação.
amount	number	Sim	Valor do saque solicitado em reais (ex: 410.95).
pixKey	string	Sim	Chave Pix para receber o valor (ex: CPF, e-mail, telefone ou chave aleatória).
pixType	string	Sim	Tipo da chave Pix (ex: CPF, E-MAIL, TELEFONE, ALEATORIA).
beneficiaryName	string	Sim	Nome completo do beneficiário (ex: "João da Silva").
beneficiaryDocument	string	Sim	CPF do beneficiário (sem pontuação, ex: "33456787698").
postbackUrl	string	Sim	URL para receber notificações (webhook) sobre o status do saque.

📄 Exemplo de Requisição JSON

{
  "api_key": "YWRtX25ldG86cGFzc3dvcmQ=", 
  "amount": 410.95,
  "pixKey": "33456787698",
  "pixType": "CPF",
  "beneficiaryName": "Adm Neto",
  "beneficiaryDocument": "33456787698",
}

✅ Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações sobre a transação e o saldo atualizado.

Erro

Código	Mensagem	Descrição
401	API Key não fornecida	Cabeçalho de autenticação ausente ou inválido.
401	IP não autorizado	O IP do solicitante não está na lista de IPs permitidos.
422	Dados inválidos	Faltam campos obrigatórios ou valores estão fora do formato esperado.
500	Erro Interno	Problema durante o processamento no servidor.