Simulate a payment route
curl --request POST \
--url https://api-dev.rain.xyz/v1/simulate/payment-routes \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"paymentRouteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>"
}
'import requests
url = "https://api-dev.rain.xyz/v1/simulate/payment-routes"
payload = {
"paymentRouteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>"
}
headers = {
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({paymentRouteId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', amount: '<string>'})
};
fetch('https://api-dev.rain.xyz/v1/simulate/payment-routes', 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-dev.rain.xyz/v1/simulate/payment-routes",
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([
'paymentRouteId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <api-key>",
"Content-Type: application/json"
],
]);
$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-dev.rain.xyz/v1/simulate/payment-routes"
payload := strings.NewReader("{\n \"paymentRouteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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-dev.rain.xyz/v1/simulate/payment-routes")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paymentRouteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.rain.xyz/v1/simulate/payment-routes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"paymentRouteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"simulationId": "<string>",
"flow": "usd_onramp",
"status": "accepted",
"provider": {
"accountProviderDepositId": "<string>",
"minterDepositId": "<string>"
}
}Simulations
Simulate a payment route
Triggers a transfer transaction against a configured payment route, exactly as if a real deposit had triggered it. Use this to test the transfer and webhook lifecycle end-to-end.
Supported payment route types:
- MXN payment routes — Both onramps (SPEI → crypto) and offramps (crypto → SPEI)
- USD payment routes — Both onramps (ACH/wire → crypto) and offramps (crypto → ACH/wire)
Sandbox only. This endpoint returns 404 Not Found in production environments.
POST
/
simulate
/
payment-routes
Simulate a payment route
curl --request POST \
--url https://api-dev.rain.xyz/v1/simulate/payment-routes \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"paymentRouteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>"
}
'import requests
url = "https://api-dev.rain.xyz/v1/simulate/payment-routes"
payload = {
"paymentRouteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>"
}
headers = {
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({paymentRouteId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', amount: '<string>'})
};
fetch('https://api-dev.rain.xyz/v1/simulate/payment-routes', 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-dev.rain.xyz/v1/simulate/payment-routes",
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([
'paymentRouteId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <api-key>",
"Content-Type: application/json"
],
]);
$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-dev.rain.xyz/v1/simulate/payment-routes"
payload := strings.NewReader("{\n \"paymentRouteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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-dev.rain.xyz/v1/simulate/payment-routes")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paymentRouteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.rain.xyz/v1/simulate/payment-routes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"paymentRouteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"simulationId": "<string>",
"flow": "usd_onramp",
"status": "accepted",
"provider": {
"accountProviderDepositId": "<string>",
"minterDepositId": "<string>"
}
}Authorizations
Headers
Optional idempotency/correlation key (1-64 chars). If omitted, each call produces a new simulation.
Required string length:
1 - 64Body
application/json
Payment route simulation request
Response
MXN payment route simulation completed synchronously
The transaction ID. Call GET /v1/transactions/:transactionId to fetch full details and current status.