PayPal REST API Samples

Request Object

{
    "sender_batch_header": {
        "sender_batch_id": "6a04bdedd8656",
        "email_subject": "You have a payment"
    },
    "items": [
        {
            "recipient_type": "Email",
            "note": "Thanks you.",
            "receiver": "shirt-supplier-one@gmail.com",
            "sender_item_id": "item_16a04bdedd8689",
            "amount": {
                "value": "0.99",
                "currency": "USD"
            }
        },
        {
            "recipient_type": "EMAIL",
            "amount": {
                "value": "0.90",
                "currency": "USD"
            },
            "receiver": "shirt-supplier-two@mail.com",
            "note": "Thank you.",
            "sender_item_id": "item_2"
        },
        {
            "recipient_type": "EMAIL",
            "receiver": "shirt-supplier-three@mail.com",
            "note": "Thank you.",
            "sender_item_id": "6a04bdedd8761",
            "amount": {
                "value": "0.90",
                "currency": "USD"
            }
        }
    ]
}

Response Object

{
    "batch_header": {
        "payout_batch_id": "HLV5TXXB8N26J",
        "batch_status": "PENDING",
        "sender_batch_header": {
            "sender_batch_id": "6a04bdedd8656",
            "email_subject": "You have a payment"
        }
    },
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payouts/HLV5TXXB8N26J",
            "rel": "self",
            "method": "GET",
            "enctype": "application/json"
        }
    ]
}

Request
Response

Request Object

{
    "sender_batch_header": {
        "sender_batch_id": "6a04bdedd8656",
        "email_subject": "You have a payment"
    },
    "items": [
        {
            "recipient_type": "Email",
            "note": "Thanks you.",
            "receiver": "shirt-supplier-one@gmail.com",
            "sender_item_id": "item_16a04bdedd8689",
            "amount": {
                "value": "0.99",
                "currency": "USD"
            }
        },
        {
            "recipient_type": "EMAIL",
            "amount": {
                "value": "0.90",
                "currency": "USD"
            },
            "receiver": "shirt-supplier-two@mail.com",
            "note": "Thank you.",
            "sender_item_id": "item_2"
        },
        {
            "recipient_type": "EMAIL",
            "receiver": "shirt-supplier-three@mail.com",
            "note": "Thank you.",
            "sender_item_id": "6a04bdedd8761",
            "amount": {
                "value": "0.90",
                "currency": "USD"
            }
        }
    ]
}

Response Object

{
    "batch_header": {
        "payout_batch_id": "HLV5TXXB8N26J",
        "batch_status": "PENDING",
        "sender_batch_header": {
            "sender_batch_id": "6a04bdedd8656",
            "email_subject": "You have a payment"
        }
    },
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payouts/HLV5TXXB8N26J",
            "rel": "self",
            "method": "GET",
            "enctype": "application/json"
        }
    ]
}

Request Object

No Data

Response Object

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/abcfloral/public_html/liberary/PayPal-PHP-SDK/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

