Simulate partner transaction lifecycle events in non-production
curl --request POST \
--url https://api-staging.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"
}
'import requests
url = "https://api-staging.cashweb.cash/api/v1/partner/sandbox/simulate"
payload = {
"event": "deposit.detected",
"transaction_id": "01917f00-7b4c-7f56-8a2b-15998d58c9f3",
"blockchain_hash": "0xabc123sandboxhash",
"deposit_id": "dep_sandbox_001"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event: 'deposit.detected',
transaction_id: '01917f00-7b4c-7f56-8a2b-15998d58c9f3',
blockchain_hash: '0xabc123sandboxhash',
deposit_id: 'dep_sandbox_001'
})
};
fetch('https://api-staging.cashweb.cash/api/v1/partner/sandbox/simulate', 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://api-staging.cashweb.cash/api/v1/partner/sandbox/simulate",
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([
'event' => 'deposit.detected',
'transaction_id' => '01917f00-7b4c-7f56-8a2b-15998d58c9f3',
'blockchain_hash' => '0xabc123sandboxhash',
'deposit_id' => 'dep_sandbox_001'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://api-staging.cashweb.cash/api/v1/partner/sandbox/simulate"
payload := strings.NewReader("{\n \"event\": \"deposit.detected\",\n \"transaction_id\": \"01917f00-7b4c-7f56-8a2b-15998d58c9f3\",\n \"blockchain_hash\": \"0xabc123sandboxhash\",\n \"deposit_id\": \"dep_sandbox_001\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://api-staging.cashweb.cash/api/v1/partner/sandbox/simulate")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"event\": \"deposit.detected\",\n \"transaction_id\": \"01917f00-7b4c-7f56-8a2b-15998d58c9f3\",\n \"blockchain_hash\": \"0xabc123sandboxhash\",\n \"deposit_id\": \"dep_sandbox_001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.cashweb.cash/api/v1/partner/sandbox/simulate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event\": \"deposit.detected\",\n \"transaction_id\": \"01917f00-7b4c-7f56-8a2b-15998d58c9f3\",\n \"blockchain_hash\": \"0xabc123sandboxhash\",\n \"deposit_id\": \"dep_sandbox_001\"\n}"
response = http.request(request)
puts response.read_body{
"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
}{
"error": {
"code": "BAD_REQUEST",
"message": "event must be one of deposit.detected, deposit.confirmed, transaction.completed, transaction.failed, transaction.expired, transaction.refunded, payout.settled",
"timestamp": "2026-02-12T12:00:00Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Partner API
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 --request POST \
--url https://api-staging.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"
}
'import requests
url = "https://api-staging.cashweb.cash/api/v1/partner/sandbox/simulate"
payload = {
"event": "deposit.detected",
"transaction_id": "01917f00-7b4c-7f56-8a2b-15998d58c9f3",
"blockchain_hash": "0xabc123sandboxhash",
"deposit_id": "dep_sandbox_001"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event: 'deposit.detected',
transaction_id: '01917f00-7b4c-7f56-8a2b-15998d58c9f3',
blockchain_hash: '0xabc123sandboxhash',
deposit_id: 'dep_sandbox_001'
})
};
fetch('https://api-staging.cashweb.cash/api/v1/partner/sandbox/simulate', 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://api-staging.cashweb.cash/api/v1/partner/sandbox/simulate",
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([
'event' => 'deposit.detected',
'transaction_id' => '01917f00-7b4c-7f56-8a2b-15998d58c9f3',
'blockchain_hash' => '0xabc123sandboxhash',
'deposit_id' => 'dep_sandbox_001'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://api-staging.cashweb.cash/api/v1/partner/sandbox/simulate"
payload := strings.NewReader("{\n \"event\": \"deposit.detected\",\n \"transaction_id\": \"01917f00-7b4c-7f56-8a2b-15998d58c9f3\",\n \"blockchain_hash\": \"0xabc123sandboxhash\",\n \"deposit_id\": \"dep_sandbox_001\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://api-staging.cashweb.cash/api/v1/partner/sandbox/simulate")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"event\": \"deposit.detected\",\n \"transaction_id\": \"01917f00-7b4c-7f56-8a2b-15998d58c9f3\",\n \"blockchain_hash\": \"0xabc123sandboxhash\",\n \"deposit_id\": \"dep_sandbox_001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.cashweb.cash/api/v1/partner/sandbox/simulate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event\": \"deposit.detected\",\n \"transaction_id\": \"01917f00-7b4c-7f56-8a2b-15998d58c9f3\",\n \"blockchain_hash\": \"0xabc123sandboxhash\",\n \"deposit_id\": \"dep_sandbox_001\"\n}"
response = http.request(request)
puts response.read_body{
"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
}{
"error": {
"code": "BAD_REQUEST",
"message": "event must be one of deposit.detected, deposit.confirmed, transaction.completed, transaction.failed, transaction.expired, transaction.refunded, payout.settled",
"timestamp": "2026-02-12T12:00:00Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Authorizations
Body
application/json
Sandbox-only request for simulating partner transaction lifecycle events.
Consumer-facing event type to simulate.
Example:
"deposit.detected"
Partner transaction identifier to simulate against.
Example:
"01917f00-7b4c-7f56-8a2b-15998d58c9f3"
Optional blockchain hash override for deposit simulations.
Example:
"0xabc123sandboxhash"
Optional sandbox deposit identifier override.
Example:
"dep_sandbox_001"
Response
Sandbox event simulated
Standard API response wrapper for all successful responses
Read partner revenue ledger with deterministic pagination
Previous
List partner transactions with cursor pagination
Next
⌘I