Skip to main content
POST
/
api
/
v1
/
auth
/
otc
/
deposits
curl --request POST \
  --url https://crypto.westminister.tech/api/v1/auth/otc/deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "bank",
  "fiat_amount": "10000.00",
  "fiat_currency": "KES",
  "payment_reference": "TXN-12345",
  "proof_url": "https://example.com/proof.pdf",
  "transfer_date": "2025-02-28",
  "sender_account_name": "ACME LTD",
  "sender_account_number_last4": "4321",
  "sender_bank_name": "Example Bank",
  "sender_bank_branch": "Westlands",
  "receipt_number": "BANK-ADVICE-7788",
  "receipt_uploaded_at": "2026-04-30T10:15:00Z",
  "proof_file_name": "bank_advice_7788.pdf",
  "proof_mime_type": "application/pdf",
  "proof_size_bytes": 245123,
  "proof_file_sha256": "0f4be9e5b3f4ad3ea9c7b0f8b74625704e8255f7984b46c06aaf9dd4c6f86d48",
  "requested_asset": "USDT",
  "requested_network": "ethereum",
  "requested_crypto_amount": "100.00000000",
  "pricing_profile_id": "11111111-2222-3333-4444-555555555555",
  "fx_rate_quote_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fiat_amount": "<string>",
  "fiat_currency": "<string>",
  "payment_reference": "<string>",
  "proof_url": "/otc-deposits-proof/ce6e4186-16fe-4e0d-a97d-7638f11c6063/8251c719-0941-46da-8792-5acce5e5efc8.pdf",
  "transfer_date": "2023-11-07T05:31:56Z",
  "merchant_request_id": "<string>",
  "checkout_request_id": "<string>",
  "mpesa_receipt_number": "<string>",
  "mpesa_phone_number": "<string>",
  "sender_account_name": "<string>",
  "sender_account_number_last4": "<string>",
  "sender_bank_name": "<string>",
  "sender_bank_branch": "<string>",
  "receipt_number": "<string>",
  "receipt_uploaded_at": "2023-11-07T05:31:56Z",
  "proof_file_name": "<string>",
  "proof_mime_type": "<string>",
  "proof_size_bytes": 123,
  "proof_file_sha256": "<string>",
  "requested_asset": "<string>",
  "requested_network": "<string>",
  "requested_crypto_amount": "<string>",
  "pricing_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fx_rate_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "confirmed_at": "2023-11-07T05:31:56Z",
  "confirmed_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rejected_at": "2023-11-07T05:31:56Z",
  "rejected_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rejection_reason": "<string>",
  "internal_note": "<string>",
  "credited_at": "2023-11-07T05:31:56Z",
  "credited_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "usdt_amount": "<string>",
  "credited_asset": "<string>",
  "credited_crypto_amount": "<string>",
  "credited_to_address": "TJyF42dRr18tSiXV9Cf7JtYUtTbqAGZg94",
  "to_wallet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payout_to_address": "<string>",
  "payout_to_wallet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payout_network": "<string>",
  "payout_asset": "<string>",
  "transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idempotency_key": "<string>",
  "submitted_at": "2023-11-07T05:31:56Z",
  "assigned_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
method
enum<string>
required
Available options:
bank,
mpesa
​
fiat_amount
string
required
​
fiat_currency
string
required

Active three-letter ISO code in fiat_currencies. List via GET /api/v1/auth/fiat-currencies.

​
payment_reference
string
​
proof_url
string
​
transfer_date
string

YYYY-MM-DD for bank

​
phone_number
string

Required for mpesa

​
sender_account_name
string

Sender account holder name from bank receipt

​
sender_account_number_last4
string

Last 4 digits of sender account number

​
sender_bank_name
string
​
sender_bank_branch
string
​
receipt_number
string

Bank advice/receipt number

​
receipt_uploaded_at
string<date-time>
​
proof_file_name
string
​
proof_mime_type
string
Example:

"application/pdf"

​
proof_size_bytes
integer<int64>
​
proof_file_sha256
string
​
requested_asset
enum<string>
Available options:
USDT,
USDC
​
requested_network
enum<string>

When set on create, the API persists credited_to_address and to_wallet_id from the merchant default wallet on this network.

Available options:
tron,
ethereum
​
requested_crypto_amount
string
​
pricing_profile_id
string<uuid>
​
fx_rate_quote_id
string<uuid>

Response

Deposit created (bank) or mobile money STK initiated

​
id
string<uuid>
​
merchant_id
string<uuid>
​
method
enum<string>
Available options:
bank,
mpesa
​
fiat_amount
string
​
fiat_currency
string
​
status
enum<string>
Available options:
draft,
priced,
pending,
confirmed,
rejected,
credited
​
payment_reference
string | null
​
proof_url
string | null

Relative path to the bank proof PDF. Prepend API base URL for GET in browsers (GET /otc-deposits-proof/..., no auth).

Example:

"/otc-deposits-proof/ce6e4186-16fe-4e0d-a97d-7638f11c6063/8251c719-0941-46da-8792-5acce5e5efc8.pdf"

​
transfer_date
string<date-time> | null
​
merchant_request_id
string | null
​
checkout_request_id
string | null
​
mpesa_receipt_number
string | null
​
mpesa_phone_number
string | null
​
sender_account_name
string | null
​
sender_account_number_last4
string | null
​
sender_bank_name
string | null
​
sender_bank_branch
string | null
​
receipt_number
string | null
​
receipt_uploaded_at
string<date-time> | null
​
proof_file_name
string | null
​
proof_mime_type
string | null
​
proof_size_bytes
integer<int64> | null
​
proof_file_sha256
string | null
​
requested_asset
string | null
​
requested_network
string | null
​
requested_crypto_amount
string | null
​
pricing_profile_id
string<uuid> | null
​
fx_rate_quote_id
string<uuid> | null
​
confirmed_at
string<date-time> | null
​
confirmed_by
string<uuid> | null
​
rejected_at
string<date-time> | null
​
rejected_by
string<uuid> | null
​
rejection_reason
string | null
​
internal_note
string | null
​
credited_at
string<date-time> | null
​
credited_by
string<uuid> | null
​
usdt_amount
string | null
​
credited_asset
string | null
​
credited_crypto_amount
string | null
​
credited_to_address
string | null

Merchant blockchain address to receive USDT/USDC on treasury credit. Resolved from the default wallet for requested_network on the master merchant ledger or a sub-vendor under that merchant. Set on draft, one-shot create (when requested_network is sent), quote refresh, and list backfill when missing.

Example:

"TJyF42dRr18tSiXV9Cf7JtYUtTbqAGZg94"

​
to_wallet_id
string<uuid> | null

Internal wallets.id paired with credited_to_address.

​
payout_to_address
string | null
read-only

Same as credited_to_address when the API enriches the response (list/detail). Omitted when no wallet can be resolved.

​
payout_to_wallet_id
string<uuid> | null
read-only

Same as to_wallet_id on enriched responses.

​
payout_network
string | null
read-only

Network from the resolved payout wallet (tron or ethereum).

​
payout_asset
string | null
read-only

Mirrors requested_asset when enrichment runs.

​
transfer_id
string<uuid> | null
​
idempotency_key
string | null
​
submitted_at
string<date-time> | null
​
assigned_to_user_id
string<uuid> | null
​
created_at
string<date-time>
​
updated_at
string<date-time>