> ## Documentation Index > Fetch the complete documentation index at: https://docs.paypal.ai/llms.txt > Use this file to discover all available pages before exploring further. # Show payout batch details > Shows the latest status of a batch payout. Includes the transaction status and other data for individual payout items. ## OpenAPI ````yaml /api-reference/payments_payouts_batch_v1.json get /v1/payments/payouts/{id} openapi: 3.0.3 info: title: Payouts description: >- Use the Payouts API to make payments to multiple PayPal or Venmo recipients. The Payouts API is a fast, convenient way to send commissions, rebates, rewards, and general disbursements. You can send up to 15,000 payments per call. If you integrated the Payouts API before September 1, 2017, you receive transaction reports through Payouts Reporting. The Payouts API uses the ISO 8601 Internet date and time format. version: '1.9' contact: {} servers: - url: https://api-m.sandbox.paypal.com description: PayPal Sandbox Environment - url: https://api-m.paypal.com description: PayPal Live Environment security: [] tags: - name: payouts description: >- Use the `/payouts` resource to create a batch payout, update the status for a batch payout, show the status of a batch payout with the transaction status and other data for individual payout items, and request approval for a batch payout. - name: payouts-item description: >- Use the `/payouts-item` resource to show payout item details and cancel an unclaimed payout item. - name: payouts-statistics description: >- Use the `/payouts-statistics` resource to show statistics for a batch payout by date range. - name: payouts-disbursement-notifications description: >- Use the `payouts/disbursement-notifications` resource for status updates from VENMO - name: payout-application-status description: >- Use the `/payout-applications` resource to fetch and update payout status of the application. externalDocs: url: https://developer.paypal.com/docs/api/payments.payouts-batch/v1/ paths: /v1/payments/payouts/{id}: get: tags: - payouts summary: Show payout batch details description: >- Shows the latest status of a batch payout. Includes the transaction status and other data for individual payout items. operationId: payouts.get parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page_size' - $ref: '#/components/parameters/total_required' responses: '200': description: >- A successful request returns the HTTP `200 OK` status code and a JSON response body that shows batch payout details. content: application/json: schema: $ref: '#/components/schemas/payout_batch' '404': description: Resource Not Found. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: An internal server error has occurred. content: application/json: schema: $ref: '#/components/schemas/error' default: description: The error response. content: application/json: schema: $ref: '#/components/schemas/error' security: - Oauth2: - https://uri.paypal.com/payments/payouts components: parameters: id: name: id in: path description: The ID of the payout for which to show details. required: true schema: type: string minLength: 1 maxLength: 1000 pattern: ^.*$ fields: name: fields in: query description: Shows details for only the specified fields. required: false schema: type: string minLength: 1 maxLength: 1000 pattern: ^.*$ page: name: page in: query description: A non-zero integer representing the page of the results. required: false schema: type: integer minimum: 0 maximum: 1000 default: 1 page_size: name: page_size in: query description: >- 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`. required: false schema: type: integer minimum: 0 maximum: 1000 total_required: name: total_required in: query description: >- Indicates whether to show the total items and total pages count in the response. schema: type: boolean default: false schemas: payout_batch: type: object title: Payout Batch description: The PayPal-generated batch status. properties: total_items: description: The total number of items in the full result list. type: integer minimum: 0 maximum: 15000 total_pages: description: The total number of pages. type: integer minimum: 0 maximum: 1000 batch_header: $ref: '#/components/schemas/payout_batch_header' description: A payout header. Includes the generated payout status. items: $ref: '#/components/schemas/payout_batch_items_list' links: $ref: '#/components/schemas/payout_batch_definitions-link_description_list' error: type: object title: Error description: The error details. properties: name: type: string description: The human-readable, unique name of the error. message: type: string description: The message that describes the error. debug_id: type: string description: The PayPal internal ID. Used for correlation purposes. information_link: type: string description: >- The information link, or URI, that shows detailed information about this error for the developer. readOnly: true details: $ref: '#/components/schemas/error_details_list' links: $ref: '#/components/schemas/link_description_list' required: - name - message - debug_id payout_batch_header: type: object title: Payout Batch Header description: >- The payout header that is returned in response to a payout header request. Shows details for an entire payout request. properties: payout_batch_id: type: string description: The PayPal-generated ID for a payout. minLength: 0 maxLength: 30 pattern: ^.*$ batch_status: $ref: '#/components/schemas/batch_enum' description: >- The PayPal-generated payout status. If the payout passes preliminary checks, the status is `PENDING`. time_created: type: string format: date-time minLength: 0 maxLength: 100 description: >- The date and time when processing for the payout began, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). time_completed: type: string format: date-time description: >- The date and time when processing for the payout was completed, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). minLength: 0 maxLength: 100 time_closed: type: string format: date-time description: >- The date and time when the payout was closed, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). A payout is considered closed when all items in a batch are processed and the available balance from the temporary hold is released. minLength: 0 maxLength: 100 sender_batch_header: $ref: '#/components/schemas/payout_sender_batch_header' description: The original payout header, as provided by the payment sender. funding_source: $ref: '#/components/schemas/funding_source' description: >- The ID to differentiate a PayPal balance-funded transaction from a PayPal treasury-funded transaction. amount: $ref: '#/components/schemas/currency' description: The currency and total amount requested for the payouts. fees: $ref: '#/components/schemas/currency' description: >- 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. required: - payout_batch_id - batch_status - sender_batch_header payout_batch_items_list: type: array description: An array of individual items. items: $ref: '#/components/schemas/payout_batch_items' minItems: 0 maxItems: 15000 payout_batch_definitions-link_description_list: type: array description: >- An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links). readOnly: true items: $ref: '#/components/schemas/link_description' minItems: 0 maxItems: 15000 error_details_list: type: array description: An array of additional details about the error. items: $ref: '#/components/schemas/error_details-2' link_description_list: type: array description: >- An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). readOnly: true items: $ref: '#/components/schemas/link_description' batch_enum: title: Batch status description: The payouts status. type: string x-enumDescriptions: - value: DENIED description: >- Your payout requests were denied, so they were not processed. Check the error messages to see any steps necessary to fix these issues. - value: PENDING description: Your payout requests were received and will be processed soon. - value: PROCESSING description: Your payout requests were received and are now being processed. - value: SUCCESS description: >- Your payout batch was processed and completed. Check the status of each item for any holds or unclaimed transactions. - value: CANCELED description: >- The payouts file that was uploaded through the PayPal portal was cancelled by the sender. minLength: 1 maxLength: 36 pattern: ^[0-9A-Z_]+$ enum: - DENIED - PENDING - PROCESSING - SUCCESS - CANCELED payout_sender_batch_header: type: object title: Payout Sender Batch Header description: The sender-provided header for a payout request. properties: sender_batch_id: type: string description: >- 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.

