Off-ramp

Offramp APIs

These APIs allow users to convert crypto assets (e.g., USDT) into fiat currency (e.g., INR) and withdraw funds to bank accounts.

---

🔹 1. Get Supported Offramp Routes

Retrieve all available crypto → fiat conversion routes.

Endpoint

GET /api/v1/taas/offramp/supported_routes/

Headers

API-KEY: <your-api-key>

cURL

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

Response

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

Description

• Lists all supported offramp routes.

• Use route_id from this API to generate quotes.

---

🔹 2. Generate Offramp Quote

Generate a real-time quote for converting crypto to fiat.

Endpoint

POST /api/v1/taas/offramp/quote/

Headers

Content-Type: application/json
API-KEY: <your-api-key>

Request Payload

{
  "account_id": 2,
  "route_id": 5,
  "amount": 100
}

cURL

curl --location 'http://127.0.0.1:8000/api/v1/taas/offramp/quote/' \
--header 'Content-Type: application/json' \
--header 'API-KEY: <API-KEY>' \
--data '{
  "account_id": 2,
  "route_id": 5,
  "amount": 100
}'

Response

{
  "id": 49,
  "account_info": {
    "id": 2,
    "email": "[email protected]"
  },
  "amount": 100.0,
  "asset": "USDT",
  "fiat": "INR",
  "type": "sell",
  "input_amount": {
    "amount": 100.0,
    "currency": "USDT"
  },
  "output_amount": {
    "amount": 9416.85,
    "currency": "INR"
  },
  "rate_info": {
    "rate": 95.69,
    "conversion": "1 USDT = 95.69 INR"
  },
  "is_expired": false
}

Description

• Calculates conversion rate, fees, and final payout.

• Quote is time-sensitive (is_expired flag).

---

🔹 3. Place Offramp Order

Create an order to convert crypto into fiat and withdraw funds.

Endpoint

POST /api/v1/taas/offramp/place_order/

Headers

Content-Type: application/json
API-KEY: <your-api-key>

Request Payload

{
  "account_id": 85,
  "quote_id": 48,
  "bank_id": 239,
  "payment_method": "bank_transfer"
}

cURL

curl --location 'http://127.0.0.1:8000/api/v1/taas/offramp/place_order/' \
--header 'Content-Type: application/json' \
--header 'API-KEY: <API-KEY>' \
--data '{
  "account_id": 85,
  "quote_id": 48,
  "bank_id": 239,
  "payment_method": "bank_transfer"
}'

Response

{
  "id": 1719,
  "asset": "USDT",
  "side": "sell",
  "status": "open",
  "asked_quantity": "100.0000000000",
  "price": "95.7300000000",
  "payment_method": "bank_transfer",
  "account_id": 85,
  "quote_id": 48
}

Description

• Executes the conversion using the provided quote.

• Funds are transferred to the selected bank account.

---

🔹 4. List Offramp Orders

Retrieve all offramp orders for an account.

Endpoint

GET /api/v1/taas/offramp/orders/

Query Params

Param	Description
account_id	User account ID
status	Filter by order status

Headers

API-KEY: <your-api-key>

cURL

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

Response

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

---

🔸 Order Status Values

Status	Description
open	Order created but not executed
filled	Fully executed
partially_filled	Partially executed
cancelled	Cancelled
partially_cancelled	Partially cancelled

---

🔸 Order Side

Value	Description
buy	Purchase crypto
sell	Sell crypto

---

📌 Flow Summary

1. Get routes → /supported_routes/

2. Generate quote → /quote/

3. Place order → /place_order/

4. Track orders → /orders/