Skip to main content
GET
Search & list events

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Path Parameters

workflowCode
string
required

Path parameter to specify the workflow code. Machine-friendly code of Workflow.

Pattern: ^[a-z][-A-Za-z0-9]*$
executionId
string<uuid>
required

Identifier of the resource in Payrails.

Query Parameters

filter[event]
enum<string>

Filter for the type of event. Name of the event.

Available options:
executionCreated,
executionActionRequested,
executionActionCompleted,
ruleEngineExecuted,
networkOffersEnrollmentCompleted,
executionActionScheduled,
executionActionUnscheduled,
executionActionUpdated,
executionActionPending,
executionActionStepScheduled,
executionActionStepUnscheduled,
executionActionStepRequested,
executionActionStepStarted,
executionActionStepPaused,
executionActionStepResumed,
executionActionStepCompleted,
executionActionStepUpdated,
executionTriggerStepCalled,
executionConditionStepEvaluated
filter[action]
enum<string>

Filter for the type of action. Type of action.

Available options:
lookup,
startPaymentSession,
authorize,
capture,
confirm,
cancel,
refund
filter[actionId]
string<uuid>

Filter for the unique action execution identifier originally returned in the synchronous action response.

filter[notificationStatus]
enum<string>

Filter for the status of the associated notification event. Value of Notification event status enumeration.

Available options:
delivered,
deliveryFailed,
pending
filter[errorCode]
string

Filter for the type of error code produced for execution event.

Response

OK.

events
object[]
required
Last modified on October 7, 2026