BRLP

curl "https://sandbox.brlp.io/api/v1/getAssetPrice?assetId=1&fiatCurrency=BRL"

{
  "success": true,
  "error": null,
  "data": {
    "price": 5.42,
    "pair": "USDC/BRL",
    "baseCurrency": "USDC",
    "quoteCurrency": "BRL"
  }
}

BRLP é a camada de precificação e conversão da PagFinance pareada ao real brasileiro (BRL). Este grupo reúne a precificação em BRL e o saque BRLP para que você trate a URL base do BRLP como uma preocupação isolada na sua integração.

No futuro, o domínio sandbox.brlp.io hospedará exclusivamente os endpoints focados em BRLP. Planeje sua integração de modo que a URL base do BRLP seja configurável.

Precificação em BRL

Os valores em BRLP derivam do mesmo endpoint de preço, cotado em BRL. Veja o endpoint GET /api/v1/getAssetPrice no grupo Preços para a lista completa de campos.

curl "https://sandbox.brlp.io/api/v1/getAssetPrice?assetId=1&fiatCurrency=BRL"

{
  "success": true,
  "error": null,
  "data": {
    "price": 5.42,
    "pair": "USDC/BRL",
    "baseCurrency": "USDC",
    "quoteCurrency": "BRL"
  }
}

Saque BRLP (Modo B)

POST /api/v1/cashout/withdraw Converte um saldo BRLP em BRL e paga via PIX. É um fluxo síncrono: sem cotação, sem instrução on-chain. Liquida o PIX e reporta de volta com o webhook WITHDRAW_COMPLETED ou WITHDRAW_FAILED.

O saque BRLP é uma capacidade em prévia, habilitada por parceiro (feature flag) e não disponível de forma geral. Solicite acesso à equipe de integração antes de construir sobre ele.

string

obrigatório

Bearer <token> (JWT de usuário final com KYC aprovado).

number

obrigatório

O valor em BRL a sacar (igual à quantidade de BRLP, 1:1).

string

obrigatório

A chave PIX do beneficiário.

string

obrigatório

O endereço BRLP do solicitante. Deve corresponder à carteira do usuário autenticado.

string

Nota opcional.

string

O id do saque, usado para consultar status e correlacionar o webhook.

string

O status do saque.

number

O valor bruto em BRL.

number

A taxa aplicada.

number

O valor líquido em BRL pago.

curl -X POST https://sandbox.brlp.io/api/v1/cashout/withdraw \
  -H "Authorization: Bearer <token>" \
  -H "Idempotency-Key: 9a8b7c6d-..." \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 250.00,
    "pixKey": "user@example.com",
    "walletAddress": "7NaNvh..."
  }'

{
  "success": true,
  "error": null,
  "data": {
    "withdrawId": "wd_ab12...",
    "status": "COMPLETED",
    "amount": 250.00,
    "fee": 1.25,
    "netAmount": 248.75,
    "pixKey": "user@example.com",
    "estimatedAt": "2026-08-03T12:00:10.000Z"
  }
}

Consulte o status com GET /api/v1/cashout/withdraw/:withdrawId, ou liste com GET /api/v1/cashout/withdrawals?limit=20&cursor=<id>. Um saldo BRLP insuficiente retorna 422 com o código INSUFFICIENT_BRLP_BALANCE.

curl "https://sandbox.brlp.io/api/v1/getAssetPrice?assetId=1&fiatCurrency=BRL"

{
  "success": true,
  "error": null,
  "data": {
    "price": 5.42,
    "pair": "USDC/BRL",
    "baseCurrency": "USDC",
    "quoteCurrency": "BRL"
  }
}

Comece Aqui

Usuários

Parceiros e API Keys

Taxas e repasse

KYC

Preços

Cash-out (offramp)

Cash-in (onramp)

Recibos

Links

Webhooks

BRLP

Precificação em BRL

Saque BRLP (Modo B)

​Precificação em BRL

​Saque BRLP (Modo B)

Precificação em BRL

Saque BRLP (Modo B)