{
    "batch_header": {
        "payout_batch_id": "HLV5TXXB8N26J",
        "batch_status": "PENDING",
        "time_created": "2026-05-13T18:07:42Z",
        "sender_batch_header": {
            "sender_batch_id": "6a04bdedd8656",
            "email_subject": "You have a payment"
        },
        "funding_source": "BALANCE",
        "amount": {
            "currency": "USD",
            "value": "2.79"
        }
    },
    "items": [
        {
            "payout_item_id": "VRKRCGG785JJQ",
            "transaction_status": "PENDING",
            "payout_batch_id": "HLV5TXXB8N26J",
            "payout_item": {
                "recipient_type": "EMAIL",
                "amount": {
                    "currency": "USD",
                    "value": "0.99"
                },
                "note": "Thanks you.",
                "receiver": "shirt-supplier-one@gmail.com",
                "sender_item_id": "item_16a04bdedd8689",
                "recipient_wallet": "PAYPAL",
                "purpose": "GOODS"
            },
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/VRKRCGG785JJQ",
                    "rel": "item",
                    "method": "GET",
                    "enctype": "application/json"
                }
            ]
        },
        {
            "payout_item_id": "QGN8LBSGSNCNG",
            "transaction_status": "PENDING",
            "payout_batch_id": "HLV5TXXB8N26J",
            "payout_item": {
                "recipient_type": "EMAIL",
                "amount": {
                    "currency": "USD",
                    "value": "0.90"
                },
                "note": "Thank you.",
                "receiver": "shirt-supplier-two@mail.com",
                "sender_item_id": "item_2",
                "recipient_wallet": "PAYPAL",
                "purpose": "GOODS"
            },
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/QGN8LBSGSNCNG",
                    "rel": "item",
                    "method": "GET",
                    "enctype": "application/json"
                }
            ]
        },
        {
            "payout_item_id": "87J5AVE2ACHLS",
            "transaction_status": "PENDING",
            "payout_batch_id": "HLV5TXXB8N26J",
            "payout_item": {
                "recipient_type": "EMAIL",
                "amount": {
                    "currency": "USD",
                    "value": "0.90"
                },
                "note": "Thank you.",
                "receiver": "shirt-supplier-three@mail.com",
                "sender_item_id": "6a04bdedd8761",
                "recipient_wallet": "PAYPAL",
                "purpose": "GOODS"
            },
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/87J5AVE2ACHLS",
                    "rel": "item",
                    "method": "GET",
                    "enctype": "application/json"
                }
            ]
        }
    ],
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payouts/HLV5TXXB8N26J?page_size=1000&page=1",
            "rel": "self",
            "method": "GET",
            "enctype": "application/json"
        }
    ]
}

Request
Response

Request Object

No Data

Response Object

{
    "batch_header": {
        "payout_batch_id": "HLV5TXXB8N26J",
        "batch_status": "PENDING",
        "time_created": "2026-05-13T18:07:42Z",
        "sender_batch_header": {
            "sender_batch_id": "6a04bdedd8656",
            "email_subject": "You have a payment"
        },
        "funding_source": "BALANCE",
        "amount": {
            "currency": "USD",
            "value": "2.79"
        }
    },
    "items": [
        {
            "payout_item_id": "VRKRCGG785JJQ",
            "transaction_status": "PENDING",
            "payout_batch_id": "HLV5TXXB8N26J",
            "payout_item": {
                "recipient_type": "EMAIL",
                "amount": {
                    "currency": "USD",
                    "value": "0.99"
                },
                "note": "Thanks you.",
                "receiver": "shirt-supplier-one@gmail.com",
                "sender_item_id": "item_16a04bdedd8689",
                "recipient_wallet": "PAYPAL",
                "purpose": "GOODS"
            },
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/VRKRCGG785JJQ",
                    "rel": "item",
                    "method": "GET",
                    "enctype": "application/json"
                }
            ]
        },
        {
            "payout_item_id": "QGN8LBSGSNCNG",
            "transaction_status": "PENDING",
            "payout_batch_id": "HLV5TXXB8N26J",
            "payout_item": {
                "recipient_type": "EMAIL",
                "amount": {
                    "currency": "USD",
                    "value": "0.90"
                },
                "note": "Thank you.",
                "receiver": "shirt-supplier-two@mail.com",
                "sender_item_id": "item_2",
                "recipient_wallet": "PAYPAL",
                "purpose": "GOODS"
            },
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/QGN8LBSGSNCNG",
                    "rel": "item",
                    "method": "GET",
                    "enctype": "application/json"
                }
            ]
        },
        {
            "payout_item_id": "87J5AVE2ACHLS",
            "transaction_status": "PENDING",
            "payout_batch_id": "HLV5TXXB8N26J",
            "payout_item": {
                "recipient_type": "EMAIL",
                "amount": {
                    "currency": "USD",
                    "value": "0.90"
                },
                "note": "Thank you.",
                "receiver": "shirt-supplier-three@mail.com",
                "sender_item_id": "6a04bdedd8761",
                "recipient_wallet": "PAYPAL",
                "purpose": "GOODS"
            },
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/87J5AVE2ACHLS",
                    "rel": "item",
                    "method": "GET",
                    "enctype": "application/json"
                }
            ]
        }
    ],
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payouts/HLV5TXXB8N26J?page_size=1000&page=1",
            "rel": "self",
            "method": "GET",
            "enctype": "application/json"
        }
    ]
}

❮❮ Back to Samples

1. Created Batch Payout

Request Object

Response Object

Request Object

Response Object

2. Get Payout Batch Status

Request Object

Response Object

Request Object

Response Object