API Reference v3.0
- auth.v1
- API Reference
- ledger.v1
- ledger.v2
- payments.v1
- payments.v3
- search.v1
- webhooks.v1
- wallets.v1
- orchestration.v1
- orchestration.v2
- GETGet server info
- GETList triggers
- POSTCreate trigger
- GETRead trigger
- DELDelete trigger
- POSTTest trigger
- GETList triggers occurrences
- GETList registered workflows
- POSTCreate workflow
- GETGet a flow by id
- DELDelete a flow by id
- POSTRun workflow
- GETList instances of a workflow
- GETGet a workflow instance by id
- POSTSend an event to a running workflow
- PUTCancel a running workflow
- GETGet a workflow instance history by id
- GETGet a workflow instance stage history
- GET
- reconciliation.v1
orchestration.v2
Get a workflow instance stage history
Get a workflow instance stage history
GET
/
api
/
orchestration
/
v2
/
instances
/
{instanceID}
/
stages
/
{number}
/
history
Copy
Ask AI
curl --request GET \
--url http://localhost:55001/api/orchestration/v2/instances/{instanceID}/stages/{number}/history \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"data": [
{
"name": "<string>",
"input": {
"GetAccount": {
"id": "<string>",
"ledger": "<string>"
},
"AddAccountMetadata": {
"id": "<string>",
"ledger": "<string>",
"metadata": {}
},
"CreateTransaction": {
"ledger": "<string>",
"data": {
"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",
"metadata": {
"admin": "true"
}
}
},
"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>"
}
},
"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"
}
],
"reference": "ref:001",
"metadata": {
"admin": "true"
},
"txid": 1
}
]
},
"GetPayment": {
"data": {
"id": "XXX",
"reference": "<string>",
"sourceAccountID": "<string>",
"destinationAccountID": "<string>",
"connectorID": "<string>",
"provider": "STRIPE",
"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>"
}
}
},
"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,
"hasMore": false,
"previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
"next": "",
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"ledger": "<string>"
}
]
}
}
},
"error": "<string>",
"terminated": true,
"startedAt": "2023-11-07T05:31:56Z",
"terminatedAt": "2023-11-07T05:31:56Z",
"lastFailure": "<string>",
"attempt": 123,
"nextExecution": "2023-11-07T05:31:56Z"
}
]
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Response
200
application/json
The workflow instance stage history
The response is of type object
.
Copy
Ask AI
curl --request GET \
--url http://localhost:55001/api/orchestration/v2/instances/{instanceID}/stages/{number}/history \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"data": [
{
"name": "<string>",
"input": {
"GetAccount": {
"id": "<string>",
"ledger": "<string>"
},
"AddAccountMetadata": {
"id": "<string>",
"ledger": "<string>",
"metadata": {}
},
"CreateTransaction": {
"ledger": "<string>",
"data": {
"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",
"metadata": {
"admin": "true"
}
}
},
"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>"
}
},
"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"
}
],
"reference": "ref:001",
"metadata": {
"admin": "true"
},
"txid": 1
}
]
},
"GetPayment": {
"data": {
"id": "XXX",
"reference": "<string>",
"sourceAccountID": "<string>",
"destinationAccountID": "<string>",
"connectorID": "<string>",
"provider": "STRIPE",
"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>"
}
}
},
"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,
"hasMore": false,
"previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
"next": "",
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"ledger": "<string>"
}
]
}
}
},
"error": "<string>",
"terminated": true,
"startedAt": "2023-11-07T05:31:56Z",
"terminatedAt": "2023-11-07T05:31:56Z",
"lastFailure": "<string>",
"attempt": 123,
"nextExecution": "2023-11-07T05:31:56Z"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.