Create a Ramp

What does this endpoint do?

The purpose of this endpoint is to initiate a ramp process. The flow it follows is determined by the properties you include in the request:

On-ramp: Include cryptoWithdrawalInformation to ensure the cryptocurrency is sent to the correct wallet.
Off-ramp: Include fiatWithdrawalInformation to ensure the funds are sent to the correct PIX key.
Checkout: Do not include either of the above properties.

Refund Configuration & Auto-Refunds

To enable automatic refunds in case of an error during the flow, you must provide the refundCryptoAddress property.

Constraints

The eligibility for an automatic refund depends on when the error occurs:

Before Trade: If the error happens before the exchange takes place, the refund can be processed for any currency pair.
After Trade: If the error happens after the exchange, the automatic refund is supported only for equivalent currency pairs (e.g., BRL-BRZ).

Fees

Please note that the blockchainFee field (in the response) specifically refers to the fee charged by the blockchain network to process the transaction, unrelated to the service fees.

Quote Information

For all processes, note that only one type of quote information should be included. In other words, if quoteId is provided, you must not include quoteRequest.

To correctly provide the quoteId, you must use the Request a Quote endpoint.

Ramp Status

The ramp process can have the following statuses:

SwapOrderCreated: When the process is initiated, and a ramp is created.
DepositReceived: When the initial deposit for the ramp has been received.
TradeCompleted: When the trade process between parties has been successfully executed.
WithdrawalCreated: In on-ramp and off-ramp processes, this indicates the start of the withdrawal process.
WithdrawalProcessing: The ongoing withdrawal process.
WithdrawalCompleted: When the withdrawal process is successfully completed.
SwapOrderCompleted: The final status of the ramp, signifying successful completion
RefundProcessing: Indicates that the refund process has started.
SwapOrderRefunded: Indicates that the refund has been successfully completed.
SwapOrderError: The final status of the ramp when it concludes with an error.