Off Ramp

Off-ramp operations (crypto to fiat) — sell crypto and receive fiat

Get off-ramp price estimate

post

https://api-staging.unigox.comhttps://api.unigox.com

/api/v1/partner/offramp/estimate

Get indicative off-ramp pricing (crypto to fiat) without creating a quote. This endpoint is lightweight and does not reserve liquidity.

Use this when you need quick pricing discovery before calling /partner/offramp/quote. Optional filters: payment_method_slug, payment_network_slug, provider_scope, country_code. This endpoint is indicative and does not apply user/payment-details ownership checks; for executable pricing use quote.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Partner API key for authentication. Required for all partner account endpoints.

Body

application/json

anyOptional

or

anyOptional

Responses

200

Estimate retrieved successfully

application/json

400

Bad request — invalid parameters, missing required fields, unsupported cryptocurrency, or invalid provider_scope.

application/json

401

Unauthorized - missing or invalid API key

application/json

409

No offers available for the requested pair/amount

application/json

500

Internal Server Error

post

/api/v1/partner/offramp/estimate

HTTPcURLJavaScriptPython

POST /api/v1/partner/offramp/estimate HTTP/1.1
Host: api-staging.unigox.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "crypto_currency": "USDT",
  "fiat_currency": "NGN",
  "crypto_amount": "100.00",
  "payment_method_slug": "access-bank",
  "payment_network_slug": "nibss",
  "country_code": "NG",
  "provider_scope": "all"
}

{
  "success": true,
  "data": {
    "rate": "1530.12",
    "crypto_amount": "101.50",
    "fiat_amount": "152880.00",
    "fee_breakdown": {
      "platform_fee": "1.50",
      "platform_fee_pct": 1.5,
      "partner_fee": "0.00",
      "partner_fee_pct": 0,
      "total_fee": "1.50"
    },
    "payment_method_slug": "access-bank",
    "payment_network_slug": "nibss",
    "provider_scope": "all",
    "is_indicative": true
  }
}

Get off-ramp quote

post

https://api-staging.unigox.comhttps://api.unigox.com

/api/v1/partner/offramp/quote

Get a price quote for an off-ramp operation (crypto to fiat). Returns the exchange rate, amounts, and a quote ID that can be used to initiate the order. Quotes expire after 60 seconds.

The user_id is the internal integer user ID returned by POST /partner/users (in the internal_id field). The payment_details_id is the ID of a previously created payment profile for the user.

Fee structure: The fee_breakdown object shows all fee components transparently: platform_fee (our fee in crypto), partner_fee (partner's markup, currently 0, configurable via dashboard in a future release), and total_fee (sum of both).

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Partner API key for authentication. Required for all partner account endpoints.

Body

application/json

user_idinteger · int64Required

Internal user ID (integer, from POST /partner/users response internal_id field)

Example: 12345

payment_details_idinteger · int64Required

ID of a previously created payment profile for the user

Example: 987

crypto_currencystringRequired

Cryptocurrency code (e.g., USDT, USDC)

Example: USDT

crypto_amountstringRequired

Amount of crypto to sell (standard units, e.g., "100.00" for 100 USDT)

Example: 100.00

fiat_currencystringRequired

Target fiat currency code (e.g., NGN, USD, EUR)

Example: NGN

railstringOptional

Optional rail hint; must be compatible with payment details if provided

Example: Bank Transfer

routestringOptional

Optional route hint; must be compatible with payment details if provided

Example: Instant Transfer

provider_scopestring · enumOptional

Optional provider scope filter; defaults to all

Example: allPossible values:

Responses

200

Quote retrieved successfully

application/json

400

Bad request — invalid parameters or missing required fields

application/json

401

Unauthorized — invalid or missing API key

application/json

404

User or payment details not found

application/json

409

No offers available for the requested pair

application/json

500

Internal server error

application/json

post

/api/v1/partner/offramp/quote

HTTPcURLJavaScriptPython

POST /api/v1/partner/offramp/quote HTTP/1.1
Host: api-staging.unigox.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "user_id": 12345,
  "payment_details_id": 987,
  "crypto_currency": "USDT",
  "crypto_amount": "100.00",
  "fiat_currency": "NGN",
  "rail": "Bank Transfer",
  "route": "Instant Transfer",
  "provider_scope": "all",
  "slippage_tolerance": {
    "type": "percent",
    "value": 1.5
  }
}

{
  "success": true,
  "data": {
    "quote_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "rate": "1530.12",
    "crypto_amount": "101.50",
    "fiat_amount": "152880.00",
    "fee_breakdown": {
      "platform_fee": "1.50",
      "platform_fee_pct": 1.5,
      "partner_fee": "0.00",
      "partner_fee_pct": 0,
      "total_fee": "1.50"
    },
    "payment_details_id": 987,
    "payment_method_id": 5,
    "payment_network_id": 12,
    "expires_at": "2026-02-01T12:00:30Z"
  }
}

Initiate off-ramp order

post

https://api-staging.unigox.comhttps://api.unigox.com

/api/v1/partner/offramp/initiate

Initiate an off-ramp order using a previously obtained quote. The quote must still be active (not expired or already used). The system refreshes the price and checks slippage tolerance before creating the order.

If the price has moved beyond the slippage tolerance, a PRICE_CHANGED_REQUOTE error is returned with details about the old and new rates, so the partner can request a new quote.

On success, returns the created order with status awaiting_liquidity_provider.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Partner API key for authentication. Required for all partner account endpoints.

Body

application/json

quote_idstring · uuidRequired

Quote ID from the quote endpoint. Payment details are taken from the quote.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Responses

201

Off-ramp order created successfully

application/json

400

Bad request — missing required fields

application/json

401

Unauthorized — invalid or missing API key

application/json

404

Quote not found

application/json

409

Quote expired, already used, or slippage exceeded

application/json

500

Internal server error

application/json

post

/api/v1/partner/offramp/initiate

HTTPcURLJavaScriptPython

POST /api/v1/partner/offramp/initiate HTTP/1.1
Host: api-staging.unigox.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "quote_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

{
  "success": true,
  "data": {
    "order_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "status": "awaiting_liquidity_provider",
    "quote_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "amounts": {
      "crypto_amount": "101.50",
      "fiat_amount": "152880.00",
      "crypto_currency": "USDT",
      "fiat_currency": "NGN",
      "rate": "1530.12"
    },
    "fee_breakdown": {
      "platform_fee": "1.50",
      "platform_fee_pct": 1.5,
      "partner_fee": "0.00",
      "partner_fee_pct": 0,
      "total_fee": "1.50"
    },
    "timeline": [
      {
        "status": "awaiting_liquidity_provider",
        "timestamp": "2026-02-01T12:00:05Z",
        "description": "Order created and awaiting liquidity provider"
      }
    ],
    "created_at": "2026-02-01T12:00:05Z"
  }
}