Retrieve Transaction Event

The Retrieve Payout Transaction Event endpoint on Payiano returns the full details of a specific lifecycle event associated with a payout transaction. Each event represents a distinct stage in the payout process.

The response includes the event name (such as initiated, validating, funds_processing, receiver_settled, success, or failed), along with event metadata stored in the data field. This metadata may contain processor messages, validation results, reference codes, or additional payout network information.

The event also includes a completed_at timestamp that indicates when the lifecycle stage finished. This allows finance, operations, and engineering teams to reconstruct the full payout timeline with millisecond precision.

Use this endpoint to debug payout flows, review processor interactions, verify timing and state transitions, or build audit-ready transaction histories. It provides accurate, real-time visibility into how a payout is progressing at each stage.

GET/payout/transactions/{transaction_id}/events/{transaction_event_id}
Sandbox: https://api.payiano.dev/v1/payout/transactions/{transaction_id}/events/{transaction_event_id}
Live: https://api.payiano.com/v1/payout/transactions/{transaction_id}/events/{transaction_event_id}
Security
  • 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
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.

transaction_event_id
required
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.

Response
200
Response schema:
application/json
Response body:
transaction_event
Type: object

The payout transaction event model details.

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.

name
Type: enum
Possible values:
[ "initiated", "validating", "funds_processing", "receiver_settled", "failed", "success" ]

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.

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.

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
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.

Response sample:
1
{ 2
 "transaction_event": { 3 "id": "01ka22zz6a9s0rs3dffj1p5868", 4 "name": "validating", 5 "completed_at": null, 6 "created_at": "1763154328778", 7 "updated_at": "1763154328778" 8 } 9}