Execute the payments workflow - Fireblocks Developer Docs

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/execute

{
  "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>",
      "operationType": "SCREENING",
      "validationFailure": {
        "reason": "SCREENING_DISABLED_IN_TENANT",
        "data": {}
      },
      "execution": {
        "startedAt": 123,
        "output": {
          "verdicts": [
            {
              "executionOperationId": "<string>",
              "account": {
                "accountId": "<string>"
              },
              "assetId": "<string>",
              "amount": "<string>",
              "matchedRule": {
                "action": "<string>",
                "category": [
                  "<string>"
                ]
              }
            }
          ]
        },
        "finishedAt": 123,
        "failure": {
          "data": {
            "verdicts": [
              {
                "executionOperationId": "<string>",
                "account": {
                  "accountId": "<string>"
                },
                "assetId": "<string>",
                "amount": "<string>",
                "matchedRule": {
                  "action": "<string>",
                  "category": [
                    "<string>"
                  ]
                }
              }
            ]
          }
        }
      }
    }
  ],
  "preScreening": {
    "enabled": true
  },
  "triggeredBy": "<string>",
  "triggeredAt": 123,
  "finishedAt": 123,
  "externalCorrelationData": {}
}

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.

Path Parameters

workflowExecutionId

string

required

Response

Workflow execution has been executed

executionId

string

required

configSnapshot

object

required

Show child attributes

executionOperations

object[]

required

Option 1
Option 2
Option 3
Option 4

Show child attributes

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

Show child attributes

triggeredBy

string

triggeredAt

number

finishedAt

number

externalCorrelationData

Show child attributes

Create a payout instruction set**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts. These endpoints are currently in beta and might be subject to changes. If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com. **Create a payout instruction set.** A payout instruction set is a set of instructions for distributing payments from a single payment account to a list of payee accounts. The instruction set defines: - the payment account and its account type (vault, exchange, or fiat). - the account type (vault account, exchange account, whitelisted address, network connection, fiat account, or merchant account), the amount, and the asset of payment for each payee account. Learn more about Fireblocks Payments - Payouts in the following [guide](https://developers.fireblocks.com/docs/create-payouts). Endpoint Permission: Admin, Non-Signing Admin.

Execute the payments workflow

curl --request POST \
  --url https://api.fireblocks.io/v1/payments/workflow_execution/{workflowExecutionId}/actions/execute

{
  "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>",
      "operationType": "SCREENING",
      "validationFailure": {
        "reason": "SCREENING_DISABLED_IN_TENANT",
        "data": {}
      },
      "execution": {
        "startedAt": 123,
        "output": {
          "verdicts": [
            {
              "executionOperationId": "<string>",
              "account": {
                "accountId": "<string>"
              },
              "assetId": "<string>",
              "amount": "<string>",
              "matchedRule": {
                "action": "<string>",
                "category": [
                  "<string>"
                ]
              }
            }
          ]
        },
        "finishedAt": 123,
        "failure": {
          "data": {
            "verdicts": [
              {
                "executionOperationId": "<string>",
                "account": {
                  "accountId": "<string>"
                },
                "assetId": "<string>",
                "amount": "<string>",
                "matchedRule": {
                  "action": "<string>",
                  "category": [
                    "<string>"
                  ]
                }
              }
            ]
          }
        }
      }
    }
  ],
  "preScreening": {
    "enabled": true
  },
  "triggeredBy": "<string>",
  "triggeredAt": 123,
  "finishedAt": 123,
  "externalCorrelationData": {}
}