Create Remittance Off-Ramp Order

curl --request POST \
  --url https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "offer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sender_name": "<string>",
  "sender_country": "<string>",
  "sender_phone": "<string>",
  "sender_wallet_address": "<string>",
  "beneficiary_phone": "<string>",
  "beneficiary_country": "KEN",
  "beneficiary_fiat_amount": "<string>",
  "fiat_currency": "KES",
  "payment_method": "mpesa",
  "expires_at": "2023-11-07T05:31:56Z",
  "pricing_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fx_rate_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "beneficiary_name": "<string>",
  "payout_method": "mpesa",
  "payout_phone": "<string>",
  "beneficiary_bank_name": "<string>",
  "beneficiary_bank_code": "<string>",
  "beneficiary_account_name": "<string>",
  "beneficiary_account_number": "<string>"
}
'

import requests

url = "https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders"

payload = {
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "offer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sender_name": "<string>",
    "sender_country": "<string>",
    "sender_phone": "<string>",
    "sender_wallet_address": "<string>",
    "beneficiary_phone": "<string>",
    "beneficiary_country": "KEN",
    "beneficiary_fiat_amount": "<string>",
    "fiat_currency": "KES",
    "payment_method": "mpesa",
    "expires_at": "2023-11-07T05:31:56Z",
    "pricing_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fx_rate_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "beneficiary_name": "<string>",
    "payout_method": "mpesa",
    "payout_phone": "<string>",
    "beneficiary_bank_name": "<string>",
    "beneficiary_bank_code": "<string>",
    "beneficiary_account_name": "<string>",
    "beneficiary_account_number": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    vendor_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    offer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    sender_name: '<string>',
    sender_country: '<string>',
    sender_phone: '<string>',
    sender_wallet_address: '<string>',
    beneficiary_phone: '<string>',
    beneficiary_country: 'KEN',
    beneficiary_fiat_amount: '<string>',
    fiat_currency: 'KES',
    payment_method: 'mpesa',
    expires_at: '2023-11-07T05:31:56Z',
    pricing_profile_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    fx_rate_quote_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    beneficiary_name: '<string>',
    payout_method: 'mpesa',
    payout_phone: '<string>',
    beneficiary_bank_name: '<string>',
    beneficiary_bank_code: '<string>',
    beneficiary_account_name: '<string>',
    beneficiary_account_number: '<string>'
  })
};

