In the future, the
sandbox.brlp.io domain will exclusively host the BRLP-focused endpoints. Plan your integration so the BRLP base URL is configurable.BRL pricing
BRLP amounts derive from the same price endpoint, quoted in BRL. See theGET /api/v1/getAssetPrice endpoint in the Prices group for the full field list.
BRLP withdraw (Mode B)
POST /api/v1/cashout/withdraw
Converts a BRLP balance to BRL and pays it out via PIX. This is a synchronous flow: no quote, no on-chain instruction. It settles the PIX and reports back with the WITHDRAW_COMPLETED or WITHDRAW_FAILED webhook.
string
required
Bearer <token> (end-user JWT with approved KYC).number
required
The BRL amount to withdraw (equal to the BRLP quantity, 1:1).
string
required
The beneficiary PIX key.
string
required
The requester’s BRLP address. Must match the authenticated user’s wallet.
string
Optional note.
string
The withdraw id, used to check status and to correlate the webhook.
string
The withdraw status.
number
The gross BRL amount.
number
The fee applied.
number
The net BRL amount paid out.
Check status with
GET /api/v1/cashout/withdraw/:withdrawId, or list with GET /api/v1/cashout/withdrawals?limit=20&cursor=<id>. An insufficient BRLP balance returns 422 with code INSUFFICIENT_BRLP_BALANCE.