Skip to main content
POST
/
api
/
v1
/
auth
/
remittance
/
custodial
/
drafts
Create custodial remittance draft
curl --request POST \
  --url https://crypto.westminister.tech/api/v1/auth/remittance/custodial/drafts \
  --header 'Content-Type: application/json' \
  --data '
{
  "flow_type": "remittance",
  "custodial_wallet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "beneficiary_fiat_amount": "<string>",
  "fiat_currency": "KES",
  "pricing_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fx_rate_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sender_name": "<string>",
  "sender_country": "<string>",
  "sender_phone": "<string>",
  "beneficiary_country": "<string>",
  "beneficiary_phone": "<string>",
  "asset": "<string>",
  "fee_bearer": "sender",
  "beneficiary_name": "<string>",
  "payout_method": "mpesa"
}
'
{
  "draft_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "draft": {},
  "pricing_snapshot_note": "<string>"
}

Body

application/json
​
flow_type
enum<string>
required
Available options:
remittance
​
custodial_wallet_id
string<uuid>
required
​
beneficiary_fiat_amount
string
required

Net fiat the beneficiary receives (e.g. KES)

​
fiat_currency
string
required
Example:

"KES"

​
pricing_profile_id
string<uuid>
required
​
fx_rate_quote_id
string<uuid>
required
​
sender_name
string
required
​
sender_country
string
required

Preferred active ISO 3166-1 alpha-3 sender country code. Example GBR. Legacy alpha-2 input is accepted and normalized to alpha-3

​
sender_phone
string
required
​
beneficiary_country
string
required

Preferred active ISO 3166-1 alpha-3 beneficiary country code. Example KEN. Legacy alpha-2 input is accepted and normalized to alpha-3

​
beneficiary_phone
string
required
​
asset
string

Optional. Must match pricing asset resolved from pricing profile and fx quote when supplied

​
fee_bearer
enum<string>
default:sender
Available options:
sender,
receiver
​
beneficiary_name
string
​
payout_method
enum<string>
default:mpesa
Available options:
mpesa,
bank

Response

Draft created

​
draft_id
string<uuid>
​
draft
object

Summary including escrow address, rates, fees, and usdt_total_debit (Total stablecoin debit. USDT or USDC per pricing. API field name retained).

​
pricing_snapshot_note
string