📚 Documentação da API Royal Banking – Cash In

🚀 Solicitação de Depósito (Cash In)

Para usar a API Pix do RoyalBanking para depósitos, faça uma requisição HTTP POST para:

https://api.royalbanking.com.br/v1/gateway/

📥 Parâmetros Obrigatórios

Campo Tipo Obrigatório Descrição
api-key string Sim Chave de API fornecida pela RoyalBanking.
amount número Sim Valor do pagamento em reais (ex: 100 para R$100,00).
client.name string Sim Nome completo do cliente (ex: "Maria Oliveira").
client.document string Sim CPF sem pontuação (ex: "12345678911").
client.telefone string Sim Telefone sem pontuação (ex: "11999999999").
client.email string Sim E-mail do cliente (ex: "[email protected]").
callbackUrl string Sim URL para receber notificações (webhook) sobre o status do pagamento.

⚙️ Parâmetros Opcionais

Campo Tipo Obrigatório Descrição
split.email string Não Usuário do split (ex: "@teste123").
split.percentage string Não Porcentagem de divisão (ex: "10" para 10%).

📄 Exemplo de Requisição Cash In

{
  "api-key": "81bb141jmdaw9u32-d3q9md3qd-qdwq59",
  "amount": 100,

  "client": {
    "name": "Maria Oliveira",
    "document": "12345678911",
    "telefone": "11999999999",
    "email": "[email protected]"
  },

  "split": {
    "email": "@Teste002",
    "percentage": "50"
  },

  "callbackUrl": "https://exemplo.com/royalbanking/callback"
}

✅ Resposta de Sucesso (200 OK)

Quando a requisição é processada com sucesso, você receberá um JSON contendo detalhes do Pix gerado:

{
  "status": "success",
  "message": "ok",
  "paymentCode": "00020101021226790014br.gov.bcb.pix255/v2/be1920df6b714e4e84edd77d7f25204000039865802BR592**63042CA1",
  "idTransaction": "52fc5262-4063-4900-933b-55e69850",
  "paymentCodeBase64": "iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAACwElEQVR4Xu2XS5IjIQwF4SJw/1vMUeAi..."
}

📋 Códigos de Status e Descrições

Código Mensagem Descrição
200 OK Pix gerado com sucesso.
400 Dados inválidos Campos obrigatórios faltando ou valores fora do permitido.
401 Não Autorizado Api-Key inválida ou IP não autorizado.
200 Método Não Permitido Requisição com método diferente de POST.
500 Erro Interno Falha no processamento do servidor.