PayoutDetails
Retrieve details about Payouts.
Table Specific Information
Select
The only filter supported by the PayPal API is PayoutBatchId, which is required. The add-in processes other filters client side within the add-in.
For example, the following query is processed server side and retrieves details for a specific Payout.
SELECT * FROM PayoutDetails WHERE PayoutBatchId = 'HSY55UPD25KF2'
Columns
| Name | Type | References | Description |
| PayoutBatchId [KEY] | String | The ID of the payout for which to show details. | |
| BatchStatus | String | The PayPal-generated payout status. If the payout passes preliminary checks, the status is PENDING. | |
| TimeCreated | Datetime | The date and time when processing for the payout began | |
| TimeCompleted | Datetime | The date and time when processing for the payout completed. | |
| SenderBatchId | String | The sender-specified ID number. Tracks the payout in an accounting system. | |
| SenderEmailSubject | String | The subject line for the email that PayPal sends when payment for a payout item completes. The subject line is the same for all recipients. | |
| Amount | Decimal | The total amount,requested for the payouts. | |
| Currency | String | The currency of the total amount | |
| FeeAmount | Decimal | The amount of the total estimate for the applicable payouts fees. Initially, the fee is 0. The fee is populated after the payout moves to the PROCESSING state. | |
| FeeCurrency | String | The currency for the applicable payouts fees. | |
| TimeClosed | Datetime | The date and time when the payout was closed, in Internet date and time format. | |
| SenderEmailMessage | String | The email message that PayPal sends when the payout item completes. The message is the same for all recipients. | |
| SenderEmailRecipientType | String | The ID type that identifies the payment receiver.
The allowed values are EMAIL, PHONE, PAYPAL_ID. | |
| FundingSource | String | The ID to differentiate a PayPal balance-funded transaction from a PayPal treasury-funded transaction. |