PayPal

Payouts

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,…

Payments#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 4

payouts

  • POSTCreate batch payout/v1/payments/payoutsCreates a batch payout. In the JSON request body, pass a sender_batch_header and an items array. The sender_batch_header defines how to handle the payout. The…
  • GETShow payout batch details/v1/payments/payouts/:id?fields=string&page=1&page_size=0&total_required=falseShows the latest status of a batch payout. Includes the transaction status and other data for individual payout items.

payouts-item

  • GETShow payout item details/v1/payments/payouts-item/:payout_item_idShows details for a payout item, by ID. A <code>payout_item_id</code> helps you identify denied payments. If a payment is denied, you can use the…
  • POSTCancel unclaimed payout item/v1/payments/payouts-item/:payout_item_id/cancelCancels an unclaimed payout item, by ID. If no one claims the unclaimed item within 30 days, the API automatically returns the funds to the sender. Use this…

API details

Base URL
https://api-m.sandbox.paypal.com
https://api-m.paypal.com
Authentication
OAuth 2.0 (client credentials flow) with 4 scopes
Operations
4 operations on 4 pathsGET 2POST 2
Main resources
payouts 2payouts-item 2
Response formats
application/json
Description format
OpenAPI 3.0.3, API version 1.9

How to test the Payouts in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Payouts collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (client credentials flow) with 4 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create batch payout” (POST /v1/payments/payouts), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Payouts?

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,… It is listed under Payments and has 4 endpoints.

Who publishes the Payouts?

It is listed from PayPal's public API description (an OpenAPI document), not published by PayPal on Swastik Codes. Anyone who controls paypal.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Payouts?

Its description lists 2 base URLs: https://api-m.sandbox.paypal.com, https://api-m.paypal.com. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Payouts?

With OAuth 2.0 (client credentials flow) with 4 scopes.

How many endpoints does the Payouts have?

4 operations on 4 paths (2 GET, 2 POST). The largest groups are payouts, payouts-item.

Is forking the Payouts free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.