PayoutItems
Retrieve payout items from a Payout.
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 all payout items for a specific Payout.
SELECT * FROM PayoutItems WHERE PayoutBatchId = 'HSY55UPD25KF2'
Columns
Name | Type | References | Description |
PayoutBatchId [KEY] | String | The ID of the payout for which to show payout items details. | |
PayoutItemId [KEY] | String | The ID for the payout item | |
TransactionId | String | The PayPal-generated ID for the transaction. | |
TransactionStatus | String | The transaction status. | |
FeeAmount | Decimal | The amount for the applicable payout fee. Initially, the fee is 0. The fee is populated after the item moves to the PENDING state | |
FeeCurrency | String | The currency for the applicable payout fee | |
RecipientType | String | The recipient type.Value is: EMAIL, PHONE, PAYPAL_ID. | |
AmountValue | Decimal | The amount of payout item. | |
AmountCurrency | String | The currency of payout item. | |
Note | String | A sender-specified note for notifications. | |
Receiver | String | The receiver of the payment. Corresponds to the recipient_type value in the request. | |
SenderItemId | String | A sender-specified ID number. Tracks the payout in an accounting system. | |
TimeProcessed | Datetime | The date and time when this item was last processed. | |
ErrorsMessage | String | The message that describes the error, if any. |