APIPayment flows
Simulate payment flow
Simulate a payment flow execution to check shop availability without affecting any state (such as round robin counters). This is useful for validation before actual processing.
Authorization<token>
Enter token in format (Bearer )
In: header
flow_namestring
amount?number
Defaults to 100.00 if not provided
Format
floatcurrency?string
Defaults to USD if not provided
Length
length <= 3country?string
Length
length <= 2customer_id?integer
metadata?object
Empty Object
simple?boolean
Set to true to return only a boolean response indicating availability
Response Body
curl -X POST "https://orchestrator.tuxopay.com/api/flows/simulate" \ -H "Content-Type: application/json" \ -d '{ "flow_name": "primary-flow" }'{
"success": true,
"data": {
"success": true,
"flow": {
"id": 1,
"name": "primary-flow",
"strategy": "round_robin"
},
"result": {
"strategy": "round_robin",
"primary_shop": {
"shop_id": 2,
"shop_name": "Secondary Shop",
"priority": 5,
"weight": 30
},
"simulation_mode": true,
"current_counter": 1,
"next_counter": 2
},
"simulation": true
}
}{
"success": false,
"error": "Flow not found"
}