Fireblocks API Documentation
Execute the payments workflow
POST {{baseUrl}}/payments/workflow_execution/:workflowExecutionId/actions/execute
Launch the execution of a pre-configured workflow, identified by workflowExecutionId
, once it reaches the READYFORLAUNCH state. The workflow undergoes several phases during execution - EXECUTIONINPROGRESS - Marks the start of the workflow execution. EXECUTIONCOMPLETED or EXECUTIONFAILED - Indicates the execution has reached a final state.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Idempotency-Key
|
string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | |
Accept
|
string |
RESPONSES
status OK
| {
"executionId": "<string>",
"status": "PREVIEW_FAILED",
"executionOperations": [
{
"operationId": "<string>",
"status": "PREVIEW_IN_PROGRESS",
"operationType": "SCREENING",
"validationFailure": {
"reason": "SCREENING_DISABLED_IN_TENANT",
"data": {
"Lorem_f": {},
"Duis_2": {}
}
},
"execution": {
"startedAt": "<number>",
"output": {
"verdicts": [
{
"executionOperationId": "<string>",
"account": {
"accountId": "<string>",
"accountType": "NETWORK_CONNECTION"
},
"verdict": "PASSED_WITH_ALERT",
"assetId": "<string>",
"amount": "<string>",
"matchedRule": {
"action": "<string>",
"category": [
"<string>",
"<string>"
]
}
},
{
"executionOperationId": "<string>",
"account": {
"accountId": "<string>",
"accountType": "EXCHANGE_ACCOUNT"
},
"verdict": "REJECTED",
"assetId": "<string>",
"amount": "<string>",
"matchedRule": {
"action": "<string>",
"category": [
"<string>",
"<string>"
]
}
}
]
},
"finishedAt": "<number>",
"failure": {
"reason": "SCREENING_REJECTED",
"data": {
"verdicts": [
{
"executionOperationId": "<string>",
"account": {
"accountId": "<string>",
"accountType": "EXCHANGE_ACCOUNT"
},
"verdict": "REJECTED",
"assetId": "<string>",
"amount": "<string>",
Curl curl -X POST 'https://api.fireblocks.io/v1/payments/workflow_execution/:workflowExecutionId/actions/execute' -H 'Idempotency-Key: <string>' -H 'Accept: application/json' ENDPOINTS |