Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
Actions

Get an action by ID

Get a workflow action for the given ID.

get/merchant/actions/{actionId}

Path parameters

actionIdstring uuid required

Identifier of the resource in Payrails.

Query parameters

includeEventsboolean

Include events in the response.

Response

OK.

idstring uuid

Unique identifier of the Action.

workflowExecutionIdstring required

Unique identifier of the Workflow Execution that this action belongs to.

workflowCodestring required

Workflow code.

workspaceIdstring uuid required

Unique identifier of the Workspace that this action belongs to.

type'authorize' | 'capture' | 'cancel' | 'confirm' | 'crateInstrument' | 'fraudScore' | 'fraudUpdate' | 'lookup' | 'payout' | 'refund' | 'startPaymentSession' required

Value of Action Types enumeration.

status'created' | 'failed' | 'success' required

Value of Action Status enumeration.

createdAtstring date-time

Date of creation of the Action.

updatedAtstring date-time

Last update of the Action.

errorCodestring

Error code of last failed execution event.