fetch('https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'vendor_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'offer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'sender_name' => '<string>',
    'sender_country' => '<string>',
    'sender_phone' => '<string>',
    'sender_wallet_address' => '<string>',
    'beneficiary_phone' => '<string>',
    'beneficiary_country' => 'KEN',
    'beneficiary_fiat_amount' => '<string>',
    'fiat_currency' => 'KES',
    'payment_method' => 'mpesa',
    'expires_at' => '2023-11-07T05:31:56Z',
    'pricing_profile_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'fx_rate_quote_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'beneficiary_name' => '<string>',
    'payout_method' => 'mpesa',
    'payout_phone' => '<string>',
    'beneficiary_bank_name' => '<string>',
    'beneficiary_bank_code' => '<string>',
    'beneficiary_account_name' => '<string>',
    'beneficiary_account_number' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders"

	payload := strings.NewReader("{\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"offer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sender_name\": \"<string>\",\n  \"sender_country\": \"<string>\",\n  \"sender_phone\": \"<string>\",\n  \"sender_wallet_address\": \"<string>\",\n  \"beneficiary_phone\": \"<string>\",\n  \"beneficiary_country\": \"KEN\",\n  \"beneficiary_fiat_amount\": \"<string>\",\n  \"fiat_currency\": \"KES\",\n  \"payment_method\": \"mpesa\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"pricing_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"fx_rate_quote_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"beneficiary_name\": \"<string>\",\n  \"payout_method\": \"mpesa\",\n  \"payout_phone\": \"<string>\",\n  \"beneficiary_bank_name\": \"<string>\",\n  \"beneficiary_bank_code\": \"<string>\",\n  \"beneficiary_account_name\": \"<string>\",\n  \"beneficiary_account_number\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"offer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sender_name\": \"<string>\",\n  \"sender_country\": \"<string>\",\n  \"sender_phone\": \"<string>\",\n  \"sender_wallet_address\": \"<string>\",\n  \"beneficiary_phone\": \"<string>\",\n  \"beneficiary_country\": \"KEN\",\n  \"beneficiary_fiat_amount\": \"<string>\",\n  \"fiat_currency\": \"KES\",\n  \"payment_method\": \"mpesa\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"pricing_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"fx_rate_quote_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"beneficiary_name\": \"<string>\",\n  \"payout_method\": \"mpesa\",\n  \"payout_phone\": \"<string>\",\n  \"beneficiary_bank_name\": \"<string>\",\n  \"beneficiary_bank_code\": \"<string>\",\n  \"beneficiary_account_name\": \"<string>\",\n  \"beneficiary_account_number\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"offer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sender_name\": \"<string>\",\n  \"sender_country\": \"<string>\",\n  \"sender_phone\": \"<string>\",\n  \"sender_wallet_address\": \"<string>\",\n  \"beneficiary_phone\": \"<string>\",\n  \"beneficiary_country\": \"KEN\",\n  \"beneficiary_fiat_amount\": \"<string>\",\n  \"fiat_currency\": \"KES\",\n  \"payment_method\": \"mpesa\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"pricing_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"fx_rate_quote_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"beneficiary_name\": \"<string>\",\n  \"payout_method\": \"mpesa\",\n  \"payout_phone\": \"<string>\",\n  \"beneficiary_bank_name\": \"<string>\",\n  \"beneficiary_bank_code\": \"<string>\",\n  \"beneficiary_account_name\": \"<string>\",\n  \"beneficiary_account_number\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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 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.

POST

api

auth

remittance

off-ramp

orders

Create Remittance Off-Ramp Order

curl --request POST \
  --url https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "offer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sender_name": "<string>",
  "sender_country": "<string>",
  "sender_phone": "<string>",
  "sender_wallet_address": "<string>",
  "beneficiary_phone": "<string>",
  "beneficiary_country": "KEN",
  "beneficiary_fiat_amount": "<string>",
  "fiat_currency": "KES",
  "payment_method": "mpesa",
  "expires_at": "2023-11-07T05:31:56Z",
  "pricing_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fx_rate_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "beneficiary_name": "<string>",
  "payout_method": "mpesa",
  "payout_phone": "<string>",
  "beneficiary_bank_name": "<string>",
  "beneficiary_bank_code": "<string>",
  "beneficiary_account_name": "<string>",
  "beneficiary_account_number": "<string>"
}
'

import requests

url = "https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders"

payload = {
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "offer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sender_name": "<string>",
    "sender_country": "<string>",
    "sender_phone": "<string>",
    "sender_wallet_address": "<string>",
    "beneficiary_phone": "<string>",
    "beneficiary_country": "KEN",
    "beneficiary_fiat_amount": "<string>",
    "fiat_currency": "KES",
    "payment_method": "mpesa",
    "expires_at": "2023-11-07T05:31:56Z",
    "pricing_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fx_rate_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "beneficiary_name": "<string>",
    "payout_method": "mpesa",
    "payout_phone": "<string>",
    "beneficiary_bank_name": "<string>",
    "beneficiary_bank_code": "<string>",
    "beneficiary_account_name": "<string>",
    "beneficiary_account_number": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    vendor_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    offer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    sender_name: '<string>',
    sender_country: '<string>',
    sender_phone: '<string>',
    sender_wallet_address: '<string>',
    beneficiary_phone: '<string>',
    beneficiary_country: 'KEN',
    beneficiary_fiat_amount: '<string>',
    fiat_currency: 'KES',
    payment_method: 'mpesa',
    expires_at: '2023-11-07T05:31:56Z',
    pricing_profile_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    fx_rate_quote_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    beneficiary_name: '<string>',
    payout_method: 'mpesa',
    payout_phone: '<string>',
    beneficiary_bank_name: '<string>',
    beneficiary_bank_code: '<string>',
    beneficiary_account_name: '<string>',
    beneficiary_account_number: '<string>'
  })
};

