Who can get one
Requirements
- The customer is
Activeandfiat_deposit.brl.pixreadsActiveinGET /api/customers/{customer_id}/abilities. See Before you create a virtual account. - The customer is an individual.
brl.pixcan readActivefor a business, but a business can’t open a BRL Autoramp. - The customer has no other BRL Autoramp that isn’t
CancelledorRejected. To move to a new stablecoin or wallet, edit or cancel the existing Autoramp first. - KYC data the PIX provider needs: date of birth and email address, plus a CPF for customers who live in Brazil. Customers who live elsewhere are identified by the number on their identity document.
Create a BRL virtual account
In the dashboard, click New Virtual Account on the Onramp card under Routes and pick BRL. Through the API:POST /api/autoramps requires an Idempotency-Key header. A missing key returns 400. Only successful responses are cached, so a retry after an error runs again. See Idempotency.Authorized until the PIX provider approves the customer’s KYC, then moves to Approved. BRL Autoramps have no provisioning cutoff: they don’t move to Rejected after 72 hours like other Autoramps.
What your customer sees
AnApproved BRL Autoramp returns one Pix entry in deposit_rails:
BR codes with your own reference
To tag a payment, generate a BR code that carries your reference, and optionally a fixed amount, withPOST /api/autoramps/{autoramp_id}/br-code. The Autoramp must be Approved.
200 OK
Calling it again with the same parameters returns the same code. An Autoramp that isn’t
Approved returns 400 with "Autoramp is not approved".
Third-party deposits and pay by reference
PIX accounts accept payments from third parties, but you can’t create a BRL Autoramp flagged as third-party, and BRL Autoramps don’t support pay by reference. In production,fiat_deposit.brl.pix_thirdparty reads Unavailable. Sandbox reports it as Active, but sandbox doesn’t support third-party PIX either. To tell payments apart, use a BR code with your own reference.
Timing
The transaction follows the usual transaction statuses.Fees
The Autoramp’s fee profile decides the fees on each deposit. See Fees on a deposit.What can go wrong
Sandbox
Approve the Autoramp withPUT /api/sandbox/autoramp/{id} and simulate a deposit with POST /api/sandbox/transaction. In sandbox, POST /api/autoramps/{autoramp_id}/br-code returns a placeholder (sandbox-br-code- plus your reference), not a scannable code. See Test the full flow in Sandbox.