minLength: 0 maxLength: 256 pattern: ^.*$ recipient_type: $ref: '#/components/schemas/recipient_enum' email_subject: type: string description: >- 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. minLength: 0 maxLength: 255 pattern: ^.*$ email_message: type: string description: >- The email message that PayPal sends when the payout item completes. The message is the same for all recipients. minLength: 0 maxLength: 1000 pattern: ^.*$ funding_source: title: Funding source description: Identifies a funding source type. type: string x-enumDescriptions: - value: BALANCE description: Funded by balance. minLength: 1 maxLength: 36 pattern: ^[0-9A-Z_]+$ enum: - BALANCE currency: type: object title: Currency description: >- The currency and amount for a financial transaction, such as a balance or payment due. properties: currency: type: string description: >- The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/). value: type: string description: >- The value, which might be:For the required number of decimal places for a currency code, see [Currency codes - ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). required: - currency - value payout_batch_items: type: object title: Payout Item description: The payout item status and other details. properties: payout_item_id: type: string description: >- The ID for the payout item. Viewable when you show details for a payout. minLength: 0 maxLength: 30 pattern: ^.*$ transaction_id: type: string description: The PayPal-generated ID for the transaction. minLength: 0 maxLength: 30 pattern: ^.*$ activity_id: type: string description: >- The unique PayPal-generated common ID created to link sender side and receiver side transaction. Used for tracking. minLength: 0 maxLength: 30 pattern: ^.*$ transaction_status: $ref: '#/components/schemas/transaction_enum' payout_item_fee: $ref: '#/components/schemas/currency' description: The fee, in U.S. dollars. payout_batch_id: type: string description: The PayPal-generated ID for the payout. minLength: 0 maxLength: 30 pattern: ^.*$ payout_item: $ref: '#/components/schemas/payout_item_detail' description: The sender-provided information for the payout item. currency_conversion: $ref: '#/components/schemas/payout_currency_conversion' description: The currency conversion applicable for this payout item. time_processed: type: string format: date-time minLength: 0 maxLength: 100 description: >- The date and time when this item was last processed, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). errors: $ref: '#/components/schemas/error' links: $ref: >- #/components/schemas/payout_batch_items_definitions-link_description_list required: - payout_item_id - payout_batch_id - payout_item link_description: type: object title: Link Description description: >- The request-related [HATEOAS link](/docs/api/reference/api-responses/#hateoas-links) information. required: - href - rel properties: href: type: string description: >- The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call. rel: type: string description: >- The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml). method: type: string description: The HTTP method required to make the related call. enum: - GET - POST - PUT - DELETE - HEAD - CONNECT - OPTIONS - PATCH error_details-2: title: Error Details type: object description: The error details. Required for client-side `4XX` errors. properties: field: type: string description: >- The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors. value: type: string description: The value of the field that caused the error. location: type: string description: >- The location of the field that caused the error. Value is `body`, `path`, or `query`. default: body issue: type: string description: The unique, fine-grained application-level error code. description: type: string description: >- The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value. required: - issue recipient_enum: title: Recipient type description: The ID type that identifies the payment receiver. type: string x-enumDescriptions: - value: EMAIL description: >- An unencrypted email. Value is a string of up to 127 single-byte characters. - value: PHONE description: An unencrypted phone number. - value: PAYPAL_ID description: An encrypted PayPal account number. minLength: 1 maxLength: 36 pattern: ^[0-9A-Z_]+$ enum: - EMAIL - PHONE - PAYPAL_ID transaction_enum: title: Transaction status description: >- The item transaction status.
Note: For POST/v1/payments/payouts-item/{payout_item_id}/cancel, the only possible transaction_status value is RETURNED.
type: string x-enumDescriptions: - value: SUCCESS description: Funds have been credited to the recipient’s account. - value: FAILED description: >- This payout request has failed, so funds were not deducted from the sender’s account. - value: PENDING description: >- Payout request has been submitted and is being processed. Recipient will get the funds once the request is processed successfully, else the funds will be returned to you. - value: UNCLAIMED description: >- The recipient for this payout does not have a PayPal account. A link to sign up for a PayPal account was sent to the recipient. However, if the recipient does not claim this payout within 30 days, the funds are returned to your account. - value: RETURNED description: >- Funds have been returned to your account. This can be because the recipient has not claimed this payout, or you have cancelled the payout. - value: ONHOLD description: This payout request is being reviewed and is on hold. - value: BLOCKED description: This payout request has been blocked. - value: REFUNDED description: >- Funds have been refunded back to your account. This is because the recipient(PayPal Business verified account) has issued a refund for the payout initiated by you. - value: REVERSED description: >- This payout request was reversed. This status is specific to web uploads. minLength: 1 maxLength: 36 pattern: ^[0-9A-Z_]+$ enum: - SUCCESS - FAILED - PENDING - UNCLAIMED - RETURNED - ONHOLD - BLOCKED - REFUNDED - REVERSED payout_item_detail: type: object title: Payout Item Detail description: The details for a sender-created payout to a single recipient. properties: recipient_type: $ref: '#/components/schemas/recipient_enum' amount: $ref: '#/components/schemas/currency' description: >- The currency and amount of payout item. Might be an integer for currencies like `JPY` that are not typically fractional or 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](https://www.iso.org/iso-4217-currency-codes.html). note: type: string description: >- The sender-specified note for notifications. Supports up to 4000 ASCII characters and 1000 non-ASCII characters. minLength: 0 maxLength: 4000 pattern: ^.*$ receiver: type: string description: >- The receiver of the payment. Corresponds to the `recipient_type` value in the request. minLength: 0 maxLength: 127 pattern: ^.*$ sender_item_id: type: string description: >- A sender-specified ID number. Tracks the payout in an accounting system. minLength: 0 maxLength: 63 pattern: ^.*$ recipient_name: $ref: '#/components/schemas/name' description: >- The name of the recipient where money is credited. For `UNCLAIMED` payments, the recipient name is populated after the payment is claimed. recipient_wallet: $ref: '#/components/schemas/recipient_wallet_enum' description: The recipient wallet. purpose: $ref: '#/components/schemas/purpose_enum' description: The purpose of the transaction. required: - amount - receiver payout_currency_conversion: type: object title: Currency conversion resource description: The currency conversion resource. properties: from_amount: $ref: '#/components/schemas/currency' description: The amount that is converted from. to_amount: $ref: '#/components/schemas/currency' description: The amount that is converted to. exchange_rate: type: string description: The exchange rate that is applied for this payout. pattern: ^.*$ minLength: 0 maxLength: 30 payout_batch_items_definitions-link_description_list: type: array description: >- An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links). readOnly: true items: $ref: '#/components/schemas/link_description' minItems: 0 maxItems: 15000 name: type: object title: Name description: The name of the party. properties: prefix: type: string description: The prefix, or title, to the party's name. maxLength: 140 given_name: type: string description: When the party is a person, the party's given, or first, name. maxLength: 140 surname: type: string description: >- When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname. maxLength: 140 middle_name: type: string description: >- When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name. maxLength: 140 suffix: type: string description: The suffix for the party's name. maxLength: 140 alternate_full_name: type: string description: >- DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business. maxLength: 300 full_name: type: string description: When the party is a person, the party's full name. maxLength: 300 recipient_wallet_enum: title: Recipient wallet description: >- The wallet where the recipient receives the payout. Payouts to Venmo recipients require a 'note' string and a US mobile phone number. type: string x-enumDescriptions: - value: PAYPAL description: PayPal Wallet. - value: VENMO description: Venmo Wallet. default: PAYPAL minLength: 1 maxLength: 36 pattern: ^[0-9A-Z_]+$ enum: - PAYPAL - VENMO purpose_enum: type: string title: Purpose description: The purpose of the transaction. minLength: 1 maxLength: 40 pattern: ^[A-Z0-9_]+$ x-enumDescriptions: - value: AWARDS description: Awards payouts. - value: PRIZES description: Prizes payouts. - value: DONATIONS description: Donation payouts. - value: GOODS description: Payouts for goods sold. - value: SERVICES description: Payouts for services provided. - value: REBATES description: Rebate payouts. - value: CASHBACK description: Cashback payouts. - value: DISCOUNTS description: Discount payouts. - value: NON_GOODS_OR_SERVICES description: Payouts for any non-goods or services. enum: - AWARDS - PRIZES - DONATIONS - GOODS - SERVICES - REBATES - CASHBACK - DISCOUNTS - NON_GOODS_OR_SERVICES securitySchemes: Oauth2: type: oauth2 description: Oauth 2.0 authentication flows: clientCredentials: tokenUrl: /v1/oauth2/token scopes: https://uri.paypal.com/payments/payouts: Payout to a list of recipients. https://uri.paypal.com/services/payments/payouts-item/reverse: For reversing a completed payout item. https://uri.paypal.com/services/payments/payout-applications/status: For retrieving payouts application status https://uri.paypal.com/services/payments/payout-applications/update-status: For updating payouts application status ````