Creating a quote
POST /v1/quotes for offramp. What to send, what comes back, what this call does not do.
The starting point of the offramp. The call creates a quote with a 5-minute TTL. It does not create a conversion and does not issue a deposit address.
Prerequisites
- End customer with KYC approved. Without an approved KYC, the quote fails with a validation error. See KYC flow.
- Destination Pix key registered on the end customer.
- Amount: USDT (
source_amount) or BRL (target_amount).
The call
POST /v1/quotes
The body carries the end customer (user_id), the type (pix_offramp), the amount, and the destination Pix key. Exact fields land in the API reference.
What comes back
The response carries:
id: stable quote identifier.exchange_rate: the applied USDT → BRL rate, considering the fee mode configured for your organization.source_amountandtarget_amount: USDT and BRL implied.expires_at: timestamp at which the quote stops being acceptable.
The exposed rate depends on your organization's fee mode.
What does not come back
- Deposit address. The address is only issued at accept. See Accepting the quote.
- Conversion. Quotes do not create conversions.
- Limit reservation. Reservation happens at accept.
5-minute TTL, prominent
The quote is valid for 5 minutes from creation. If your UX needs more time between getting the rate and the end customer confirming, quote again at accept, do not try to extend the validity.
Don't poll quotes
A quote does not change state. If you need a newer rate, create another quote. Polling quotes brings no new information and consumes quota.
Common errors
- End customer KYC pending or rejected → validation error with a stable code.
- Invalid or unverified destination Pix key → validation error.
- No permission for
pix_offrampon your organization → authorization error.
The full error taxonomy lands in the API reference once published.
Reference coming soon
Detailed response and error documentation will appear here alongside API availability. For the conceptual design, see Quote.
Next step
- Accepting the quote: converts the quote into a conversion and generates the deposit address.
