Get a workflow instance stage history

Get a workflow instance stage history

GET /api/orchestration/instances/{instanceID}/stages/{number}/history

Try it

Get a workflow instance stage history

cURL

curl --request GET \
  --url http://localhost/api/orchestration/instances/{instanceID}/stages/{number}/history \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "name": "<string>",
      "input": {
        "GetAccount": {
          "id": "<string>",
          "ledger": "<string>"
        },
        "AddAccountMetadata": {
          "id": "<string>",
          "ledger": "<string>",
          "metadata": {}
        },
        "CreateTransaction": {
          "ledger": "<string>",
          "data": {
            "metadata": {
              "admin": "true"
            },
            "timestamp": "2023-11-07T05:31:56Z",
            "postings": [
              {
                "amount": 100,
                "asset": "COIN",
                "destination": "users:002",
                "source": "users:001"
              }
            ],
            "script": {
              "plain": "vars {\naccount $user\n}\nsend [COIN 10] (\n\tsource = @world\n\tdestination = $user\n)\n",
              "vars": {
                "user": "users:042"
              }
            },
            "reference": "ref:001"
          }
        },
        "RevertTransaction": {
          "id": "<string>",
          "ledger": "<string>"
        },
        "StripeTransfer": {
          "connectorID": "<string>",
          "amount": 100,
          "asset": "USD",
          "destination": "acct_1Gqj58KZcSIg2N2q",
          "waitingValidation": false,
          "metadata": {
            "order_id": "6735"
          }
        },
        "GetPayment": {
          "id": "<string>"
        },
        "ConfirmHold": {
          "id": "<string>"
        },
        "CreditWallet": {
          "id": "<string>",
          "data": {
            "amount": {
              "asset": "USD/2",
              "amount": 100
            },
            "metadata": {
              "key": ""
            },
            "sources": []
          }
        },
        "DebitWallet": {
          "id": "<string>",
          "data": {
            "amount": {
              "asset": "USD/2",
              "amount": 100
            },
            "metadata": {
              "key": ""
            },
            "pending": true
          }
        },
        "GetWallet": {
          "id": "<string>"
        },
        "VoidHold": {
          "id": "<string>"
        },
        "ListWallets": {
          "name": "<string>"
        }
      },
      "terminated": true,
      "startedAt": "2023-11-07T05:31:56Z",
      "attempt": 123,
      "output": {
        "GetAccount": {
          "data": {
            "address": "users:001",
            "metadata": {
              "admin": "true"
            },
            "volumes": {
              "USD": {
                "input": 100,
                "output": 10,
                "balance": 90
              },
              "EUR": {
                "input": 100,
                "output": 10,
                "balance": 90
              }
            },
            "effectiveVolumes": {
              "USD": {
                "input": 100,
                "output": 10,
                "balance": 90
              },
              "EUR": {
                "input": 100,
                "output": 10,
                "balance": 90
              }
            }
          }
        },
        "CreateTransaction": {
          "data": {
            "timestamp": "2023-11-07T05:31:56Z",
            "postings": [
              {
                "amount": 100,
                "asset": "COIN",
                "destination": "users:002",
                "source": "users:001"
              }
            ],
            "metadata": {
              "admin": "true"
            },
            "id": 1,
            "reverted": true,
            "reference": "ref:001"
          }
        },
        "RevertTransaction": {
          "data": {
            "timestamp": "2023-11-07T05:31:56Z",
            "postings": [
              {
                "amount": 100,
                "asset": "COIN",
                "destination": "users:002",
                "source": "users:001"
              }
            ],
            "metadata": {
              "admin": "true"
            },
            "id": 1,
            "reverted": true,
            "reference": "ref:001"
          }
        },
        "GetPayment": {
          "data": {
            "id": "XXX",
            "reference": "<string>",
            "sourceAccountID": "<string>",
            "destinationAccountID": "<string>",
            "connectorID": "<string>",
            "type": "PAY-IN",
            "status": "PENDING",
            "initialAmount": 100,
            "scheme": "visa",
            "asset": "USD",
            "createdAt": "2023-11-07T05:31:56Z",
            "raw": {},
            "adjustments": [
              {
                "status": "PENDING",
                "amount": 100,
                "date": "2023-11-07T05:31:56Z",
                "raw": {},
                "absolute": true
              }
            ],
            "metadata": {
              "key": "<string>"
            },
            "provider": "STRIPE"
          }
        },
        "DebitWallet": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "walletID": "<string>",
            "metadata": {},
            "description": "<string>",
            "destination": {
              "type": "<string>",
              "identifier": "<string>"
            }
          }
        },
        "GetWallet": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "metadata": {},
            "name": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "balances": {
              "main": {
                "assets": {}
              }
            },
            "ledger": "<string>"
          }
        },
        "ListWallets": {
          "cursor": {
            "pageSize": 15,
            "data": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "metadata": {},
                "name": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "ledger": "<string>"
              }
            ],
            "hasMore": false,
            "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
            "next": ""
          }
        }
      },
      "error": "<string>",
      "terminatedAt": "2023-11-07T05:31:56Z",
      "lastFailure": "<string>",
      "nextExecution": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

