Simulate partner transaction lifecycle events in non-production

Sandbox-only endpoint for simulating partner transaction lifecycle events. You must first create a transaction and pass its returned id as transaction_id in the request body. This route is mounted only in non-production environments and hard-rejects when called against production state.

POST /partner/sandbox/simulate

Simulate partner transaction lifecycle events in non-production

cURL

curl --request POST \
  --url https://dev.cashweb.cash/api/v1/partner/sandbox/simulate \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "event": "deposit.detected",
  "transaction_id": "01917f00-7b4c-7f56-8a2b-15998d58c9f3",
  "blockchain_hash": "0xabc123sandboxhash",
  "deposit_id": "dep_sandbox_001"
}
'

200

{
  "data": {
    "amount": "49000.00",
    "confirmations": 1,
    "confirmed_at": "2026-02-12T12:01:00Z",
    "created_at": "2026-02-12T11:55:00Z",
    "crypto_amount": "100.00",
    "crypto_currency": "usdt",
    "deposit_address": "TUr4xexampleaddress",
    "deposit_id": "dep_sandbox_001",
    "deposit_status": "confirmed",
    "expires_at": "2026-02-12T12:30:00Z",
    "id": "01917f00-7b4c-7f56-8a2b-15998d58c9f3",
    "merchant_id": "mrc_001",
    "merchant_reference": "order-4551",
    "network": "trc20",
    "rate": "490.00",
    "received_at": "2026-02-12T11:58:00Z",
    "required_confirmations": 1,
    "status": "deposit_confirming",
    "terminal_id": "term_01",
    "updated_at": "2026-02-12T12:01:00Z"
  },
  "success": true
}

Authorizations

X-API-KEY · string · header · required

Body

application/json

Sandbox-only request for simulating partner transaction lifecycle events.

event · string · required

Consumer-facing event type to simulate.

Example:

"deposit.detected"

transaction_id · string<uuid> · required

Partner transaction identifier to simulate against.

Example:

"01917f00-7b4c-7f56-8a2b-15998d58c9f3"

blockchain_hash · string | null

Optional blockchain hash override for deposit simulations.

Example:

"0xabc123sandboxhash"

deposit_id · string | null

Optional sandbox deposit identifier override.

Example:

"dep_sandbox_001"

Response

200

application/json

Sandbox event simulated

Standard API response wrapper for all successful responses

data · object · required

Detailed partner transaction snapshot for TSQ and recovery reads.

Show child attributes

success · boolean · required

Indicates if the request was successful

Example:

"true"

message · string | null

Optional message for additional information