The List Payout Transaction Events endpoint on
Payiano returns a detailed, chronological
history of all lifecycle events for a specific payout transaction.
Each event represents a distinct stage in the payout flow, from
initiation through final settlement or failure.
This endpoint is essential for:
Real-time monitoring: Track the current stage and progress of
any payout transaction with precise timing information
Debugging and diagnostics: Examine event details to
understand exactly why a payout failed or encountered issues
Audit and compliance: Maintain complete, timestamped records
of every action in the payout lifecycle, including specific details
for each event
Dashboard integration: Power user interfaces with detailed
transaction progress indicators and contextual event information
Simulation verification: After using the
simulation
endpoint, verify that events were processed correctly and inspect their
details
Webhook correlation: Match incoming webhook notifications with
specific events and their detailed data
Relationship with Transaction Status and Current Event
Understanding how transaction events relate to other transaction fields:
Complete timeline vs current event: While the
transaction'scurrent_event field shows only the latest event, this endpoint
provides the complete historical timeline of all events with their
full details
Status correlation: Transaction status updates to
success or failed only when the corresponding final event
(success or failed) is completed. The details field in
failed events contains specific error information
Event sequencing rules: Events follow a strict order:
initiating → validating → processing → settling
→ success/failed. This endpoint always returns events
in this chronological sequence
Common Use Cases
Customer support: Show users exactly where their payout is in
the process and provide specific details about any issues from the
details field
Operations monitoring: Create dashboards showing transaction
volumes at each stage of the payout lifecycle with detailed event data
Quality assurance: Measure processing times for each event
stage and analyze details to identify bottlenecks or common issues
Integration testing: After
simulating
events, verify that the event timeline matches expected behavior and
inspect the generated details
Dispute resolution: Provide detailed evidence from event
details of when each action occurred and what specific
information was processed
Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
Your access token should be associated to this permission payout.transactions.view
Request
Request body schema:
application/json
Path parameters:
transaction_id
required
transaction_id
required
Type: ulid
Length: 26
The unique ID assigned to each payout transaction which is generated
by our system using the ULID format. Each ID is
precisely 26 characters long, ensuring a unique and consistent
identifier for every payout transaction. This ULID is
automatically created by our system and is used to uniquely identify
and track each payout transaction in our database.
Query parameters:
page
page
Type: integer|null
Default: 1
The page number to be retrieved, for the list of payout transaction events.
So, a combination of page=1 and per_page=25 returns the
first 25 payout transaction events items. A combination of page=2 and
per_page=25 returns the next 25 payout transaction events items.
per_page
per_page
Type: integer|null
Default: 25
Possible values: [1 ... 200]
The maximum number of payout transaction events items to return in the response.
q
q
Type: string|null
Min: 3
This parameter enables free-text search across key payout transaction events fields
(including but not limited to name), requiring a minimum of
3 characters per search term. It performs case-insensitive partial
matching, and returns relevance-ranked results while automatically handling
special characters. This provides a simple yet powerful way to quickly find
relevant payout transaction events items. It could accept an array_of_strings as well.
sort
sort
Type: array_of_objects|null
Control the ordering of results with sophisticated multi-column sorting.
Specify an array of objects, each containing a field and direction.
Maximum 5 sort fields per request to maintain
optimal performance.
This attribute specifies the field used for sorting. It can be a direct
attribute of the resource or a related field referenced using dot notation.
direction
required
direction
required
Type: enum
Possible values:
["asc","desc"]
This attribute specifies the sorting direction. It can be either asc
for ascending order or desc for descending order. Please note that
the value is case-sensitive.
filters
filters
Type: object|null
Apply complex filtering conditions using nested logical groups and comparison
operators. Supports advanced querying with and/or logic, multiple
operators, and hierarchical conditions.
The filtering system supports unlimited nesting depth , allowing you to build sophisticated query logic. Each group can contain a mix of conditions and other groups. See Filtering Reference for complete documentation, operator list, and examples.
node
required
node
required
Type: enum
Possible values:
["group"]
Used exclusively as the root filter node.
Specifies the type of the root filter node. At the root level,
only a logical group node is supported. A group node acts as a container that
combines one or more filter conditions or nested groups using AND/OR logic.
Nested group and condition nodes may appear within this root group to build
complex filtering structures.
logic
required
logic
required
Type: enum
Possible values:
["and","or"]
This parameter is used exclusively on group nodes.
Defines how filters within a filter group are logically combined. This
parameter is used exclusively on group nodes and determines how the group
evaluates its child filters or nested groups:
• and — all contained conditions must match
• or — at least one contained condition must match
Logical groups can be nested to construct complex filtering expressions with
mixed AND/OR logic across multiple levels.
filters
required
filters
required
Type: array_of_objects
This parameter is used exclusively on group nodes.
Contains the filter nodes (conditions or groups) within this logical group.
Groups can be nested to create complex hierarchical filtering logic.
node
node
Type: enum
Possible values:
["group","condition"]
Specifies the type of filter node. A filter node can be either a logical
group or a condition:
• group — a logical grouping of multiple filters combined with AND/OR logic
• condition — a single filter condition specifying a field, operator, and value
Filter nodes can be nested to create complex filtering structures.
logic
logic
Type: enum
Possible values:
["and","or"]
This parameter is used exclusively on group nodes.
Defines how filters within a filter group are logically combined. This
parameter is used exclusively on group nodes and determines how the group
evaluates its child filters or nested groups:
• and — all contained conditions must match
• or — at least one contained condition must match
Logical groups can be nested to construct complex filtering expressions with
mixed AND/OR logic across multiple levels.
filters
filters
Type: array_of_objects
This parameter is used exclusively on group nodes.
Contains the filter nodes (conditions or groups) within this logical group.
Groups can be nested to create complex hierarchical filtering logic.
This parameter is used exclusively on condition nodes.
It specifies the field evaluated by the filter condition. The selected
field determines which operators are available and the expected format
of the comparison value based on its data type.
This parameter is used exclusively on condition nodes.
It specifies the comparison operator applied to the selected field. The set of
supported operators depends on the field and its data type, and only operators
that are valid for the chosen field can be used. Available operators for each
field are provided in the response and presented in the filter selection.
Refer to the Filtering Reference for
the complete operator list, expected value formats, and usage examples.
value
value
Type: mixed
This parameter is used exclusively on condition nodes.
The value used by the selected operator to evaluate the field. The expected
structure and data type of this parameter depend on both the field type and
the operator:
• Scalar operators (eq, not_eq, gt, gte, lt, lte,
starts_with, ends_with, contains, and their negations) expect a
single value matching the field type (for example, string or number).
• List operators (in, not_in) expect an array of values compatible
with the field type.
• Range operators (between, not_between) expect an array of exactly
two values representing the inclusive lower and upper bounds.
• Null-check operators (is_null, is_not_null) do not accept a value
and must be used without this parameter.
Supplying a value that does not match the operator or field type will result
in a validation error in strict mode.
See the Filtering Reference for
supported operators, applicable field types, and examples.
Specifies the output format of the datatable response, supporting both
JSON and export file types for easy integration and reporting.
Refer to Response Types for more details.
aggregations
aggregations
Type: object|null
Defines how to aggregate and group data when
response_type is set to json_aggregate. This parameter enables analytical
style responses suitable for dashboards and reports. Refer to Aggregations for more details.
fields
required
fields
required
Type: array_of_objects
Defines the fields to be aggregated along with their respective metrics.
Maximum 5 aggregation fields per
request to maintain optimal performance.
This attribute specifies the name of the field to be aggregated.
metrics
required
metrics
required
Type: array_of_enums
Possible values:
["avg","count","sum"]
Defines the aggregation metrics to apply to the selected field.
Note that the avg and sum metrics are applicable
only to numeric fields.
group_by
required
group_by
required
Type: array_of_objects|null
Specifies the dimensions used to group aggregated
data results. Each object defines a field by which records will be
grouped before applying aggregation metrics. Maximum
5 aggregation group by
fields per request to maintain optimal performance.
Grouping enables developers to analyze data trends across categories, dates,
or other meaningful dimensions.
If no group_by fields are provided, the system performs a global aggregation across the entire dataset. In such cases, the response includes a single summary group, typically referencing the latest created_at value.
Specifies the field name used for grouping results within the aggregation.
This determines how records are organized and segmented when computing metrics.
When grouping by a datetime or timestamp field such as completed_at , the system automatically groups by the date portion only , ignoring the time component. This enables daily-based aggregations instead of precise timestamp level grouping.
By default, grouping operations use the server's timezone ( UTC ). You can override this behavior by specifying the X-Preferred-Response-Timezone header in your request. Learn more about timezone handling in our Datetime & Timezone Reference .
Response
200
Response schema:
application/json
Response body:
total_pages
total_pages
Type: integer
The total number of pages that are available for the payout transaction events
search criteria.
current_page
current_page
Type: integer
The current pagination page.
per_page
per_page
Type: integer
The amount of payout transaction events items return per page.
total_items
total_items
Type: integer
The total number of payout transaction events that match the search criteria.
items
items
Type: array_of_objects
The list of payout transaction events that match the search criteria.
id
id
Type: ulid
Length: 26
The unique ID assigned to each payout transaction event which is generated
by our system using the ULID format. Each ID is
precisely 26 characters long, ensuring a unique and consistent
identifier for every payout transaction event. This ULID is
automatically created by our system and is used to uniquely identify
and track each payout transaction event in our database.
Identifies the type of lifecycle event recorded for the payout transaction.
Each event represents a specific step or state change that occurred during the
transaction’s processing.
transaction_id
transaction_id
Type: ulid
Length: 26
The unique ID assigned to each payout transaction which is generated
by our system using the ULID format. Each ID is
precisely 26 characters long, ensuring a unique and consistent
identifier for every payout transaction. This ULID is
automatically created by our system and is used to uniquely identify
and track each payout transaction in our database.
completed_at
completed_at
Type: datetime|null
The timestamp indicating when this payout transaction event was completed.
This value remains null until the event has finished processing.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.
started_at
started_at
Type: datetime
The timestamp indicating when this payout transaction event was started.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.
details
details
Type: object|null
An optional object with extra information about the payout transaction event.
It can contain only one key, and the key and its value depend on the
event type.
failed
failed
Type: object
An object providing details about the failure if the transaction event
represents a failed state. This object includes information such as
reason, error codes, messages, and any relevant data to help diagnose
the issue.
A code indicating the specific reason for the failure of the payout
transaction event. This helps in identifying the cause of the failure
for troubleshooting and resolution.
created_at
created_at
Type: datetime
The created datetime of the payout transaction event.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.
updated_at
updated_at
Type: datetime
The updated datetime of the payout transaction event.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.