APIPayment flows
Initiate payment with flow
Initiate a payment using a configured payment flow with customer data and custom redirect URLs
Authorization<token>
Enter token in format (Bearer )
In: header
flow_namestring
amountnumber
Format
floatcurrencystring
Length
length <= 3description?string
return_url?string
Format
urlwebhook_endpoint?string
Format
urlcancel_url?string
Format
urlfirst_visit_redirect_url?string
Format
urlsubsequent_visit_redirect_url?string
Format
urlcustomer?object
items?array<object>
metadata?object
Empty Object
Response Body
curl -X POST "https://orchestrator.tuxopay.com/api/payment-flows/initiate" \ -H "Content-Type: application/json" \ -d '{ "flow_name": "default_blackpay", "amount": 49.99, "currency": "USD" }'{
"success": true,
"data": {
"flow_result": {},
"payment_result": {
"success": true,
"payment_id": 123,
"redirect_url": "string",
"payment_session_id": "abc123def456",
"expires_at": "2019-08-24T14:15:22Z",
"provider": "blackpay"
},
"attempts": 1
}
}{
"success": false,
"error": "string"
}