fetch('https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'vendor_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'offer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'sender_name' => '<string>',
    'sender_country' => '<string>',
    'sender_phone' => '<string>',
    'sender_wallet_address' => '<string>',
    'beneficiary_phone' => '<string>',
    'beneficiary_country' => 'KEN',
    'beneficiary_fiat_amount' => '<string>',
    'fiat_currency' => 'KES',
    'payment_method' => 'mpesa',
    'expires_at' => '2023-11-07T05:31:56Z',
    'pricing_profile_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'fx_rate_quote_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'beneficiary_name' => '<string>',
    'payout_method' => 'mpesa',
    'payout_phone' => '<string>',
    'beneficiary_bank_name' => '<string>',
    'beneficiary_bank_code' => '<string>',
    'beneficiary_account_name' => '<string>',
    'beneficiary_account_number' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders"

	payload := strings.NewReader("{\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"offer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sender_name\": \"<string>\",\n  \"sender_country\": \"<string>\",\n  \"sender_phone\": \"<string>\",\n  \"sender_wallet_address\": \"<string>\",\n  \"beneficiary_phone\": \"<string>\",\n  \"beneficiary_country\": \"KEN\",\n  \"beneficiary_fiat_amount\": \"<string>\",\n  \"fiat_currency\": \"KES\",\n  \"payment_method\": \"mpesa\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"pricing_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"fx_rate_quote_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"beneficiary_name\": \"<string>\",\n  \"payout_method\": \"mpesa\",\n  \"payout_phone\": \"<string>\",\n  \"beneficiary_bank_name\": \"<string>\",\n  \"beneficiary_bank_code\": \"<string>\",\n  \"beneficiary_account_name\": \"<string>\",\n  \"beneficiary_account_number\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"offer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sender_name\": \"<string>\",\n  \"sender_country\": \"<string>\",\n  \"sender_phone\": \"<string>\",\n  \"sender_wallet_address\": \"<string>\",\n  \"beneficiary_phone\": \"<string>\",\n  \"beneficiary_country\": \"KEN\",\n  \"beneficiary_fiat_amount\": \"<string>\",\n  \"fiat_currency\": \"KES\",\n  \"payment_method\": \"mpesa\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"pricing_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"fx_rate_quote_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"beneficiary_name\": \"<string>\",\n  \"payout_method\": \"mpesa\",\n  \"payout_phone\": \"<string>\",\n  \"beneficiary_bank_name\": \"<string>\",\n  \"beneficiary_bank_code\": \"<string>\",\n  \"beneficiary_account_name\": \"<string>\",\n  \"beneficiary_account_number\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://crypto.westminister.tech/api/v1/auth/remittance/off-ramp/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"offer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sender_name\": \"<string>\",\n  \"sender_country\": \"<string>\",\n  \"sender_phone\": \"<string>\",\n  \"sender_wallet_address\": \"<string>\",\n  \"beneficiary_phone\": \"<string>\",\n  \"beneficiary_country\": \"KEN\",\n  \"beneficiary_fiat_amount\": \"<string>\",\n  \"fiat_currency\": \"KES\",\n  \"payment_method\": \"mpesa\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"pricing_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"fx_rate_quote_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"beneficiary_name\": \"<string>\",\n  \"payout_method\": \"mpesa\",\n  \"payout_phone\": \"<string>\",\n  \"beneficiary_bank_name\": \"<string>\",\n  \"beneficiary_bank_code\": \"<string>\",\n  \"beneficiary_account_name\": \"<string>\",\n  \"beneficiary_account_number\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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
  }
}

Body

application/json

customer_id

string<uuid>

required

vendor_id

string<uuid>

required

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

string<uuid>

required

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

string

required

Display/compliance name for the crypto sender

sender_country

string

required

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

string

required

Sender MSISDN. Must differ from beneficiary_phone for mobile money

sender_wallet_address

string

required

Customer wallet used for network detection and escrow flow. Must belong to customer_id

beneficiary_phone

string

required

mobile money destination for KES payout

beneficiary_country

string

required

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

Example:

"KEN"

beneficiary_fiat_amount

string

required

Net fiat amount the beneficiary should receive (e.g. KES as decimal string)

fiat_currency

string

required

Example:

"KES"

payment_method

string

required

Example:

"mpesa"

expires_at

string<date-time>

required

pricing_profile_id

string<uuid>

required

fx_rate_quote_id

string<uuid>

required

beneficiary_name

string

Optional beneficiary display name

payout_method

enum<string>

default:mpesa

Available options:

mpesa,

bank

fee_bearer

enum<string>

Defaults from liquidity listing then receiver

Available options:

sender,

receiver

payout_phone

string

Optional. Defaults to beneficiary_phone for mobile money

beneficiary_bank_name

string

beneficiary_bank_code

string

beneficiary_account_name

string

beneficiary_account_number

string

Response

Remittance 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

OTC Deposits

Offers

Users

Wallets-Users

Merchants

Orders

Transactions

Payment

OTC Desk

Mobile Money C2B

OTC Config

Fiat Currencies

Countries

Files

OTC Withdrawals

Pricing

Transfers

Stablecoin Swaps

Multisig

Escrow Wallets

Balances

Create Remittance Off-Ramp Order

Body

Response