Execute the payments workflow
Launch the execution of a pre-configured workflow, identified by “workflowExecutionId”, once it reaches the READY_FOR_LAUNCH state. The workflow undergoes several phases during execution - EXECUTION_IN_PROGRESS - Marks the start of the workflow execution. EXECUTION_COMPLETED or EXECUTION_FAILED - Indicates the execution has reached a final state.
POST
/
payments
/
workflow_execution
/
{workflowExecutionId}
/
actions
/
execute
Execute the payments workflow
curl --request POST \
--url https://api.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/executeimport requests
url = "https://api.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute', 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.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute"
req, _ := http.NewRequest("POST", url, nil)
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.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"executionId": "<string>",
"configSnapshot": {
"configId": "<string>",
"configName": "<string>",
"createdAt": 123,
"configOperations": [
{
"operationId": "<string>",
"type": "CONVERSION",
"params": {
"destAssetId": "<string>",
"amount": "<string>",
"accountId": "<string>",
"srcAssetId": "<string>",
"slippageBasisPoints": 5000
}
}
],
"externalCorrelationData": {}
},
"executionOperations": [
{
"operationId": "<string>",
"status": "PENDING",
"operationType": "SCREENING",
"validationFailure": {
"reason": "SCREENING_DISABLED_IN_TENANT",
"data": {}
},
"execution": {
"startedAt": 123,
"output": {
"verdicts": [
{
"verdict": "PASSED",
"executionOperationId": "<string>",
"account": {
"accountId": "<string>",
"accountType": "EXCHANGE_ACCOUNT"
},
"assetId": "<string>",
"amount": "<string>",
"matchedRule": {
"action": "<string>",
"category": [
"<string>"
]
}
}
]
},
"finishedAt": 123,
"failure": {
"reason": "AML_PROCESS_FAILED",
"data": {
"verdicts": [
{
"verdict": "PASSED",
"executionOperationId": "<string>",
"account": {
"accountId": "<string>",
"accountType": "EXCHANGE_ACCOUNT"
},
"assetId": "<string>",
"amount": "<string>",
"matchedRule": {
"action": "<string>",
"category": [
"<string>"
]
}
}
]
}
}
}
}
],
"status": "PENDING",
"preScreening": {
"enabled": true
},
"triggeredBy": "<string>",
"triggeredAt": 123,
"finishedAt": 123,
"externalCorrelationData": {}
}{
"error": {
"type": "INTERNAL",
"message": "<string>"
}
}{
"error": {
"type": "INTERNAL",
"message": "<string>"
}
}Headers
Response
Workflow execution has been executed
Was this page helpful?
⌘I
Execute the payments workflow
curl --request POST \
--url https://api.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/executeimport requests
url = "https://api.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute', 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.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute"
req, _ := http.NewRequest("POST", url, nil)
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.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"executionId": "<string>",
"configSnapshot": {
"configId": "<string>",
"configName": "<string>",
"createdAt": 123,
"configOperations": [
{
"operationId": "<string>",
"type": "CONVERSION",
"params": {
"destAssetId": "<string>",
"amount": "<string>",
"accountId": "<string>",
"srcAssetId": "<string>",
"slippageBasisPoints": 5000
}
}
],
"externalCorrelationData": {}
},
"executionOperations": [
{
"operationId": "<string>",
"status": "PENDING",
"operationType": "SCREENING",
"validationFailure": {
"reason": "SCREENING_DISABLED_IN_TENANT",
"data": {}
},
"execution": {
"startedAt": 123,
"output": {
"verdicts": [
{
"verdict": "PASSED",
"executionOperationId": "<string>",
"account": {
"accountId": "<string>",
"accountType": "EXCHANGE_ACCOUNT"
},
"assetId": "<string>",
"amount": "<string>",
"matchedRule": {
"action": "<string>",
"category": [
"<string>"
]
}
}
]
},
"finishedAt": 123,
"failure": {
"reason": "AML_PROCESS_FAILED",
"data": {
"verdicts": [
{
"verdict": "PASSED",
"executionOperationId": "<string>",
"account": {
"accountId": "<string>",
"accountType": "EXCHANGE_ACCOUNT"
},
"assetId": "<string>",
"amount": "<string>",
"matchedRule": {
"action": "<string>",
"category": [
"<string>"
]
}
}
]
}
}
}
}
],
"status": "PENDING",
"preScreening": {
"enabled": true
},
"triggeredBy": "<string>",
"triggeredAt": 123,
"finishedAt": 123,
"externalCorrelationData": {}
}{
"error": {
"type": "INTERNAL",
"message": "<string>"
}
}{
"error": {
"type": "INTERNAL",
"message": "<string>"
}
}