PayoutItems
Retrieve payout items from a Payout.
Table Specific Information
Select
The filters supported by the PayPal API are PayoutBatchId and PayoutItemId. Atleast one filter is required to access the view. The add-in processes other filters client side within the add-in.
For example, the following queries are processed server side.
SELECT * FROM PayoutItems WHERE PayoutBatchId = 'HSY55UPD25KF2' SELECT * FROM PayoutItems WHERE PayoutItemId ='8AELMXH8UB2P8'
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. | |
| ErrorsName | String | The human-readable, unique name of the error, if any. | |
| ErrorsDebugId | String | The PayPal internal ID. Used for correlation purposes. | |
| ErrorsInformationLink | String | The information link, or URI, that shows detailed information about this error for the developer. | |
| ActivityId | String | The unique PayPal-generated common ID that links the sender- and receiver-side transactions. Used for tracking. | |
| SenderBatchId | String | A sender-specified ID. Tracks the payout in an accounting system. | |
| RecipientNamePrefix | String | The prefix, or title, to the party's name. | |
| RecipientGivenName | String | When the party is a person, the party's given, or first, name. | |
| RecipientSurname | String | When the party is a person, the party's surname or family name. Also known as the last name. | |
| RecipientMiddleName | String | When the party is a person, the party's middle name. | |
| RecipientFullName | String | When the party is a person, the party's full name. | |
| RecipientWallet | String | The recipient wallet.
The allowed values are PAYPAL, VENMO. | |
| Purpose | String | The purpose of the transaction.
The allowed values are AWARDS, PRIZES, DONATIONS, GOODS, SERVICES, REBATES, CASHBACK, DISCOUNTS, NON_GOODS_OR_SERVICES. |