You should login first to your account to test the APIs with.

Retrieve Transaction Event

The Retrieve Payout Transaction Event endpoint on Payiano returns the complete details of a single lifecycle event for a payout transaction. Use this endpoint when you need to examine a specific event in detail.

This endpoint is particularly useful for:

  • Detailed failure analysis: When a payout fails, retrieve the specific failed event to examine the reason in detail.
  • Webhook verification: When receiving a webhook notification, retrieve the exact event to verify its details and details
  • Specific event inspection: Focus on a single event without loading the complete transaction timeline
  • Direct event linking: When you have a specific event ID from another source (webhooks, logs, etc.), retrieve just that event

For a complete view of all events in chronological order, use the List Transaction Events endpoint instead.

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:
[ "initiating", "validating", "processing", "settling", "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.

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

reason
Type: enum
Possible values:
[ "invalid_bank_code", "invalid_currency_code", "rejected_by_beneficiary", "regulatory_reason", "closed_account", "frozen_or_blocked_account", "invalid_account_details", "insufficient_fund", "customer_deceased", "unknown" ]

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
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 "transaction_id": "01kaygedpfd02dm9cny5ds6ppe", 6 "completed_at": null, 7 "started_at": "1763154328752", 8 "details": null, 9 "created_at": "1763154328778", 10 "updated_at": "1763154328778" 11 } 12}