Liquidity Ramps
Create Deposit
Creates a deposit: the user pays in fiat and receives the corresponding digital asset. The destination decides the flow:
- Custody (
accountId, or neither field): the asset is credited to one of the user’s custody wallets. - External wallet (
destination): an on-ramp. The asset is delivered to a registered external wallet. Available for COP withPSE,NEQUIorDAVIPLATA.
Do not send accountId and destination together.
Request
| Field | Type | Required | Description |
|---|---|---|---|
| Authorization | Header | Yes | Bearer <access_token> obtained from POST /api/v1/client/token. |
| user_id | Path | Yes | User who makes the deposit. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| amount | number | Yes | Amount to deposit. |
| accountId | uuid | No | Destination custody wallet of the user. |
| destination | object | No | {"type": "EXTERNAL", "externalWalletId": "<uuid>"}: deliver to a registered, APPROVED external wallet (on-ramp). |
| symbolOrigin | string | No | Fiat paid (e.g. COP, USD). |
| symbolDestination | string | No | Asset credited (e.g. COPM, USDC). |
| paymentMethod | string | No | PSE (default), BREB, NEQUI, DAVIPLATA, ACH, WIRE or SWIFT. With destination: PSE, NEQUI or 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, for NEQUI / DAVIPLATA. |
| quoteId | uuid | No | Quote to lock the rate. |
| executionMode | string | No | NORMAL (default) or INVERSE. |
| developerFee | number | No | Additional fee you charge your user. |
On-ramp body example:
{
"amount": 50000,
"symbolOrigin": "COP",
"symbolDestination": "USDC",
"paymentMethod": "PSE",
"bankCode": "1303",
"destination": {
"type": "EXTERNAL",
"externalWalletId": "{{external_wallet_id}}"
}
}
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 (both accountId and destination), payment method not available for an external wallet, 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
/
api
/
v1
/
admin
/
operation
/
{user_id}
/
deposit
Create Deposit
curl --request POST \
--url https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 500000,
"symbolOrigin": "USD",
"accountId": "{{wallet_id}}",
"paymentMethod": "BREB",
"redirectUrl": "https://app.kravata.co/",
"bankCode": "1022"
}
'import requests
url = "https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit"
payload = {
"amount": 500000,
"symbolOrigin": "USD",
"accountId": "{{wallet_id}}",
"paymentMethod": "BREB",
"redirectUrl": "https://app.kravata.co/",
"bankCode": "1022"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 500000,
symbolOrigin: 'USD',
accountId: '{{wallet_id}}',
paymentMethod: 'BREB',
redirectUrl: 'https://app.kravata.co/',
bankCode: '1022'
})
};
fetch('https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 500000,
'symbolOrigin' => 'USD',
'accountId' => '{{wallet_id}}',
'paymentMethod' => 'BREB',
'redirectUrl' => 'https://app.kravata.co/',
'bankCode' => '1022'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit"
payload := strings.NewReader("{\n \"amount\": 500000,\n \"symbolOrigin\": \"USD\",\n \"accountId\": \"{{wallet_id}}\",\n \"paymentMethod\": \"BREB\",\n \"redirectUrl\": \"https://app.kravata.co/\",\n \"bankCode\": \"1022\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 500000,\n \"symbolOrigin\": \"USD\",\n \"accountId\": \"{{wallet_id}}\",\n \"paymentMethod\": \"BREB\",\n \"redirectUrl\": \"https://app.kravata.co/\",\n \"bankCode\": \"1022\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 500000,\n \"symbolOrigin\": \"USD\",\n \"accountId\": \"{{wallet_id}}\",\n \"paymentMethod\": \"BREB\",\n \"redirectUrl\": \"https://app.kravata.co/\",\n \"bankCode\": \"1022\"\n}"
response = http.request(request)
puts response.read_bodyCreate Deposit
curl --request POST \
--url https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 500000,
"symbolOrigin": "USD",
"accountId": "{{wallet_id}}",
"paymentMethod": "BREB",
"redirectUrl": "https://app.kravata.co/",
"bankCode": "1022"
}
'import requests
url = "https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit"
payload = {
"amount": 500000,
"symbolOrigin": "USD",
"accountId": "{{wallet_id}}",
"paymentMethod": "BREB",
"redirectUrl": "https://app.kravata.co/",
"bankCode": "1022"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 500000,
symbolOrigin: 'USD',
accountId: '{{wallet_id}}',
paymentMethod: 'BREB',
redirectUrl: 'https://app.kravata.co/',
bankCode: '1022'
})
};
fetch('https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 500000,
'symbolOrigin' => 'USD',
'accountId' => '{{wallet_id}}',
'paymentMethod' => 'BREB',
'redirectUrl' => 'https://app.kravata.co/',
'bankCode' => '1022'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit"
payload := strings.NewReader("{\n \"amount\": 500000,\n \"symbolOrigin\": \"USD\",\n \"accountId\": \"{{wallet_id}}\",\n \"paymentMethod\": \"BREB\",\n \"redirectUrl\": \"https://app.kravata.co/\",\n \"bankCode\": \"1022\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 500000,\n \"symbolOrigin\": \"USD\",\n \"accountId\": \"{{wallet_id}}\",\n \"paymentMethod\": \"BREB\",\n \"redirectUrl\": \"https://app.kravata.co/\",\n \"bankCode\": \"1022\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://test-api-kore.kravata.co/api/v1/admin/operation/{user_id}/deposit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 500000,\n \"symbolOrigin\": \"USD\",\n \"accountId\": \"{{wallet_id}}\",\n \"paymentMethod\": \"BREB\",\n \"redirectUrl\": \"https://app.kravata.co/\",\n \"bankCode\": \"1022\"\n}"
response = http.request(request)
puts response.read_body
