> ## Documentation Index
> Fetch the complete documentation index at: https://docs-api.kravata.co/llms.txt
> Use this file to discover all available pages before exploring further.
# 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. |
### **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. |
| amountReceived | This is the amount you will receive. |
| 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. |
| 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 `clientId` query parameter is required: requests without it are rejected with 401.
## OpenAPI
````yaml /business/openapi.json post /api/inverse/ramp
openapi: 3.1.0
info:
title: Kravata Business API
version: '1.0'
description: >-
Kravata Business API: on-ramp and off-ramp orders between fiat and
stablecoins for your own accounts and wallets.
servers:
- url: https://testapi.kravata.co
description: Test
- url: https://apiv2.kravata.co
description: Production
security:
- bearerAuth: []
tags:
- name: Authentication
- name: Accounts
- name: Wallets
- name: Ramp Orders
- name: Webhooks
paths:
/api/inverse/ramp:
post:
tags:
- Ramp Orders
summary: Create Ramp (Receive Based)
description: >-
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. |
### **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. |
| amountReceived | This is the amount you will receive. |
| 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. |
| 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 `clientId` query parameter is required: requests without it are
rejected with 401.
operationId: create-ramp-receive-based
parameters:
- name: clientId
in: query
required: true
description: ''
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
assetIn:
type: string
assetOut:
type: string
amountOut:
type: integer
accountOriginId:
type: string
accountDestinationId:
type: string
example:
assetIn: COP
assetOut: USDC
amountOut: 12
accountOriginId: '{{accountOriginId}}'
accountDestinationId: '{{accountDestinationId}}'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
numberRamp:
type: string
rampType:
type: string
symbolTypeSent:
type: string
symbolTypeReceived:
type: string
amountSent:
type: number
amountReceived:
type: number
bankAccountId:
type: string
operationCategory:
type: string
status:
type: string
registerDate:
type: string
validUntil:
type: string
rampMonetary:
type: array
items:
type: object
properties:
rateClient:
type: number
operationConcept:
type: string
accountDestination:
type: array
items:
type: array
items:
type: object
properties:
sku:
type: string
concept:
type: string
value:
type: string
visibility:
type: boolean
walletDestination:
type: array
items: {}
userId:
type: string
walletId:
type: string
originUserId:
type: string
destinationUserId:
type: string
examples:
on-ramp:
summary: On-ramp
value:
id: 76cc6491-4637-48f1-bdb5-070a5ff78be5
numberRamp: '0012345'
rampType: on_ramp
symbolTypeSent: COP
symbolTypeReceived: USDC
amountSent: 52780.4
amountReceived: 12
bankAccountId: 0601cb0f-7b99-4d04-9b56-d0524a8f281d
operationCategory: ramp
status: pending
registerDate: '2026-09-30 10:15:02.123456'
validUntil: '2026-09-30 10:25:02.123456'
rampMonetary:
- rateClient: 4398.2
operationConcept: Rate
- costInfra: 3200
operationConcept: Cost
accountDestination:
- - sku: accountNumber
concept: Account number
value: '123456789'
visibility: true
walletDestination: []
userId: 08597c65-c25b-4a7c-8c68-f1180bce65f4
walletId: d5a3b243-db5b-46c7-b4ce-8e2b88a72122
originUserId: 08597c65-c25b-4a7c-8c68-f1180bce65f4
destinationUserId: 08597c65-c25b-4a7c-8c68-f1180bce65f4
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: Access token from POST /api/token (valid 5 minutes).
````