instanceID · string · required

The instance id

number · integer · required

The stage number

Response

200

application/json

The workflow instance stage history

data · object[] · required

Show child attributes

data. name · string · required

data. input · object · required

Show child attributes

data.input. GetAccount · object

Show child attributes

data.input.GetAccount. id · string · required

data.input.GetAccount. ledger · string · required

data.input. AddAccountMetadata · object

Show child attributes

data.input.AddAccountMetadata. id · string · required

data.input.AddAccountMetadata. ledger · string · required

data.input.AddAccountMetadata. metadata · object · required

Show child attributes

data.input.AddAccountMetadata.metadata. {key} · string

data.input. CreateTransaction · object

Show child attributes

data.input.CreateTransaction. ledger · string

data.input.CreateTransaction. data · object

Show child attributes

data.input.CreateTransaction.data. metadata · object · required

Show child attributes

data.input.CreateTransaction.data.metadata. {key} · string

Example:

{ "admin": "true" }

data.input.CreateTransaction.data. timestamp · string<date-time>

data.input.CreateTransaction.data. postings · object[]

Show child attributes

data.input.CreateTransaction.data.postings. amount · integer<bigint> · required

Required range: x >= 0

Example:

100

data.input.CreateTransaction.data.postings. asset · string · required

Example:

"COIN"

data.input.CreateTransaction.data.postings. destination · string · required

Example:

"users:002"

data.input.CreateTransaction.data.postings. source · string · required

Example:

"users:001"

data.input.CreateTransaction.data. script · object

Show child attributes

data.input.CreateTransaction.data.script. plain · string · required

Example:

"vars {\naccount $user\n}\nsend [COIN 10] (\n\tsource = @world\n\tdestination = $user\n)\n"

data.input.CreateTransaction.data.script. vars · object

Example:

{ "user": "users:042" }

data.input.CreateTransaction.data. reference · string

Example:

"ref:001"

data.input. RevertTransaction · object

Show child attributes

data.input.RevertTransaction. id · string · required

data.input.RevertTransaction. ledger · string · required

data.input. StripeTransfer · object

Show child attributes

data.input.StripeTransfer. connectorID · string

data.input.StripeTransfer. amount · integer<bigint>

Required range: x >= 0

Example:

100

data.input.StripeTransfer. asset · string

Example:

"USD"

data.input.StripeTransfer. destination · string

Example:

"acct_1Gqj58KZcSIg2N2q"

data.input.StripeTransfer. waitingValidation · boolean · default: false

Example:

false

data.input.StripeTransfer. metadata · object

A set of key/value pairs that you can attach to a transfer object. It can be useful for storing additional information about the transfer in a structured format.

Example:

{ "order_id": "6735" }

data.input. GetPayment · object

Show child attributes

data.input.GetPayment. id · string · required

data.input. ConfirmHold · object

Show child attributes

data.input.ConfirmHold. id · string · required

data.input. CreditWallet · object

Show child attributes

data.input.CreditWallet. id · string

data.input.CreditWallet. data · object

Show child attributes

data.input.CreditWallet.data. amount · object · required

Show child attributes

data.input.CreditWallet.data.amount. asset · string · required

The asset of the monetary value.

data.input.CreditWallet.data.amount. amount · integer<bigint> · required

The amount of the monetary value.

data.input.CreditWallet.data. metadata · object · required

Metadata associated with the wallet.

Show child attributes

data.input.CreditWallet.data.metadata. {key} · string

data.input.CreditWallet.data. sources · object[] · required

Option 1

Show child attributes

data.input.CreditWallet.data.sources. type · string · required

data.input.CreditWallet.data.sources. identifier · string · required

data.input.CreditWallet.data. reference · string

data.input.CreditWallet.data. balance · string

The balance to credit

data.input.CreditWallet.data. timestamp · string<date-time>

Example:

{
  "amount": { "asset": "USD/2", "amount": 100 },
  "metadata": { "key": "" },
  "sources": []
}

data.input. DebitWallet · object

Show child attributes

data.input.DebitWallet. id · string

data.input.DebitWallet. data · object

Show child attributes

data.input.DebitWallet.data. amount · object · required

Show child attributes

data.input.DebitWallet.data.amount. asset · string · required

The asset of the monetary value.

data.input.DebitWallet.data.amount. amount · integer<bigint> · required

The amount of the monetary value.

data.input.DebitWallet.data. metadata · object · required

