curl --request POST \
  --url https://crypto.westminister.tech/api/v1/auth/treasury/off-ramp/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "8d09359f-325a-4ecf-998d-dbe5eda3a498",
  "asset": "USDT",
  "crypto_amount": "100.00",
  "fiat_currency": "KES",
  "wallet_address": "TPY7ewYk2eY9b4TTYkCHJH3Cqudh3NU6tM",
  "payout_method": "mpesa",
  "payout_phone": "254727648169",
  "fee_bearer": "sender",
  "pricing_profile_id": "11111111-2222-3333-4444-555555555555",
  "fx_rate_quote_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "expires_at": "2026-07-22T18:00:00Z"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "offer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "asset": "<string>",
  "crypto_amount": "<string>",
  "usdt_amount": "<string>",
  "fiat_amount": "<string>",
  "fiat_currency": "<string>",
  "wallet_address": "<string>",
  "payment_method": "<string>",
  "payment_txn_id": {
    "String": "<string>",
    "Valid": true
  },
  "blockchain_txn_hash": {
    "String": "<string>",
    "Valid": true
  },
  "expires_at": "2023-11-07T05:31:56Z",
  "completed_at": {
    "Time": "2023-11-07T05:31:56Z",
    "Valid": true
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": {
    "Time": "2023-11-07T05:31:56Z",
    "Valid": true
  },
  "merchant_request_id": {
    "String": "<string>",
    "Valid": true
  },
  "checkout_request_id": {
    "String": "<string>",
    "Valid": true
  },
  "mpesa_receipt_number": {
    "String": "<string>",
    "Valid": true
  },
  "payment_phone_number": {
    "String": "<string>",
    "Valid": true
  },
  "sender_name": {
    "String": "<string>",
    "Valid": true
  },
  "sender_country": {
    "String": "<string>",
    "Valid": true
  },
  "sender_phone": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_bank_name": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_bank_code": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_bank_branch": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_bank_address": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_account_name": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_account_number": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_swift_code": {
    "String": "<string>",
    "Valid": true
  },
  "escrow_wallet_address": {
    "String": "<string>",
    "Valid": true
  },
  "escrow_network": {
    "String": "<string>",
    "Valid": true
  },
  "escrow_reference": {
    "String": "<string>",
    "Valid": true
  },
  "deposit_tx_hash": {
    "String": "<string>",
    "Valid": true
  },
  "deposit_confirmations": 123,
  "deposit_detected_at": {
    "Time": "2023-11-07T05:31:56Z",
    "Valid": true
  }
}

Orders

Create Treasury Fiat-On-Demand Off-Ramp

Creates an OFF_RAMP_SELL order with order_subtype = treasury_offramp.

This is the company cash-out path. No marketplace offer is required. Coinpool is the counterparty (vendor_id is set from TREASURY_USER_ID). Customers can use this when no peer offers exist, or when they prefer to sell crypto directly to the platform even if offers are available.

Fiat payout destination

Customers must set payout_method:

mpesa: Mobile money in Kenya. Requires fiat_currency=KES and payout_phone in MSISDN form (2547XXXXXXXX).
bank: Bank transfer. Requires a nested bank object with bank name, branch name, physical address, account number, account name, and SWIFT code.

Flow:

Customer creates the order and receives a unique escrow address.
Customer sends USDT/USDC to escrow (POST /orders/{id}/send-payment for custodial wallets).
Escrow watcher confirms the deposit.
Platform pays fiat to the customer’s M-Pesa or bank account.

Provide either fiat_amount (desired net payout) or crypto_amount (amount to sell). Pricing uses an active offramp pricing profile and FX quote.

POST

api

auth

treasury

off-ramp

orders

