❮❮ Back to Samples

Request Object

{
    "sender_batch_header": {
        "sender_batch_id": "676cfc852cd5f",
        "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": "XKFQZZJRLJ3S4",
        "batch_status": "SUCCESS",
        "time_created": "2024-12-26T06:49:41Z",
        "time_completed": "2024-12-26T06:49:42Z",
        "sender_batch_header": {
            "sender_batch_id": "676cfc852cd5f",
            "email_subject": "You have a Payout!"
        },
        "funding_source": "BALANCE",
        "amount": {
            "currency": "USD",
            "value": "1.00"
        },
        "fees": {
            "currency": "USD",
            "value": "0.25"
        }
    },
    "items": [
        {
            "payout_item_id": "4HQ9VCAAFMZEL",
            "transaction_id": "5MX05769H4124853J",
            "activity_id": "75800169RT242411C",
            "transaction_status": "UNCLAIMED",
            "payout_item_fee": {
                "currency": "USD",
                "value": "0.25"
            },
            "payout_batch_id": "XKFQZZJRLJ3S4",
            "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"
            },
            "time_processed": "2024-12-26T06:49:42Z",
            "errors": {
                "name": "RECEIVER_UNREGISTERED",
                "message": "The recipient for this payout does not have an account. A link to sign up for an account was sent to the recipient. However, if the recipient does not claim this payout within 30 days, the funds will be returned to your account.",
                "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/4HQ9VCAAFMZEL",
                    "rel": "item",
                    "method": "GET",
                    "enctype": "application/json"
                }
            ]
        }
    ],
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payouts/XKFQZZJRLJ3S4?page_size=1&page=1",
            "rel": "self",
            "method": "GET",
            "enctype": "application/json"
        }
    ]
}

Request Object

Response Object

{
    "payout_item_id": "4HQ9VCAAFMZEL",
    "transaction_id": "5MX05769H4124853J",
    "activity_id": "75800169RT242411C",
    "transaction_status": "RETURNED",
    "payout_item_fee": {
        "currency": "USD",
        "value": "0.25"
    },
    "payout_batch_id": "XKFQZZJRLJ3S4",
    "sender_batch_id": "676cfc852cd5f",
    "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"
    },
    "time_processed": "2024-12-26T06:49:42Z",
    "errors": {
        "name": "RECEIVER_UNREGISTERED",
        "message": "The recipient for this payout does not have an account. A link to sign up for an account was sent to the recipient. However, if the recipient does not claim this payout within 30 days, the funds will be returned to your account.",
        "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/4HQ9VCAAFMZEL",
            "rel": "self",
            "method": "GET",
            "enctype": "application/json"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payouts/XKFQZZJRLJ3S4",
            "rel": "batch",
            "method": "GET",
            "enctype": "application/json"
        }
    ]
}