Instant Payouts

You can use the Orders API to instantly pay out orders to your sellers.

Integration steps

  1. Before you can integrate a PayPal product or solution, you must set up your development environment to get OAuth 2.0 client ID and secret credentials for the sandbox and live environments. You exchange these credentials for an access token that authorizes your REST API calls. To test your web and mobile apps, you create sandbox accounts.

    See Get Started.
  2. Pay an order.

Pay an order

In addition to the standard Accept, Content-Type, PayPal-Request-Id, and Authorization headers, include the PayPal-Client-Metadata-Id and PayPal-Partner-Attribution-Id headers.

In the URL, specify the order ID returned in the create order call.

In the JSON request body, set the disbursement_mode parameter to INSTANT.

Request sample

This sample shows a single-seller cart with an instant payout.

curl -v https://api.sandbox.paypal.com/v1/checkout/orders/5O190127TN364715T/pay \
  -X POST \
  -H "PayPal-Client-Metadata-Id: 1495725899514oren" \
  -H "PayPal-Request-Id: 9c5e3668-cb92-4a40-99b7-c74cb68913f4" \
  -H "PayPal-Partner-Attribution-Id: Example_Marketplace" \
  -H "Authorization: Bearer <var>Access-Token</var>" \
  -H "Content-Type: application/json" \
  -d ‘{
  "disbursement_mode": "INSTANT"
}’

Response sample

A successful request returns the HTTP 202 Accepted status code and a JSON response body that shows order and payment details.

{
  "order_id": "5O190127TN364715T",
  "status": "APPROVED",
  "payer_info": {
    "email": "test_payer@example.com",
    "first_name": "Jake",
    "last_name": "Doe",
    "payer_id": "9WVBNYPKKNBJS",
    "phone": "4087811648",
    "country_code": "US",
    "shipping_address": {
      "recipient_name": "John Doe",
      "default_address": false,
      "preferred_address": false,
      "primary_address": false,
      "disable_for_transaction": false,
      "line1": "2211 N First Street",
      "line2": "Building 17",
      "city": "San Jose",
      "country_code": "US",
      "postal_code": "95131",
      "state": "CA"
    }
  },
  "create_time": "2017-04-26T21:21:50Z",
  "update_time": "2017-04-26T21:21:50Z",
  "links": [
  {
    "href": "https://api.paypal.com/v1/checkout/orders/8RU61172JS455403V",
    "rel": "self",
    "method": "GET"
  }]
}
Feedback