Get an execution by ID

get

https://api.staging.payrails.io/merchant/workflows/{workflowCode}/executions/{executionId}

Get a workflow execution for the given ID.

Path Params

workflowCode

string

required

Path parameter to specify the workflow code.

executionId

uuid

required

Identifier of the resource in Payrails.

Query Params

waitWhile[status]

string

Request the server to wait until status no longer has the given value. The server might return a response earlier than that and the client must be prepared to re-issue the request in this case.

waitWhile[actionRequired]

string

Request the server to wait until actionRequired no longer has the given value. The server might return a response earlier than that and the client must be prepared to re-issue the request in this case.

waitWhile[lastStatusTime]

date-time

Request the server to wait until the execution has a new status added after statusTime. statusTime should be the latest status time of the execution at the moment of the call so that a new status would stop the wait. The server might return a response earlier than that and the client must be prepared to re-issue the request in this case.

Responses

Language

Credentials

Bearer

JWT

Response

Choose an example:

application/json

200OK.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

404Not Found.

429Too Many Requests.