Cmdlets for PayPal

Build 21.0.7930


Retrieve details about Payouts.

Table Specific Information


The only filter supported by the PayPal API is PayoutBatchId, which is required. The cmdlet processes other filters client side within the cmdlet.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following query is processed server side and retrieves details for a specific Payout.

SELECT * FROM PayoutDetails WHERE PayoutBatchId = 'HSY55UPD25KF2'


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.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930