Ctrlk
Postman Collection↺ Changelog
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Off Ramp

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

Get off-ramp price estimate

post
/api/v1/partner/offramp/estimate

Get indicative off-ramp pricing (crypto to fiat) without creating a quote. Pricing can be driven from either side: provide crypto_amount to compute the fiat payout, or fiat_amount to compute the crypto required (exactly one of the two). 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 (which still requires an API key).

Authentication: None. This is a public endpoint — no API key required (same as /partner/liquidity).

Note: EUR, AUD, and GBP off-ramp payouts require the user's physical address. Ensure the user's KYC includes address, city, and postal_code before initiating. See PATCH /partner/users/{user_uuid}/kyc to update.

Body
anyOptional
or
anyOptional
Responses
200

Estimate retrieved successfully

application/json
successbooleanRequired

Indicates if the request was successful

Example: true
post/api/v1/partner/offramp/estimate

Get off-ramp quote

post
/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_uuid is the public UUID returned by POST /partner/users (the id field).

Choose exactly one payout ownership mode:

  • Self-payout: provide payment_details_id for an account owned by user_uuid.

  • Third-party payout: omit payment_details_id and provide sender_id, recipient_id, recipient_destination_id, sender_recipient_relationship, and purpose_of_payment.

For a third-party payout, sender_id must identify the same real KYC subject as user_uuid. At quote time Unigox validates tenant ownership, sender eligibility, destination currency/rail, recipient screening, relationship, and purpose. It persists an immutable canonical recipient snapshot on the quote. Updating or archiving the recipient afterwards does not mutate the quote; request a new quote to use changed details.

On /initiate, Unigox revalidates the quote snapshot and creates a durable compliance case. In v1 there is no partner-visible review state machine: every control is enforced BEFORE the order exists, so a payout that fails one is rejected with an error code rather than returned as a held order. An order that was created was authorized (compliance.status: authorized, risk_decision: allow, requires_review: false). Operator review happens on the Unigox side over the same records; API-created third-party payouts use the same Compliance queue as portal-created payouts.

Anchor mode — provide exactly one of crypto_amount or fiat_amount:

Field
Anchor
Guarantee

crypto_amount

Crypto-anchored

Exact crypto cost; fiat payout varies by the rate at settlement

fiat_amount

Fiat-anchored

Exact fiat delivery to recipient; crypto cost may vary within a 1.20× safety bound

The response anchor_type field tells you which side is guaranteed: "crypto" or "fiat".

Fiat-anchored notes:

  • Useful for exact-payout use cases (e.g. deliver exactly 500,000 NGN).

  • If the crypto cost we quote exceeds 1.20× the expected amount, the order moves to failed status and the deposit is automatically refunded from escrow back to the partner wallet. Create a new quote to retry.

  • slippage_tolerance.type=amount in fiat-anchored mode is evaluated as crypto-side delta, not fiat-side (fiat is always exact by construction).

  • Integer-minor-unit currencies (NGN, UGX, TZS, KES, GHS): fiat_amount must be a whole number.

Fee structure: The fee_breakdown object shows all fee components transparently: platform_fee (our fee in crypto), partner_fee (your per-order markup in crypto — declare it by passing partner_fee_pct on the quote/estimate request, where 1 means 1%), partner_fee_pct (the percentage applied), and total_fee (sum of both). The partner fee is computed on the same crypto base as the platform fee (non-compounding) and is settled on-chain to your partner wallet on successful release; cancelled or failed orders refund the full amount, markup included.

Apply your fee on the same side the platform does, or your receipts won't reconcile with our orders. crypto_amount in responses and webhooks stays partner-fee-exclusive, with two exceptions: a crypto-anchored onramp order (request declares crypto_amount) is sized up so the delivered amount stays exact after the markup is withheld, so crypto_amount there includes the markup; a crypto-anchored offramp order (request declares crypto_amount) carves both fees out of the pinned deposit, so crypto_amount and platform_fee both shrink relative to a no-markup request even though the markup itself stays out of crypto_amount. Every other case is unaffected — the markup shows only in fee_breakdown (and in the funding amount returned by transfer authorization for offramp — crypto_amount + fee_breakdown.partner_fee is what you actually fund). Fiat-anchored offramp orders have no cap on the markup — the deposit grows to cover it. Every other case hits a formula domain bound, not a business cap: onramp rejects partner_fee_pct >= 100 (the withheld or grossed-up fee would consume the entire buyer amount, leaving nothing delivered); crypto-anchored offramp rejects it when the fee would consume the entire pinned deposit.

Address requirement for EUR/AUD/GBP: EUR, AUD, and GBP payouts require the user's physical address (street, city, postal code). If the user's KYC does not include address data, the quote response will include a beneficiary_requirements field indicating which fields are needed. You can update the user's KYC with PATCH /partner/users/{user_uuid}/kyc to provide the address before or after initiating the order. If you initiate without address, the order will be created with status pending_address until the address is provided.

KYC requirement: The customer must be KYC-cleared before you can quote or transact for them. If the customer is not cleared, this endpoint returns 422 KYC_NOT_CLEARED and error.details.kyc_status carries their current partner-facing KYC status. The same check is re-applied as the order moves toward payout. A customer still in compliance review is reported as IN_PROGRESS — treat IN_PROGRESS as "not cleared yet" and keep polling GET /api/v1/partner/users/{user_uuid}/verification-status.

Authorizations
X-API-KeystringRequired

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

Body
and
anyOptional
anyOptional
or
anyOptional
Responses
200

Quote retrieved successfully

application/json
successbooleanRequired

Indicates if the request was successful

Example: true
post/api/v1/partner/offramp/quote

Initiate off-ramp order

post
/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.

Address requirement for EUR/AUD/GBP: For EUR/AUD/GBP orders, if the user's KYC does not include a physical address, the order will be created with status pending_address. The response will include required_fields: ["address", "city", "postal_code"] and next_action: "provide_address". Call PATCH /partner/users/{user_uuid}/kyc to add the address, and the order will automatically advance.

Recommended flow for EUR/AUD/GBP:

  1. Submit KYC with address/city/postal_code (POST /kyc-submissions)

  2. Create payment details (POST /payment-details) — address auto-populated from KYC

  3. Get quote (POST /offramp/quote)

  4. Initiate (POST /offramp/initiate) — proceeds without delays

KYC requirement: The customer must be KYC-cleared, exactly as described on POST /offramp/quote. If they are not, this endpoint returns 422 KYC_NOT_CLEARED with the customer's partner-facing status in error.details.kyc_status. The check is re-applied as the order moves toward payout.

Authorizations
X-API-KeystringRequired

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

Body
quote_idstring · uuidRequired

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

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
reference_idstringOptional

Optional partner-supplied external reference ID (e.g. your internal order ID). Stored on the order and echoed back in responses.

Example: your-internal-order-id
Responses
201

Off-ramp order created successfully

application/json
successbooleanRequired

Indicates if the request was successful

Example: true
post/api/v1/partner/offramp/initiate
PreviousLiquidityNextRecipients

Last updated