Get a list of transactions included in payout by ID
Learn how to get a list of transactions included in the payout by identifier.
Setting payout path parameters
The following table lists the required parameters you can provide in a get payout by ID request.
Parameter | Required/Optional | Description |
---|---|---|
id | Required | Unique payout identifier. |
Example get request and response
To retrieve a list of transactions for a payout, you must supply the unique identifier of the payout:
A 200 OK
response returns an array of Payout Transaction objects.
Key payout transaction attributes
The following information provides details on the key attributes returned in response to a request for payout transaction information. For a complete list, refer to the Payouts API reference.
id
A unique identifier for the payout transaction.
createdTime
The time at which the payout transaction was created in the reporting environment.
currency
The three-letter ISO currency code representing the type of currency used in the payout transaction.
amount
Represents the payout transaction amount.
payoutId
The unique payout identifier.
salesSummaryId
A unique identifier for the sales summary containing the payout transactions.
description
A text description of the payout transaction.
type
Designates the type of payout transaction. Supported types are sale
, return
, refund
, fraud_chargeback
, and non_fraud_chargeback
.
Last updated