❮❮ Back to Samples

Request Object

{
    "sender_batch_header": {
        "sender_batch_id": "68b4e51ce46cf",
        "email_subject": "You have a payment"
    },
    "items": [
        {
            "recipient_type": "Email",
            "note": "Thanks you.",
            "receiver": "shirt-supplier-one@gmail.com",
            "sender_item_id": "item_168b4e51ce4743",
            "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": "68b4e51ce48bb",
            "amount": {
                "value": "0.90",
                "currency": "USD"
            }
        }
    ]
}

Response Object

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

Request Object

Response Object

{
    "batch_header": {
        "payout_batch_id": "XELYFK5LF4R58",
        "batch_status": "PENDING",
        "time_created": "2025-09-01T00:13:17Z",
        "sender_batch_header": {
            "sender_batch_id": "68b4e51ce46cf",
            "email_subject": "You have a payment"
        },
        "funding_source": "BALANCE",
        "amount": {
            "currency": "USD",
            "value": "2.79"
        }
    },
    "items": [
        {
            "payout_item_id": "VHBC7QQA8T7CQ",
            "transaction_status": "PENDING",
            "payout_batch_id": "XELYFK5LF4R58",
            "payout_item": {
                "recipient_type": "EMAIL",
                "amount": {
                    "currency": "USD",
                    "value": "0.99"
                },
                "note": "Thanks you.",
                "receiver": "shirt-supplier-one@gmail.com",
                "sender_item_id": "item_168b4e51ce4743",
                "recipient_wallet": "PAYPAL",
                "purpose": "GOODS"
            },
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/VHBC7QQA8T7CQ",
                    "rel": "item",
                    "method": "GET",
                    "enctype": "application/json"
                }
            ]
        },
        {
            "payout_item_id": "M9R45PTLZJN9C",
            "transaction_status": "PENDING",
            "payout_batch_id": "XELYFK5LF4R58",
            "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/M9R45PTLZJN9C",
                    "rel": "item",
                    "method": "GET",
                    "enctype": "application/json"
                }
            ]
        },
        {
            "payout_item_id": "FVRWV2UW97CU2",
            "transaction_status": "PENDING",
            "payout_batch_id": "XELYFK5LF4R58",
            "payout_item": {
                "recipient_type": "EMAIL",
                "amount": {
                    "currency": "USD",
                    "value": "0.90"
                },
                "note": "Thank you.",
                "receiver": "shirt-supplier-three@mail.com",
                "sender_item_id": "68b4e51ce48bb",
                "recipient_wallet": "PAYPAL",
                "purpose": "GOODS"
            },
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/FVRWV2UW97CU2",
                    "rel": "item",
                    "method": "GET",
                    "enctype": "application/json"
                }
            ]
        }
    ],
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payouts/XELYFK5LF4R58?page_size=1000&page=1",
            "rel": "self",
            "method": "GET",
            "enctype": "application/json"
        }
    ]
}