Documentação da API Royal Bank - Cashout

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

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

Descrição

Esse endpoint permite realizar requisições de saque via PIX, com autenticação por chave de API, validação de IP autorizado e cálculo de taxas e saldo líquido para cashout.

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.
pixKey	string	Sim	Chave pix para recebimento.
pixType	string	Sim	Tipo da chave.
beneficiaryName	string	Sim	Nome do beneficiário.
beneficiaryDocument	string	Sim	CPF do beneficiário
beneficiaryDocument	string	Não	Descrição
postbackUrl	string	Sim	URL de retorno para notificações de atualização.

Exemplo Json de Envio

 
        {
          "api-key": "81bb141a-1746-49a8-basdasdas4a-c3b8dasdasdasaa0d2259" ,
          "name": "adm neto",
          "cpf": "33456787698"
          "keypix": "7029132323669492",
          "amount": 410.95
        }
                

Respostas da API

Sucesso

Código: 200 OK

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

Erros

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á autorizado.
422	Dados inválidos	Faltam dados obrigatórios ou o valor é inválido.

Documentação da API Royal Bank - Webhook para Transações

Este webhook permite que o sistema receba notificações de transações de depósito e saque via JSON.

Endpoint

https://seuservidor.com/webhook.php

Descrição

Este webhook recebe notificações automáticas para depósitos e saques, fornecendo dados detalhados das transações. No caso de um depósito, o campo paymentCode pode ser usado para gerar um QR Code para pagamento.

Estrutura JSON da Requisição

1. Depósito

Campo	Tipo	Descrição
id	integer	ID da transação
user_id	integer	ID do usuário
externalreference	string	Referência externa da transação
amount	float	Valor do depósito
client_name	string	Nome do cliente
client_document	string	Documento do cliente
client_email	string	Email do cliente
data_registro	string	Data de registro da transação
adquirente_ref	string	Referência do adquirente
status	string	Status da transação
idtransaction	string	ID da transação de pagamento
paymentcode	string	Código para gerar QR Code de pagamento
paymentCodeBase64	string	QRCode em Base64
taxa_deposito	float	Taxa aplicada ao depósito
taxa_adquirente	float	Taxa do adquirente
deposito_liquido	float	Valor líquido do depósito

2. Saque

Campo	Tipo	Descrição
id	integer	ID da transação
user_id	integer	ID do usuário
externalreference	string	Referência externa da transação
amount	float	Valor do saque
beneficiaryname	string	Nome do beneficiário
beneficiarydocument	string	Documento do beneficiário
pix	string	Chave Pix
type	string	Tipo de saque
pixkey	string	Chave Pix
date	string	Data da transação
status	string	Status da transação
idtransaction	string	ID da transação de pagamento
taxa_cash_out	float	Taxa aplicada ao saque
cash_out_liquido	float	Valor líquido do saque

Exemplo de Código para Implementação do Webhook

O exemplo a seguir ilustra como configurar o webhook para receber e processar as notificações de transações.

 
                // webhook.php
                $data = file_get_contents("php://input");
                $jsonData = json_decode($data, true);
                
                if ($jsonData) {
                    if (isset($jsonData['client_name']) && isset($jsonData['paymentcode'])) {
                        $transactionType = 'Depósito';
                        $paymentCode = $jsonData['paymentcode']; // QR Code pode ser gerado com este código
                    } elseif (isset($jsonData['beneficiaryname']) && isset($jsonData['pixkey'])) {
                        $transactionType = 'Saque';
                    } else {
                        $transactionType = 'Desconhecido';
                    }
                
            echo json_encode(['status' => 'success', 'message' => "$transactionType recebido com sucesso."]);
                } else {
                    http_response_code(400);
                    echo json_encode(['status' => 'error', 'message' => 'Dados inválidos.']);
                }