Metadata associated with the wallet.

Show child attributes

data.input.DebitWallet.data.metadata. {key} · string

data.input.DebitWallet.data. pending · boolean

Set to true to create a pending hold. If false, the wallet will be debited immediately.

data.input.DebitWallet.data. description · string

data.input.DebitWallet.data. destination · object

Option 1

Show child attributes

data.input.DebitWallet.data.destination. type · string · required

data.input.DebitWallet.data.destination. identifier · string · required

data.input.DebitWallet.data. balances · string[]

A targeted balance (use '*' for all)

data.input.DebitWallet.data. timestamp · string<date-time>

cannot be used in conjunction with pending property

Example:

{
  "amount": { "asset": "USD/2", "amount": 100 },
  "metadata": { "key": "" },
  "pending": true
}

data.input. GetWallet · object

Show child attributes

data.input.GetWallet. id · string · required

data.input. VoidHold · object

Show child attributes

data.input.VoidHold. id · string · required

data.input. ListWallets · object

Show child attributes

data.input.ListWallets. name · string

data. terminated · boolean · required

data. startedAt · string<date-time> · required

data. attempt · integer · required

data. output · object

Show child attributes

data.output. GetAccount · object

Show child attributes

data.output.GetAccount. data · object · required

Show child attributes

data.output.GetAccount.data. address · string · required

Example:

"users:001"

data.output.GetAccount.data. metadata · object · required

Show child attributes

data.output.GetAccount.data.metadata. {key} · string

Example:

{ "admin": "true" }

data.output.GetAccount.data. volumes · object

Show child attributes

data.output.GetAccount.data.volumes. {key} · object

Show child attributes

data.output.GetAccount.data.volumes.{key}. input · integer<bigint> · required

data.output.GetAccount.data.volumes.{key}. output · integer<bigint> · required

data.output.GetAccount.data.volumes.{key}. balance · integer<bigint>

Example:

{ "input": 100, "output": 20, "balance": 80 }

Example:

{
  "USD": { "input": 100, "output": 10, "balance": 90 },
  "EUR": { "input": 100, "output": 10, "balance": 90 }
}

data.output.GetAccount.data. effectiveVolumes · object

Show child attributes

data.output.GetAccount.data.effectiveVolumes. {key} · object

Show child attributes

data.output.GetAccount.data.effectiveVolumes.{key}. input · integer<bigint> · required

data.output.GetAccount.data.effectiveVolumes.{key}. output · integer<bigint> · required

data.output.GetAccount.data.effectiveVolumes.{key}. balance · integer<bigint>

Example:

{ "input": 100, "output": 20, "balance": 80 }

Example:

{
  "USD": { "input": 100, "output": 10, "balance": 90 },
  "EUR": { "input": 100, "output": 10, "balance": 90 }
}

data.output. CreateTransaction · object

Show child attributes

data.output.CreateTransaction. data · object · required

Show child attributes

data.output.CreateTransaction.data. timestamp · string<date-time> · required

data.output.CreateTransaction.data. postings · object[] · required

Show child attributes

data.output.CreateTransaction.data.postings. amount · integer<bigint> · required

Required range: x >= 0

Example:

100

data.output.CreateTransaction.data.postings. asset · string · required

Example:

"COIN"

data.output.CreateTransaction.data.postings. destination · string · required

Example:

"users:002"

data.output.CreateTransaction.data.postings. source · string · required

Example:

"users:001"

data.output.CreateTransaction.data. metadata · object · required

Show child attributes

data.output.CreateTransaction.data.metadata. {key} · string

Example:

{ "admin": "true" }

data.output.CreateTransaction.data. id · integer<bigint> · required

Required range: x >= 0

data.output.CreateTransaction.data. reverted · boolean · required

data.output.CreateTransaction.data. reference · string

Example:

"ref:001"

data.output. RevertTransaction · object

Show child attributes

data.output.RevertTransaction. data · object · required

Show child attributes

data.output.RevertTransaction.data. timestamp · string<date-time> · required

data.output.RevertTransaction.data. postings · object[] · required

Show child attributes

data.output.RevertTransaction.data.postings. amount · integer<bigint> · required

Required range: x >= 0

Example:

100

data.output.RevertTransaction.data.postings. asset · string · required

Example:

"COIN"

data.output.RevertTransaction.data.postings. destination · string · required

Example:

"users:002"

data.output.RevertTransaction.data.postings. source · string · required

Example:

"users:001"

data.output.RevertTransaction.data. metadata · object · required

Show child attributes

data.output.RevertTransaction.data.metadata. {key} · string

Example:

{ "admin": "true" }

data.output.RevertTransaction.data. id · integer<bigint> · required

Required range: x >= 0

data.output.RevertTransaction.data. reverted · boolean · required

data.output.RevertTransaction.data. reference · string

