Skip to main content

Show payout batch details

GET 
/payouts/:id

Shows the latest status of a batch payout. Includes the transaction status and other data for individual payout items.

Request​

Path Parameters

    id stringrequired

    Possible values: non-empty and <= 1000 characters, Value must match regular expression ^.*$

    The ID of the payout for which to show details.

Query Parameters

    fields string

    Possible values: non-empty and <= 1000 characters, Value must match regular expression ^.*$

    Shows details for only the specified fields.

    page integer

    Possible values: <= 1000

    A non-zero integer representing the page of the results.

    Default value: 1
    page_size integer

    Possible values: <= 1000

    The maximum number of results to return at one time. Value is a non-negative, non-zero integer. If the user chooses pagination, the maximum page is 1000.

    total_required boolean

    Indicates whether to show the total items and total pages count in the response.

    Default value: false

Responses​

A successful request returns the HTTP 200 OK status code and a JSON response body that shows batch payout details.

Schema

    total_items integer

    The total number of items in the full result list.

    Possible values: <= 15000

    total_pages integer

    The total number of pages.

    Possible values: <= 1000

    items object[]

    An array of individual items.

    Possible values: <= 15000

    links object[]

    An array of request-related HATEOAS links.

    Possible values: <= 15000

    batch_header

    object

    A payout header. Includes the generated payout status.

    payout_batch_id stringrequired

    The PayPal-generated ID for a payout.

    Possible values: <= 30 characters, Value must match regular expression ^.*$

    time_created date-time

    The date and time when processing for the payout began, in Internet date and time format.

    Possible values: <= 100 characters

    time_completed date-time

    The date and time when processing for the payout was completed, in Internet date and time format.

    Possible values: <= 100 characters

    time_closed date-time

    The date and time when the payout was closed, in Internet date and time format. A payout is considered closed when all items in a batch are processed and the available balance from the temporary hold is released.

    Possible values: <= 100 characters

    batch_status Batch status (string)required

    The PayPal-generated payout status. If the payout passes preliminary checks, the status is PENDING.

    Possible values: non-empty and <= 36 characters, Value must match regular expression ^[0-9A-Z_]+$, [DENIED, PENDING, PROCESSING, SUCCESS, CANCELED]

    sender_batch_header

    object

    required

    The original payout header, as provided by the payment sender.

    sender_batch_id string

    The sender-specified ID number. Tracks the payout in an accounting system.

    Note:

    PayPal does not process duplicate payouts. If you specify a sender_batch_id that was used in the last 30 days, the API rejects the request with an error message that shows the duplicate sender_batch_id and includes a HATEOAS link to the original payout with the same sender_batch_id.

    If you receive an HTTP 5nn status code, you can safely retry the request with the same sender_batch_id. The API completes a payment only once for a sender_batch_id that is used within 30 days.

    Possible values: <= 256 characters, Value must match regular expression ^.*$

    email_subject 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. Value is an alphanumeric string with a maximum length of 255 single-byte characters.

    Possible values: <= 255 characters, Value must match regular expression ^.*$

    email_message string

    The email message that PayPal sends when the payout item completes. The message is the same for all recipients.

    Possible values: <= 1000 characters, Value must match regular expression ^.*$

    recipient_type Recipient type (string)

    The ID type that identifies the payment receiver.

    Possible values: non-empty and <= 36 characters, Value must match regular expression ^[0-9A-Z_]+$, [EMAIL, PHONE, PAYPAL_ID]

    funding_source Funding source (string)

    The ID to differentiate a PayPal balance-funded transaction from a PayPal treasury-funded transaction.

    Possible values: non-empty and <= 36 characters, Value must match regular expression ^[0-9A-Z_]+$, [BALANCE]

    amount

    object

    The currency and total amount requested for the payouts.

    currency stringrequired
    value stringrequired

    The value, which might be:

    • An integer for currencies like JPY that are not typically fractional.
    • A decimal fraction for currencies like TND that are subdivided into thousandths.
    For the required number of decimal places for a currency code, see Currency codes - ISO 4217.

    fees

    object

    The currency and 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.

    currency stringrequired
    value stringrequired

    The value, which might be:

    • An integer for currencies like JPY that are not typically fractional.
    • A decimal fraction for currencies like TND that are subdivided into thousandths.
    For the required number of decimal places for a currency code, see Currency codes - ISO 4217.

Loading...