❮❮ Back to Samples

Request Object

{
    "sender_batch_header": {
        "sender_batch_id": "6af9edb2cd2a4",
        "email_subject": "You have a Payout!"
    },
    "items": [
        {
            "recipient_type": "Email",
            "note": "Thanks for your patronage!",
            "receiver": "shirt-supplier-one@gmail.com",
            "sender_item_id": "2014031400023",
            "amount": {
                "value": "1.00",
                "currency": "USD"
            }
        }
    ]
}

Response Object

{
    "batch_header": {
        "payout_batch_id": "LREU2G2LGQF4E",
        "batch_status": "DENIED",
        "time_created": "2026-11-15T17:36:51Z",
        "sender_batch_header": {
            "sender_batch_id": "6af9edb2cd2a4",
            "email_subject": "You have a Payout!"
        },
        "funding_source": "BALANCE",
        "amount": {
            "currency": "USD",
            "value": "1.00"
        },
        "fees": {
            "currency": "USD",
            "value": "0.00"
        }
    },
    "items": [
        {
            "payout_item_id": "VEHVEVBBE6VD4",
            "transaction_status": "FAILED",
            "payout_item_fee": {
                "currency": "USD",
                "value": "0.00"
            },
            "payout_batch_id": "LREU2G2LGQF4E",
            "payout_item": {
                "recipient_type": "EMAIL",
                "amount": {
                    "currency": "USD",
                    "value": "1.00"
                },
                "note": "Thanks for your patronage!",
                "receiver": "shirt-supplier-one@gmail.com",
                "sender_item_id": "2014031400023",
                "recipient_wallet": "PAYPAL",
                "purpose": "GOODS"
            },
            "errors": {
                "name": "UNVERIFIED_RECIPIENT_NOT_SUPPORTED",
                "message": "The payment hasn\u2019t been processed as this recipient account is not set up or verified by PayPal.",
                "information_link": "https://developer.paypal.com/docs/api/payments.payouts-batch/#errors",
                "details": {},
                "links": {}
            },
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/VEHVEVBBE6VD4",
                    "rel": "item",
                    "method": "GET",
                    "enctype": "application/json"
                }
            ]
        }
    ],
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payouts/LREU2G2LGQF4E?page_size=1&page=1",
            "rel": "self",
            "method": "GET",
            "enctype": "application/json"
        }
    ]
}

Request Object

VEHVEVBBE6VD4

Response Object

Payout Item Status is not UNCLAIMED