Ramp Orders
Create Ramp (Receive Based)
By consuming this endpoint you will be able to create a new ramp for converting your assets.
Headers
| Field | Type | Required | Description |
|---|---|---|---|
| Authorization | Header | Yes | The access token, valid for 5 minutes, is used to authenticate requests to other endpoints. |
| clientId | Query | Yes | Include your assigned ID in the URL, obtainable through the Get infoClient endpoint. |
| idempotency-key | UUID | No | A unique key that prevents duplicate execution of the same request in case of retries. |
Request Body
| Field | Description |
|---|---|
| assetIn | The symbol of the asset you will send (COP, MXN, USD, USDC, USDT) |
| assetOut | The symbol of the asset you want to receive (COP, MXN, USD, USDC, USDT). |
| amountOut | This is the amount that we will send and you will receive as a result of your operation. |
| accountOriginId | The unique ID of your origin Wallet/ Bank Account you selected as the origin for the ramp you are creating. You can obtain the ID using the Get /wallets or Get /accounts endpoint. Please make sure the account status is approved. |
| accountDestinationId | The unique ID of your Wallet/Bank Account you selected as the destination for the ramp you are creating. You can obtain the ID using the Get /wallets or Get /accounts endpoint. Please make sure the account status is approved. |
| paymentMethod | Optional. Applies to ramps involving COP (typically STABLE/COP). Allowed values: pse, bank_transfer, DAVIPLATA, NEQUI or breb. Defaults to bank_transfer when omitted. Use breb to pay or receive COP through Colombia’s Bre-B instant payment network. Requires a registered bank account of type breb. Fiat side must always be COP. |
| transactionPurpose | The purpose or reason for the transaction. This field is used to provide context about the origin of funds or the intent of the transfer |
Response Body
The response will include the status of the request and any relevant data related to the order created.
| Field | Description |
|---|---|
| Id | This is your ramp unique identifier. |
| symbolTypeSent | The symbol of the token/fiat you will send us (COP, MXN, USD, USDC, USDT). |
| symbolTypeReceived | The symbol of the token/fiat we will send you (COP, MXN, USD, USDC, USDT). |
| amountSent | This is the amount you will operate and send to us. |
| numberRamp | This is your ramp tracking number. |
| rampType | The type of order/ ramp you will create (“on_ramp”: if you have Fiat and want to receive Stable Coin; “off_ramp”: if you have Stable Coin and want to receive Fiat). |
| registerDate | This is the date when you created your ramp with us. |
| status | The status of the ramp. It can be: “pending”: Awaiting proof of funds transfer., “payapproved”: Funds received and approved, “payrejected”: The funds transfer does not meet our requirements, “completed”: Transaction successfully completed. “cancelled”: Ramp expired without completion. |
| amountToReceive | This is the amount that we will send and you will receive as a result of your operation. |
| costInfra | This is the infrastructure use cost applied to your transaction. |
| rateClient | This is the rate applied to calculate the transaction. |
| symbolTypeSent | The symbol of the token/fiat you will send us (COP, MXN, USD, USDC, USDT). |
| symbolTypeReceived | The symbol of the token/fiat we will send you (COP, MXN, USD, USDC, USDT, COPM). |
| withdrawalFee | Withdrawal costs related to the transaction. |
| validUntil | This is your ramp’s validity period. Format YYYY-MM-DD HH:MM:SS.ffffff; the ramp expires 10 minutes after creation. |
| accountDestination | Deposit instructions indicating where you should send the funds. |
The
clientIdquery parameter is required: requests without it are rejected with 401.
POST
Create Ramp (Receive Based)
Authorizations
Access token from POST /api/token (valid 5 minutes).
Query Parameters
Body
application/json
Response
200 - application/json
OK