Example:

"ref:001"

data.output. GetPayment · object

Show child attributes

data.output.GetPayment. data · object · required

Show child attributes

data.output.GetPayment.data. id · string · required

Example:

"XXX"

data.output.GetPayment.data. reference · string · required

data.output.GetPayment.data. sourceAccountID · string · required

data.output.GetPayment.data. destinationAccountID · string · required

data.output.GetPayment.data. connectorID · string · required

data.output.GetPayment.data. type · enum<string> · required

Available options: PAY-IN, PAYOUT, TRANSFER, OTHER

data.output.GetPayment.data. status · enum<string> · required

Available options: PENDING, ACTIVE, TERMINATED, FAILED, SUCCEEDED, CANCELLED

data.output.GetPayment.data. initialAmount · integer<bigint> · required

Required range: x >= 0

Example:

100

data.output.GetPayment.data. scheme · enum<string> · required

Available options: visa, mastercard, amex, diners, discover, jcb, unionpay, sepa debit, sepa credit, sepa, apple pay, google pay, a2a, ach debit, ach, rtp, unknown, other

data.output.GetPayment.data. asset · string · required

Example:

"USD"

data.output.GetPayment.data. createdAt · string<date-time> · required

data.output.GetPayment.data. raw · object · required

data.output.GetPayment.data. adjustments · object[] · required

Show child attributes

data.output.GetPayment.data.adjustments. status · enum<string> · required

Available options: PENDING, ACTIVE, TERMINATED, FAILED, SUCCEEDED, CANCELLED

data.output.GetPayment.data.adjustments. amount · integer<bigint> · required

Required range: x >= 0

Example:

100

data.output.GetPayment.data.adjustments. date · string<date-time> · required

data.output.GetPayment.data.adjustments. raw · object · required

data.output.GetPayment.data.adjustments. absolute · boolean · required

data.output.GetPayment.data. metadata · object · required

Show child attributes

data.output.GetPayment.data.metadata. key · string

data.output.GetPayment.data. provider · enum<string>

Available options: STRIPE, DUMMY-PAY, WISE, MODULR, CURRENCY-CLOUD, BANKING-CIRCLE, MANGOPAY, MONEYCORP

data.output. DebitWallet · object

Show child attributes

data.output.DebitWallet. data · object · required

Show child attributes

data.output.DebitWallet.data. id · string<uuid> · required

The unique ID of the hold.

data.output.DebitWallet.data. walletID · string · required

The ID of the wallet the hold is associated with.

data.output.DebitWallet.data. metadata · object · required

Metadata associated with the hold.

Show child attributes

data.output.DebitWallet.data.metadata. {key} · string

data.output.DebitWallet.data. description · string · required

data.output.DebitWallet.data. destination · object

Option 1

Show child attributes

data.output.DebitWallet.data.destination. type · string · required

data.output.DebitWallet.data.destination. identifier · string · required

data.output. GetWallet · object

Show child attributes

data.output.GetWallet. data · object · required

Show child attributes

data.output.GetWallet.data. id · string<uuid> · required

The unique ID of the wallet.

data.output.GetWallet.data. metadata · object · required

Metadata associated with the wallet.

Show child attributes

data.output.GetWallet.data.metadata. {key} · string

data.output.GetWallet.data. name · string · required

data.output.GetWallet.data. createdAt · string<date-time> · required

data.output.GetWallet.data. balances · object · required

Show child attributes

data.output.GetWallet.data.balances. main · object · required

Show child attributes

data.output.GetWallet.data.balances.main. assets · object · required

Show child attributes

data.output.GetWallet.data.balances.main.assets. {key} · integer<bigint>

data.output.GetWallet.data. ledger · string · required

data.output. ListWallets · object

Show child attributes

data.output.ListWallets. cursor · object · required

Show child attributes

data.output.ListWallets.cursor. pageSize · integer<int64> · required

Required range: 1 <= x <= 1000

Example:

15

data.output.ListWallets.cursor. data · object[] · required

Show child attributes

data.output.ListWallets.cursor.data. id · string<uuid> · required

The unique ID of the wallet.

data.output.ListWallets.cursor.data. metadata · object · required

Metadata associated with the wallet.

Show child attributes

data.output.ListWallets.cursor.data.metadata. {key} · string

data.output.ListWallets.cursor.data. name · string · required

data.output.ListWallets.cursor.data. createdAt · string<date-time> · required

data.output.ListWallets.cursor.data. ledger · string · required

data.output.ListWallets.cursor. hasMore · boolean

Example:

false

data.output.ListWallets.cursor. previous · string

Example:

"YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol="

data.output.ListWallets.cursor. next · string

Example:

""

data. error · string

data. terminatedAt · string<date-time>

data. lastFailure · string

data. nextExecution · string<date-time>