On-ramp

Onramp APIs

Base URL:

http://127.0.0.1:8000/api/v1/taas/onramp/

Authentication:

API-KEY: <your-api-key>

---

🔄 Onramp Flow Overview

1. Get Supported Routes

2. Generate Quote

3. Place Order

4. Track Orders

---

🔀 1. Get Supported Routes

Endpoint

GET /supported_routes/

Description

Fetch available fiat → crypto conversion routes.

---

Request

curl --location 'http://127.0.0.1:8000/api/v1/taas/onramp/supported_routes/' \
--header 'API-KEY: <API_KEY>'

---

Response

{
  "count": 1,
  "results": [
    {
      "id": 6,
      "from_asset": "INR",
      "to_asset": "USDT",
      "is_active": true
    }
  ]
}

---

💲 2. Generate Quote

Endpoint

POST /quote/

Description

Generates a conversion quote for a given route and amount.

---

Request

curl --location 'http://127.0.0.1:8000/api/v1/taas/onramp/quote/' \
--header 'Content-Type: application/json' \
--header 'API-KEY: <API_KEY>' \
--data '{
  "account_id": 85,
  "route_id": 6,
  "amount": 10000
}'

---

⚠️ Error Responses

Limit Exceeded

{
  "error": "Validation failed",
  "details": {
    "errors": [
      "Daily limit exceeded"
    ],
    "remaining": {
      "daily_remaining": "30000.00000000"
    }
  }
}

---

Insufficient Balance

{
  "error": "Validation failed",
  "details": {
    "errors": [
      "Insufficient INR balance in master account"
    ]
  }
}

---

🛒 3. Place Order

Endpoint

POST /place_order/

Description

Places an order using a generated quote.

---

Request

curl --location 'http://127.0.0.1:8000/api/v1/taas/onramp/place_order/' \
--header 'Content-Type: application/json' \
--header 'API-KEY: <API_KEY>' \
--data '{
    "account_id": 85,
    "quote_id": 46,
    "wallet_id": 17,
    "payment_method": "crypto_transfer"
}'

---

Response

{
  "id": 1718,
  "asset": "USDT",
  "side": "buy",
  "status": "open",
  "asked_quantity": "1.03",
  "price": "96.49",
  "blocked_fund": "100.00",
  "payment_method": "crypto_transfer"
}

---

📊 4. List Orders

Endpoint

GET /orders/

---

Query Params

Param	Description
account_id	Account ID
status	Order status
side	buy / sell

---

Request

curl --location 'http://127.0.0.1:8000/api/v1/taas/onramp/orders/?account_id=85&status=filled' \
--header 'API-KEY: <API_KEY>'

---

Response

{
  "count": 2,
  "results": [
    {
      "id": 1718,
      "asset": "USDT",
      "status": "filled",
      "filled_quantity": "1.03",
      "final_cost_to_user": "100.00"
    }
  ]
}

---

📌 Choice Fields

Order Side

buy
sell

Order Status

open
filled
partially_filled
cancelled
partially_cancelled

---

📌 Notes

• Quote must be generated before placing an order

• Orders are typically limit orders

• Funds are blocked at order creation

• Fees and TDS are applied at execution

• Order status transitions:

  • open → filled

  • open → partially_filled

  • open → cancelled