Beneficiários, Pagamentos e Offramp - Bullring Finance API Doc

Visão Geral

Você pode sacar fundos de uma subconta de duas formas:

Pagamentos Fiat: Converta saldos de moedas para moeda local (ex.: NGN, BRL, EUR) e envie para uma conta bancária.
Off-ramp para Stablecoin: Saque USD como stablecoins (USDC/USDT) para uma carteira cripto externa.

Este guia cobre a validação de destinatários, criação de beneficiários e iniciação de saques.

1. Validar Detalhes do Destinatário (Fiat)

Endpoint: POST /v1/banking/{currency}/validate Antes de adicionar um destinatário para saques fiat, é crucial validar os detalhes da conta. Isso garante que a conta existe e previne transações falhas ou fundos perdidos.

Sempre valide os números de conta e códigos bancários antes de tentar criar um destinatário.

Exemplo: Validar Conta NGN

curl -X POST "https://api.bullring.finance/v1/banking/ngn/validate" \
  -H "Authorization: Bearer <SUA_CHAVE_DE_API>" \
  -H "Content-Type: application/json" \
  -d '{
    "accountNumber": "0062881117",
    "bankCode": "270"
  }'

Resposta:

{
  "accountNumber": "0062881117",
  "bankCode": "270"
}

Ver Referência da API

2. Criar Destinatário

Endpoint: POST /v1/ramp/{subaccountId}/banking/recipients Uma vez validado, salve os detalhes como um destinatário. Este id de destinatário será usado para iniciar saques.

Exemplo: Criar Destinatário NGN

curl -X POST "https://api.bullring.finance/v1/ramp/<ID_DA_SUBCONTA>/banking/recipients" \
  -H "Authorization: Bearer <SUA_CHAVE_DE_API>" \
  -H "Content-Type: application/json" \
  -d '{
    "currency": "NGN",
    "account_number": "0062881117",
    "account_owner_name": "João Silva",
    "bank_code": "270",
    "bank_name": "Access Bank",
    "country": "NG"
  }'

Resposta:

{
  "id": "f4725e12-466f-49fd-89bd-899635f3f7f6",
  "bank_name": "Access Bank",
  "account_owner_name": "João Silva",
  "last_4": "1117",
  "active": true,
  "account_id": "0062881117",
  "currency": "NGN"
}

Ver Referência da API

3. Iniciar Pagamento Fiat

Endpoint: POST /v1/ramp/{subaccountId}/banking/withdrawals Envie fundos da subconta para o destinatário criado. O sistema deduzirá o saldo apropriado de moeda da subconta.

Exemplo: Sacar para Destinatário NGN

curl -X POST "https://api.bullring.finance/v1/ramp/<ID_DA_SUBCONTA>/banking/withdrawals" \
  -H "Authorization: Bearer <SUA_CHAVE_DE_API>" \
  -H "Content-Type: application/json" \
  -d '{
    "account_id": "0062881117",
    "amount": "50",
    "currency": "NGN"
  }'

Nota: O campo amount especifica o valor na moeda de destino (ex.: NGN). O saldo equivalente será deduzido das participações em moeda da subconta.

Resposta:

{
  "id": "856b896f-3f16-4f70-952d-ce1f65b28aaa",
  "amount": "50",
  "currency": "NGN",
  "status": "pending",
  "created_at": "2025-11-21T15:59:09.341Z",
  "protocol": "wire",
  "fee_amount": "0.50",
  "fee_currency": "USD",
  "rate": 1500.00
}

Ver Referência da API

4. Off-ramp para Stablecoin (Saque Cripto)

Endpoint: POST /v1/ramp/{subaccountId}/banking/withdrawals/stablecoin Você também pode sacar saldos diretamente como stablecoins (USDC ou USDT) para um endereço de carteira externo.

Exemplo: Sacar USDT na Ethereum

curl -X POST "https://api.bullring.finance/v1/ramp/<ID_DA_SUBCONTA>/banking/withdrawals/stablecoin" \
  -H "Authorization: Bearer <SUA_CHAVE_DE_API>" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "100",
    "stablecoin": "usdt",
    "chain": "ethereum",
    "address": "0x22ccb74a200d7b8094b72482edd46e23cbf3af37"
  }'

Resposta:

{
  "id": "acbad679-7fcf-44a5-be65-dfa27a824113",
  "amount": "100.00",
  "currency": "USD",
  "status": "pending",
  "chain": "ethereum",
  "local_currency": "usdt",
  "destinationAddress": "0x22ccb74a200d7b8094b72482edd46e23cbf3af37",
  "tx_hash": null
}

Ver Referência da API

Erros Comuns

Pular Validação: Não validar os detalhes da conta bancária frequentemente leva a saques falhos e atrasos desnecessários.
Rede Incorreta: Ao sacar stablecoins, certifique-se de que a chain corresponde à carteira de destino (ex.: enviar USDT ERC-20 para um endereço TRC-20 resultará em perda de fundos).
Saldo Insuficiente: Certifique-se de que a subconta tem saldo suficiente na moeda relevante para cobrir o valor do saque mais as taxas.
Subcontas não verificadas: Saques são permitidos apenas para subcontas com verificação aprovada.

Eventos de Webhook

Escute os eventos de webhook para acompanhar o status dos seus saques em tempo real.

withdrawal.status.completed: Os fundos chegaram com sucesso ao destino.
withdrawal.status.failed: O saque não pôde ser processado.

Veja Eventos de Saque para detalhes do payload.

​Visão Geral

​1. Validar Detalhes do Destinatário (Fiat)

​Exemplo: Validar Conta NGN

​2. Criar Destinatário

​Exemplo: Criar Destinatário NGN

​3. Iniciar Pagamento Fiat

​Exemplo: Sacar para Destinatário NGN

​4. Off-ramp para Stablecoin (Saque Cripto)

​Exemplo: Sacar USDT na Ethereum

​Erros Comuns

​Eventos de Webhook

Visão Geral

1. Validar Detalhes do Destinatário (Fiat)

Exemplo: Validar Conta NGN

2. Criar Destinatário

Exemplo: Criar Destinatário NGN

3. Iniciar Pagamento Fiat

Exemplo: Sacar para Destinatário NGN

4. Off-ramp para Stablecoin (Saque Cripto)

Exemplo: Sacar USDT na Ethereum

Erros Comuns

Eventos de Webhook