Liquidity Ramps
Create On-Ramp
Creates an on-ramp: the user pays in fiat (COP) and receives the stablecoin in a registered external wallet.
Request
| Field | Type | Required | Description |
|---|---|---|---|
| Authorization | Header | Yes | Bearer <access_token> obtained from POST /api/v1/client/token. |
| user_id | Path | Yes | User who pays and receives the funds. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| amount | number | Yes | Amount of the operation, in COP. |
| symbolOrigin | string | No | Fiat paid (COP). |
| symbolDestination | string | No | Stablecoin delivered (e.g. USDC). |
| paymentMethod | string | No | PSE, NEQUI or DAVIPLATA. Defaults to DAVIPLATA. |
| bankCode | string | No | Bank code from GET /admin/banks. Required for PSE. |
| bankName | string | No | Bank name, for PSE. |
| redirectUrl | string | No | Where the user returns after paying (PSE). |
| phone | string | No | Phone number of the user, for NEQUI / DAVIPLATA. |
| destination | object | Yes | {"type": "EXTERNAL", "externalWalletId": "<uuid>"}. The external wallet must be registered and APPROVED. |
| executionMode | string | No | NORMAL (default) or INVERSE. |
| developerFee | number | No | Additional fee you charge your user. |
Response
The response is an envelope with three keys:
| Field | Description |
|---|---|
| operation | The created operation: id, userId, numberCode, originId, destinationId, symbolOrigin, symbolDestination, amountOrigin, amountDestination, rate, paymentMethod, status, direction, registerDate, depositInstructions, treasuryItems (cost breakdown) and events. |
| tierEscalation | null when the operation fits the user’s current compliance tier. Otherwise it describes the action the user must complete to raise their limits (actionType: FORM_URL, QR_APP, VIDEO_KYC, DOC_UPLOAD, NOTIFY_ONLY or BLOCK, plus actionPayload, message and expiresAt). |
| depositInfo | Present when the user has to send funds: paymentMethod, the applied quote and the depositInstructions. null otherwise. |
Errors
| Status | When |
|---|---|
| 400 | Insufficient funds in the origin. |
| 403 | The user does not exist or is not APPROVED. |
| 422 | Invalid body, amount ≤ 0, asset pair not enabled for your account, destination not registered/approved/owned by the user, or the operation exceeds the user’s compliance tier limits. |
POST
Create On-Ramp
Authorizations
Access token from POST /api/v1/client/token.
Path Parameters
Body
application/json