> ## Documentation Index > Fetch the complete documentation index at: https://docs.crypto.westminister.tech/llms.txt > Use this file to discover all available pages before exploring further. # Create Remittance Off-Ramp Order > Creates an **OFF_RAMP_SELL** order with **`order_subtype` = `remittance_offramp`**: the customer sends crypto to a per-order **escrow** address. After confirmation, **mobile money B2C** pays the **beneficiary** (third party). The client supplies **how much fiat the beneficiary should receive** (`beneficiary_fiat_amount`). The server derives **USDT/USDC to escrow** using the active **pricing profile** and **FX quote** plus **`fee_bearer`** (`sender` or `receiver`), matching internal remittance pricing rules. **Liquidity listing (required `vendor_id` + `offer_id`):** Same JSON keys as other orders. Here they mean the **liquidity provider** and **liquidity listing** the remittance order is priced and validated against—the marketplace anchor for asset/fiat/network and offer lifecycle—not “who sends John his USDT” (John already holds crypto in custody). **Requirements:** `sender_wallet_address` must belong to `customer_id` (verified if external). For mobile money, `beneficiary_phone` digits must differ from `sender_phone`. `pricing_profile_id` and `fx_rate_quote_id` are required. ## OpenAPI ````yaml /openapi.yaml post /api/v1/auth/remittance/off-ramp/orders openapi: 3.1.0 info: title: EmaalCoin API description: > EmaalCoin API reference. These APIs power cryptocurrency exchange between USDT and Fiat trading. - **On-Ramp**: Buy USDT with fiat (KES) via mobile money (STK Push for Kenya) - **Off-Ramp**: Sell USDT for KES with mobile money payout (Kenya) - **Ethereum, TRON, and Solana**: Multi-chain wallet support - **Merchant Offers**: Create and manage trading offers - **OTC Flows**: Bank and mobile money deposits/withdrawals for merchants - **Pricing engine**: FX quotes and fee profiles for quote-backed orders and transfers - **P2P/B2B transfers**: Internal and external stablecoin sends (USDT/USDC) with optional pricing snapshots - **Stablecoin swaps**: Treasury-backed two-leg USDT ↔ USDC conversion with BitGo confirmation, inventory reservation, and automatic refunds - **Multisig**: Collaborative and platform-managed multisig flows for high-value B2B version: 1.1.0 servers: - url: https://crypto.westminister.tech description: Production API (requires DNS for this hostname). - url: http://13.42.110.185:8080 description: >- UAT on EC2 (direct). Use this base when building proof PDF URLs if the production hostname does not resolve. security: [] tags: - name: Pricing description: >- Commercial pricing profiles and FX rate quotes (admin). Used with orders and transfers for auditable snapshots. - name: Transfers description: >- P2P and B2B stablecoin transfers (USDT/USDC). Optional fiat-equivalent pricing fields. B2B multisig behavior depends on wallet registration (synchronous completion vs proposal flow). - name: Stablecoin Swaps description: >- Treasury-backed USDT ↔ USDC conversions for BitGo provider-managed wallets on `tron`, `ethereum`, or `solana`. Collection confirms before treasury payout starts. Completion requires both legs and dual-asset balance synchronization. - name: Multisig description: >- Multisig wallet registration and TRON proposal/confirm flows (vendor/admin). - name: Escrow Wallets description: Escrow pool wallet metadata for off-ramp and operations. - name: Users description: >- User-related operations (registration, lookup, updates, counts, status changes) - name: Wallets-Users description: User wallet operations (create, manage, query balances) - name: Offers description: Offer operations (create, read, list, counts) - name: Orders description: Order operations (create, update, list, counts, stats) - name: Payment description: Payment initiation operations - name: Merchants description: > Merchant (vendor) onboarding and hierarchy operations. USE **GET /API/V1/AUTH/MERCHANTS** WITH **PAGE_ID** AND **PAGE_SIZE** TO PAGE MASTER VENDORS. USE **GET /API/V1/AUTH/MERCHANTS/{MERCHANT_ID}** FOR ONE MASTER VENDOR, **MERCHANT_WALLETS**, AND ALL **SUBVENDOR** ROWS WITH **WALLETS** (FULL TREE). - name: OTC Deposits description: > OTC fiat-to-crypto deposits (bank or mobile money). Rows live in **`otc_deposits`**. Merchants create drafts or one-shot deposits. **admin**, **otc_officer**, or **treasury** list all deposits. B2B bank flow uses draft, quote, submit, proof, assign, claim, settlement, and audit. **`credited_to_address`** is the merchant on-chain wallet treasury credits (resolved from the default wallet for **`requested_network`** on the master merchant ledger user or any **sub-vendor** under that merchant). **`GET /api/v1/auth/otc/deposits`** backfills missing **`credited_to_address`**/**`to_wallet_id`** when a wallet can be resolved. One-shot **`POST /api/v1/auth/otc/deposits`** persists the payout address when **`requested_network`** is sent. Bank proof PDFs upload via `POST .../proof` and are viewed at **`GET /otc-deposits-proof/{deposit_id}/{file}.pdf`** (relative **`proof_url`**/**`file_url`** plus API base URL). Merchants may edit tab-1 draft fields with **`PATCH /api/v1/auth/otc/deposits/{id}/draft`** while **`status`** is **`draft`**. - name: OTC Withdrawals description: >- OTC crypto-to-fiat withdrawals (bank or mobile money). Merchants create. Admin approves and executes. - name: OTC Config description: OTC display config (bank details, mobile money paybill) for merchant UI - name: Fiat Currencies description: > Shared platform **fiat_currencies** catalog. **GET /api/v1/auth/fiat-currencies** lists active rows for UI pickers. **GET /api/v1/auth/fiat-currencies/admin** lists all rows including inactive (admin). Admin manages rows with **GET /api/v1/auth/fiat-currencies/{id}**, **POST /api/v1/auth/fiat-currencies**, **PATCH /api/v1/auth/fiat-currencies/{id}**, and **DELETE /api/v1/auth/fiat-currencies/{id}**. Use for OTC, pricing, orders, remittance, and backoffice — not under **`/otc/...`**. Prefer **PATCH** with **`is_active: false`** over delete when a currency is referenced. - name: Countries description: >- Shared platform **countries** catalog. Public **GET /api/v1/countries** lists active rows for pickers. Auth **GET /api/v1/auth/countries** returns the same active catalog. Admin manages rows with **GET /api/v1/auth/countries/admin**, **GET /api/v1/auth/countries/{id}**, **POST /api/v1/auth/countries**, **PATCH /api/v1/auth/countries/{id}**, and **DELETE /api/v1/auth/countries/{id}**. - name: Files description: Authenticated file uploads for OTC receipts and proof artifacts. paths: /api/v1/auth/remittance/off-ramp/orders: post: tags: - Orders summary: Create Remittance Off-Ramp Order description: > Creates an **OFF_RAMP_SELL** order with **`order_subtype` = `remittance_offramp`**: the customer sends crypto to a per-order **escrow** address. After confirmation, **mobile money B2C** pays the **beneficiary** (third party). The client supplies **how much fiat the beneficiary should receive** (`beneficiary_fiat_amount`). The server derives **USDT/USDC to escrow** using the active **pricing profile** and **FX quote** plus **`fee_bearer`** (`sender` or `receiver`), matching internal remittance pricing rules. **Liquidity listing (required `vendor_id` + `offer_id`):** Same JSON keys as other orders. Here they mean the **liquidity provider** and **liquidity listing** the remittance order is priced and validated against—the marketplace anchor for asset/fiat/network and offer lifecycle—not “who sends John his USDT” (John already holds crypto in custody). **Requirements:** `sender_wallet_address` must belong to `customer_id` (verified if external). For mobile money, `beneficiary_phone` digits must differ from `sender_phone`. `pricing_profile_id` and `fx_rate_quote_id` are required. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RemittanceOffRampOrderRequest' responses: '201': description: Remittance off-ramp order created content: application/json: schema: $ref: '#/components/schemas/Order' '400': description: Validation or pricing error '403': description: Wallet does not belong to customer '500': description: Internal server error components: schemas: RemittanceOffRampOrderRequest: type: object required: - customer_id - vendor_id - offer_id - sender_name - sender_country - sender_phone - sender_wallet_address - beneficiary_phone - beneficiary_country - beneficiary_fiat_amount - fiat_currency - payment_method - expires_at - pricing_profile_id - fx_rate_quote_id properties: customer_id: type: string format: uuid vendor_id: type: string format: uuid description: > **Liquidity provider** (API field name `vendor_id`): user id of the account that published the listing. Not the fiat beneficiary and not the source of the customer’s custody balance. offer_id: type: string format: uuid description: > **Liquidity listing** (API field name `offer_id`): the active published terms row (pair, limits, asset) this order attaches to for validation and lifecycle. For custodial remittance flows (`order_subtype = custodial_remittance_offramp`), this can be null/empty. sender_name: type: string description: Display/compliance name for the crypto sender sender_country: type: string description: >- Preferred active ISO 3166-1 alpha-3 sender country code from the countries catalog. Example GBR. Legacy alpha-2 input is accepted and normalized to alpha-3 sender_phone: type: string description: Sender MSISDN. Must differ from beneficiary_phone for mobile money sender_wallet_address: type: string description: >- Customer wallet used for network detection and escrow flow. Must belong to customer_id beneficiary_phone: type: string description: mobile money destination for KES payout beneficiary_country: type: string example: KEN description: >- Preferred active ISO 3166-1 alpha-3 beneficiary country code from the countries catalog. Legacy alpha-2 input is accepted and normalized to alpha-3 beneficiary_name: type: string description: Optional beneficiary display name beneficiary_fiat_amount: type: string description: >- Net fiat amount the beneficiary should receive (e.g. KES as decimal string) fiat_currency: type: string example: KES payment_method: type: string example: mpesa expires_at: type: string format: date-time payout_method: type: string enum: - mpesa - bank default: mpesa fee_bearer: type: string enum: - sender - receiver description: Defaults from liquidity listing then receiver payout_phone: type: string description: Optional. Defaults to beneficiary_phone for mobile money beneficiary_bank_name: type: string beneficiary_bank_code: type: string beneficiary_account_name: type: string beneficiary_account_number: type: string pricing_profile_id: type: string format: uuid fx_rate_quote_id: type: string format: uuid Order: type: object properties: id: type: string format: uuid customer_id: type: string format: uuid vendor_id: type: string format: uuid description: Liquidity provider (publisher). API name vendor_id. offer_id: type: string format: uuid nullable: true description: >- Liquidity listing id. API name offer_id. Nullable for custodial remittance orders. asset: type: string nullable: true crypto_amount: type: string usdt_amount: type: string nullable: true description: Backward-compatible alias for crypto_amount fiat_amount: type: string fiat_currency: type: string wallet_address: type: string status: type: string enum: - pending - processing - confirming - completed - cancelled - failed payment_method: type: string description: e.g., mpesa payment_txn_id: $ref: '#/components/schemas/NullableString' blockchain_txn_hash: $ref: '#/components/schemas/NullableString' expires_at: type: string format: date-time completed_at: $ref: '#/components/schemas/NullableTime' created_at: type: string format: date-time updated_at: type: string format: date-time deleted_at: $ref: '#/components/schemas/NullableTime' merchant_request_id: $ref: '#/components/schemas/NullableString' checkout_request_id: $ref: '#/components/schemas/NullableString' mpesa_receipt_number: $ref: '#/components/schemas/NullableString' payment_phone_number: $ref: '#/components/schemas/NullableString' order_type: type: string enum: - ON_RAMP_BUY - ON_RAMP_SELL - OFF_RAMP_BUY - OFF_RAMP_SELL order_subtype: type: string enum: - standard_onramp - standard_offramp - remittance_offramp - custodial_remittance_offramp - treasury_offramp description: > 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. sender_name: $ref: '#/components/schemas/NullableString' sender_country: $ref: '#/components/schemas/NullableString' sender_phone: $ref: '#/components/schemas/NullableString' beneficiary_bank_name: $ref: '#/components/schemas/NullableString' beneficiary_bank_code: $ref: '#/components/schemas/NullableString' beneficiary_bank_branch: $ref: '#/components/schemas/NullableString' beneficiary_bank_address: $ref: '#/components/schemas/NullableString' beneficiary_account_name: $ref: '#/components/schemas/NullableString' beneficiary_account_number: $ref: '#/components/schemas/NullableString' beneficiary_swift_code: $ref: '#/components/schemas/NullableString' escrow_wallet_address: $ref: '#/components/schemas/NullableString' escrow_network: $ref: '#/components/schemas/NullableString' escrow_reference: $ref: '#/components/schemas/NullableString' deposit_tx_hash: $ref: '#/components/schemas/NullableString' deposit_confirmations: type: integer deposit_detected_at: $ref: '#/components/schemas/NullableTime' NullableString: type: object description: Database-style nullable string wrapper properties: String: type: string nullable: true Valid: type: boolean NullableTime: type: object description: Database-style nullable time wrapper properties: Time: type: string format: date-time nullable: true Valid: type: boolean ````