Skip to main content
POST
/
payments
/
workflow_execution
Create workflow execution
curl --request POST \
  --url https://api.fireblocks.io/v1/payments/workflow_execution \
  --header 'Content-Type: application/json' \
  --data '
{
  "configId": "<string>",
  "params": [
    {
      "configOperationId": "<string>",
      "executionParams": {
        "amount": "<string>",
        "accountId": "<string>",
        "srcAssetId": "<string>",
        "destAssetId": "<string>",
        "slippageBasisPoints": 5000
      }
    }
  ],
  "externalCorrelationData": {}
}
'
{
  "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": {}
}

Documentation Index

Fetch the complete documentation index at: https://developers.fireblocks.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

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.

Body

application/json
configId
string
required
params
object[]
required
preScreening
object
externalCorrelationData

Response

Workflow execution entity has been created successfully.

executionId
string
required
configSnapshot
object
required
executionOperations
object[]
required
status
enum<string>
required
Available options:
PENDING,
VALIDATION_IN_PROGRESS,
VALIDATION_FAILED,
VALIDATION_COMPLETED,
PREVIEW_IN_PROGRESS,
PREVIEW_FAILED,
READY_FOR_LAUNCH,
EXECUTION_IN_PROGRESS,
EXECUTION_COMPLETED,
EXECUTION_FAILED
preScreening
object
triggeredBy
string
triggeredAt
number
finishedAt
number
externalCorrelationData