Get an order

Returns the current state of an order you own. Poll it after depositing, or rely on webhooks and use this as the source of truth.

Endpoint

GET https://merchant.minisend.xyz/api/offramp/orders/{order_id}

Authorization: Bearer ms_live_your_key_here

Requires the offramp scope. Orders you don’t own return 404.

Example

curl https://merchant.minisend.xyz/api/offramp/orders/9b2f6c1e-... \
  -H "Authorization: Bearer ms_live_your_key_here"

Response (200)

{
  "order_id": "9b2f6c1e-...",
  "status": "completed",
  "amount_usdc": 10,
  "total_deposit_usdc": 10,
  "currency": "KES",
  "rate": 129.52,
  "amount_local": 1295,
  "fee": 13,
  "deposit_address": "0x8005ee53e57ab11e11eaa4efe07ee3835dc02f98",
  "deposit_chain": "base",
  "deposit_tx_hash": "0x55a572efe1720250e442f38741477a4fc3f7f152e5cd208cc52f8222a1c2a13b",
  "recipient": {
    "account_name": "Jane Wanjiku",
    "method": "MOBILE",
    "phone": "0712345678"
  },
  "refund_address": "0xYourWalletAddress0000000000000000000000",
  "external_reference": "payout-8412",
  "settlement_receipt": "SHQ1234ABC",
  "expires_at": "2026-07-05T12:30:00.000Z",
  "completed_at": "2026-07-05T12:07:41.000Z",
  "created_at": "2026-07-05T12:00:03.000Z"
}

status

string

required

pending, settling, completed, failed, or expired. See the lifecycle. A pending order past expires_at flips to expired when fetched.

total_deposit_usdc

number

required

The exact USDC to deposit: amount_usdc plus network fees on NGN orders.

rate

number

required

For settling and later on KES, GHS, and UGX orders this is the executed rate; before that, the quote. Locked at creation for NGN.

deposit_tx_hash

string

Your deposit transaction, once submitted (KES, GHS, UGX) or detected (NGN).

settlement_receipt

string

Set on completed: the payout receipt (an M-Pesa code for KES mobile, an on-chain settlement hash for NGN).

completed_at

string

ISO 8601, set on completed.

Errors

Status	Meaning
`403`	Key lacks the `offramp` scope or off-ramp is not enabled on your account
`404`	Unknown order, or it belongs to another account

​Endpoint

​Example

​Response (200)

​Errors

Endpoint

Example

Response (200)

Errors