Get a list of transactions included in payout by ID

Learn how to get a list of transactions included in the payout by identifier.

Retrieving a list of transactions associated with a specific payout allows you to gain insights into the financial details and movements involved in that payout. You can obtain comprehensive transaction details using the unique payout ID, helping you track and manage financial operations efficiently.

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.

Get payout by ID, including transactions example

Accessing payout information, including details of related payout transactions, is crucial for any financial management system. This section provides examples of requesting these details using a payout ID and includes a sample response to illustrate the data type returned by the API. Developers can effectively integrate this functionality into their applications by understanding the structure and content of the request and the response.

To retrieve a list of transactions for a payout, you must supply the unique identifier of the payout:

Request header example

GET /payouts/8100000400_1410_2019/transactions

A 200 OK response returns an array of Payout Transaction objects.

Payout Transaction object example

{
  "hasMore": true,
  "data": [
    {
      "id": "8100000400_1410_2019",
      "createdTime": "2018-04-25T20:36:00Z",
      "currency": "USD",
      "amount": 1180.26,
      "payoutId": "2000028600_1410_2019",
      "description": "Sales for Period Ended 04-25-2020",
      "type": "sales_summary",
      "liveMode": true
    }
  ]
}

Key payout transaction attributes

The following information details 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 when the payout transaction was created in the reporting environment.

currency

The three-letter ISO currency code represents the currency type used in the payout transaction.

amount

Represents the payout transaction amount.

payoutId

The unique payout identifier.

salesSummaryId

A unique identifier for the sales summary that includes the payout transactions.

description

A text description of the payout transaction.

type

Designate the type of payout transaction. Supported types are sale, return, refund, fraud_chargeback, and non_fraud_chargeback.