Fireblocks API Documentation
Create workflow execution
POST {{baseUrl}}/payments/workflow_execution
Validate the workflow-config
previously created by utilizing the unique configId
. This step requires the mandatory field amount, and allows for modifications to other fields defined via the workflow-config
endpoint, including pre-screening preferences. A response containing the workflowExecutionId
and detailing the validation status will be provided. Execution is ready when the workflow-execution
status is READYFORLAUNCH, at which point it can be initiated with POST /workflow-execution/{workflowExecutionId}/actions/execute
.
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. | |
Content-Type
|
string | ||
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": " Curl curl -X POST 'https://api.fireblocks.io/v1/payments/workflow_execution' -H 'Idempotency-Key: <string>' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"configId":"\u003cstring\u003e","params":[{"configOperationId":"\u003cstring\u003e","executionParams":{"amount":"\u003cstring\u003e","accountId":"\u003cstring\u003e","srcAssetId":"\u003cstring\u003e","destAssetId":"\u003cstring\u003e","slippageBasisPoints":"\u003cinteger\u003e"}},{"configOperationId":"\u003cstring\u003e","executionParams":{"amount":"\u003cstring\u003e","accountId":"\u003cstring\u003e","srcAssetId":"\u003cstring\u003e","destAssetId":"\u003cstring\u003e","slippageBasisPoints":"\u003cinteger\u003e"}}],"preScreening":{"enabled":"\u003cboolean\u003e"},"externalCorrelationData":{"site":"\u003cstring\u003e","ipsum057":"\u003cstring\u003e"}}' ENDPOINTS |