BRLP

In the future, the sandbox.brlp.io domain will exclusively host the endpoints focused on BRLP. This group already brings together the BRLP-related endpoints to make that separation easier. Treat the BRLP base URL as an isolated concern in your integration.

BRLP is PagFinance’s pricing and conversion layer pegged to the Brazilian real (BRL). The endpoints in this group handle the conversion between cryptocurrencies and amounts in BRL that supports local payments (PIX, boleto, and gift card).

BRLP base URL

https://sandbox.brlp.io

https://app.pag.finance

During the transition, the BRLP endpoints may respond both on the main host and on sandbox.brlp.io. Plan your integration so the BRLP base URL is configurable.

BRL price quote

Returns the price of an asset pegged to the Brazilian real. This is the basis for the crypto to BRL conversion.

number

required

Asset identifier.

string

required

Reference fiat currency. For BRLP, use BRL.

number

Asset price in BRL.

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

const price = await client.assets.getAssetPrice({ assetId: 1, fiatCurrency: 'BRL' });

{
  "success": true,
  "data": {
    "assetId": 1,
    "fiatCurrency": "BRL",
    "price": 5.42
  }
}

Accepted crypto configuration

The list of cryptocurrencies accepted for conversion into BRL is part of the BRLP scope.

curl https://sandbox.brlp.io/api/assets/accepted-cryptos

const config = await client.assets.acceptedCryptos();

Conversion and settlement

The execution of the BRL-pegged conversion uses the Payments endpoints (quote, creation, submission, and receipt). As the migration to sandbox.brlp.io progresses, the BRLP conversion endpoints will move to that domain.

Payment flow

Quote, creation, submission, and receipt of the conversion.

Overview

Authentication

Onramp and Offramp

Payments

KYC

Webhooks

BRLP

BRLP base URL

BRL price quote

Accepted crypto configuration

Conversion and settlement

Payment flow

​BRLP base URL

​BRL price quote

​Accepted crypto configuration

​Conversion and settlement

Payment flow

BRLP base URL

BRL price quote

Accepted crypto configuration

Conversion and settlement