Create batch payout - Paypal API

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

Header 参数

Content-Type

string

必需

The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json.

示例值:

application/json

PayPal-Request-Id

string

必需

The server stores keys for 30 days.

示例值:

Body 参数application/json

sender_batch_header

object

必需

sender_batch_id

string

必需

email_subject

string

必需

email_message

string

必需

items

array [object {6}]

必需

recipient_type

string

必需

amount

object

必需

note

string

必需

sender_item_id

string

必需

receiver

string

必需

notification_language

string

可选

示例

{
    "sender_batch_header": {
        "sender_batch_id": "Payouts_{{$timestamp}}",
        "email_subject": "You have a payout!",
        "email_message": "You have received a payout! Thanks for using our service!"
    },
    "items": [
        {
            "recipient_type": "EMAIL",
            "amount": {
                "value": "10.00",
                "currency": "USD"
            },
            "note": "Thanks for your patronage!",
            "sender_item_id": "201403140001",
            "receiver": "{{$randomEmail}}",
            "notification_language": "en-US"
        },
        {
            "recipient_type": "PHONE",
            "amount": {
                "value": "20.00",
                "currency": "USD"
            },
            "note": "Thanks for your support!",
            "sender_item_id": "201403140002",
            "receiver": "1-{{$randomPhoneNumber}}"
        },
        {
            "recipient_type": "PAYPAL_ID",
            "amount": {
                "value": "30.00",
                "currency": "USD"
            },
            "note": "Thanks for your patronage!",
            "sender_item_id": "201403140003",
            "receiver": "5DEJUG27PZB9J"
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api-m.sandbox.paypal.com/v1/payments/payouts' \
--header 'PayPal-Request-Id: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "sender_batch_header": {
        "sender_batch_id": "Payouts_{{$timestamp}}",
        "email_subject": "You have a payout!",
        "email_message": "You have received a payout! Thanks for using our service!"
    },
    "items": [
        {
            "recipient_type": "EMAIL",
            "amount": {
                "value": "10.00",
                "currency": "USD"
            },
            "note": "Thanks for your patronage!",
            "sender_item_id": "201403140001",
            "receiver": "{{$randomEmail}}",
            "notification_language": "en-US"
        },
        {
            "recipient_type": "PHONE",
            "amount": {
                "value": "20.00",
                "currency": "USD"
            },
            "note": "Thanks for your support!",
            "sender_item_id": "201403140002",
            "receiver": "1-{{$randomPhoneNumber}}"
        },
        {
            "recipient_type": "PAYPAL_ID",
            "amount": {
                "value": "30.00",
                "currency": "USD"
            },
            "note": "Thanks for your patronage!",
            "sender_item_id": "201403140003",
            "receiver": "5DEJUG27PZB9J"
        }
    ]
}'

返回响应

🟢201201 - Create Batch Payout

application/json

Body

batch_header

object

必需

payout_batch_id

string

必需

batch_status

string

必需

sender_batch_header

object

必需

links

array [object {4}]

必需

href

string

可选

rel

string

可选

method

string

可选

encType

string

可选

示例

{
    "batch_header": {
        "payout_batch_id": "MJ77GF8MQ2TF6",
        "batch_status": "PENDING",
        "sender_batch_header": {
            "sender_batch_id": "Payouts_1681157804",
            "email_subject": "You have a payout!",
            "email_message": "You have received a payout! Thanks for using our service!"
        }
    },
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payouts/MJ77GF8MQ2TF6",
            "rel": "self",
            "method": "GET",
            "encType": "application/json"
        }
    ]
}

🟠400400 Bad Request - Sender Batch ID Already Exists

🟠401401 Unauthorized - Invalid Token