PayPal · Example Payload

Paypal Payoutspost Example

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Paypal Payoutspost Example is an example object payload from PayPal, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "payouts.post",
  "method": "POST",
  "path": "/v1/payments/payouts",
  "summary": "Paypal Create batch payout",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "create_payout_request",
      "example": {
        "sender_batch_header": {
          "sender_batch_id": "Payouts_2018_100007",
          "email_subject": "You have a payout!",
          "email_message": "You have received a payout! Thanks for using our service!"
        },
        "items": [
          {
            "recipient_type": "EMAIL",
            "amount": {
              "value": "9.87",
              "currency": "USD"
            },
            "note": "Thanks for your patronage!",
            "sender_item_id": "201403140001",
            "receiver": "receiver@example.com",
            "alternate_notification_method": {
              "phone": {
                "country_code": "91",
                "national_number": "9999988888"
              }
            },
            "notification_language": "fr-FR"
          },
          {
            "recipient_type": "PHONE",
            "amount": {
              "value": "112.34",
              "currency": "USD"
            },
            "note": "Thanks for your support!",
            "sender_item_id": "201403140002",
            "receiver": "91-734-234-1234"
          },
          {
            "recipient_type": "PAYPAL_ID",
            "amount": {
              "value": "5.32",
              "currency": "USD"
            },
            "note": "Thanks for your patronage!",
            "sender_item_id": "201403140003",
            "receiver": "G83JXTJ5EHCQ2"
          }
        ]
      }
    }
  ],
  "responseExamples": []
}