curl --request POST \
  --url https://crypto.westminister.tech/api/v1/auth/treasury/off-ramp/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "8d09359f-325a-4ecf-998d-dbe5eda3a498",
  "asset": "USDT",
  "crypto_amount": "100.00",
  "fiat_currency": "KES",
  "wallet_address": "TPY7ewYk2eY9b4TTYkCHJH3Cqudh3NU6tM",
  "payout_method": "mpesa",
  "payout_phone": "254727648169",
  "fee_bearer": "sender",
  "pricing_profile_id": "11111111-2222-3333-4444-555555555555",
  "fx_rate_quote_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "expires_at": "2026-07-22T18:00:00Z"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "offer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "asset": "<string>",
  "crypto_amount": "<string>",
  "usdt_amount": "<string>",
  "fiat_amount": "<string>",
  "fiat_currency": "<string>",
  "wallet_address": "<string>",
  "payment_method": "<string>",
  "payment_txn_id": {
    "String": "<string>",
    "Valid": true
  },
  "blockchain_txn_hash": {
    "String": "<string>",
    "Valid": true
  },
  "expires_at": "2023-11-07T05:31:56Z",
  "completed_at": {
    "Time": "2023-11-07T05:31:56Z",
    "Valid": true
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": {
    "Time": "2023-11-07T05:31:56Z",
    "Valid": true
  },
  "merchant_request_id": {
    "String": "<string>",
    "Valid": true
  },
  "checkout_request_id": {
    "String": "<string>",
    "Valid": true
  },
  "mpesa_receipt_number": {
    "String": "<string>",
    "Valid": true
  },
  "payment_phone_number": {
    "String": "<string>",
    "Valid": true
  },
  "sender_name": {
    "String": "<string>",
    "Valid": true
  },
  "sender_country": {
    "String": "<string>",
    "Valid": true
  },
  "sender_phone": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_bank_name": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_bank_code": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_bank_branch": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_bank_address": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_account_name": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_account_number": {
    "String": "<string>",
    "Valid": true
  },
  "beneficiary_swift_code": {
    "String": "<string>",
    "Valid": true
  },
  "escrow_wallet_address": {
    "String": "<string>",
    "Valid": true
  },
  "escrow_network": {
    "String": "<string>",
    "Valid": true
  },
  "escrow_reference": {
    "String": "<string>",
    "Valid": true
  },
  "deposit_tx_hash": {
    "String": "<string>",
    "Valid": true
  },
  "deposit_confirmations": 123,
  "deposit_detected_at": {
    "Time": "2023-11-07T05:31:56Z",
    "Valid": true
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

customer_id

string<uuid>

required

asset

enum<string>

required

Available options:

USDT,

USDC

fiat_currency

string

required

Example:

"KES"

wallet_address

string

required

Customer custodial or verified external wallet

expires_at

string<date-time>

required

payout_method

enum<string>

required

Available options:

mpesa,

bank

pricing_profile_id

string<uuid>

required

fx_rate_quote_id

string<uuid>

required

crypto_amount

string

Amount of USDT/USDC the customer will send to escrow

usdt_amount

string

deprecated

Deprecated alias for crypto_amount

fiat_amount

string

Desired net fiat payout. If set

payment_method

string

Optional. Defaults to payout_method

payout_phone

string

Required for mpesa. Kenyan MSISDN such as 2547XXXXXXXX

fee_bearer

enum<string>

default:sender

Available options:

sender,

receiver

bank

object

Required when payout_method is bank

Show child attributes

Response

Treasury off-ramp order created

string<uuid>

customer_id

string<uuid>

vendor_id

string<uuid>

Liquidity provider (publisher). API name vendor_id.

offer_id

string<uuid> | null

Liquidity listing id. API name offer_id. Nullable for custodial remittance orders.

asset

string | null

crypto_amount

string

usdt_amount

string | null

Backward-compatible alias for crypto_amount

fiat_amount

string

fiat_currency

string

wallet_address

string

status

enum<string>

Available options:

pending,

processing,

confirming,

completed,

cancelled,

failed

payment_method

string

e.g., mpesa

payment_txn_id

object

Database-style nullable string wrapper

Show child attributes

blockchain_txn_hash

object

Database-style nullable string wrapper

Show child attributes

expires_at

string<date-time>

completed_at

object

Database-style nullable time wrapper

Show child attributes

created_at

string<date-time>

updated_at

string<date-time>

deleted_at

object

Database-style nullable time wrapper

Show child attributes

merchant_request_id

object

Database-style nullable string wrapper

Show child attributes

checkout_request_id

object

Database-style nullable string wrapper

Show child attributes

mpesa_receipt_number

object

Database-style nullable string wrapper

Show child attributes

payment_phone_number

object

Database-style nullable string wrapper

Show child attributes

order_type

enum<string>

Available options:

ON_RAMP_BUY,

ON_RAMP_SELL,

OFF_RAMP_BUY,

OFF_RAMP_SELL

order_subtype

enum<string>

Distinguishes marketplace, remittance, custodial remittance, and company fiat-on-demand off-ramp flows. Legacy rows are backfilled as standard_onramp/standard_offramp. treasury_offramp has no offer_id. Vendor is the platform treasury.

Available options:

standard_onramp,

standard_offramp,

remittance_offramp,

custodial_remittance_offramp,

treasury_offramp

sender_name

object

Database-style nullable string wrapper

Show child attributes

sender_country

object

Database-style nullable string wrapper

Show child attributes

sender_phone

object

Database-style nullable string wrapper

Show child attributes

beneficiary_bank_name

object

Database-style nullable string wrapper

Show child attributes

beneficiary_bank_code

object

Database-style nullable string wrapper

Show child attributes

beneficiary_bank_branch

object

Database-style nullable string wrapper

Show child attributes

beneficiary_bank_address

object

Database-style nullable string wrapper

Show child attributes

beneficiary_account_name

object

Database-style nullable string wrapper

Show child attributes

beneficiary_account_number

object

Database-style nullable string wrapper

Show child attributes

beneficiary_swift_code

object

Database-style nullable string wrapper

Show child attributes

escrow_wallet_address

object

Database-style nullable string wrapper

Show child attributes

escrow_network

object

Database-style nullable string wrapper

Show child attributes

escrow_reference

object

Database-style nullable string wrapper

Show child attributes

deposit_tx_hash

object

Database-style nullable string wrapper

Show child attributes

deposit_confirmations

integer

deposit_detected_at

object

Database-style nullable time wrapper

Show child attributes

Create Order (On-Ramp Or Off-Ramp)Create Remittance Off-Ramp Order

OTC Deposits

Offers

Users

Wallets-Users

Merchants

Orders

Transactions

Payment

OTC Desk

M-Pesa C2B

OTC Config

Fiat Currencies

Countries

Files

OTC Withdrawals

Pricing

Transfers

Stablecoin Swaps

Multisig

Escrow Wallets

Balances

Create Treasury Fiat-On-Demand Off-Ramp

Fiat payout destination

Authorizations

Body

Response