PayPal REST API Samples

1. Created Webhook

Webhook with ID: 9WM93948RW486100T

Request Object

{
    "url": "https://requestb.in/10ujt3c1?uniqid=6a7b97984f68e",
    "event_types": [
        {
            "name": "PAYMENT.AUTHORIZATION.CREATED"
        },
        {
            "name": "PAYMENT.AUTHORIZATION.VOIDED"
        }
    ]
}

Response Object

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/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/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

{
    "url": "https://requestb.in/10ujt3c1?uniqid=6a7b97984f68e",
    "event_types": [
        {
            "name": "PAYMENT.AUTHORIZATION.CREATED",
            "description": "A payment authorization is created, approved, executed, or a future payment authorization is created."
        },
        {
            "name": "PAYMENT.AUTHORIZATION.VOIDED",
            "description": "A payment authorization is voided."
        }
    ],
    "id": "9WM93948RW486100T",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/9WM93948RW486100T",
            "rel": "self",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/9WM93948RW486100T",
            "rel": "update",
            "method": "PATCH"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/9WM93948RW486100T",
            "rel": "delete",
            "method": "DELETE"
        }
    ]
}

Request
Response

Request Object

{
    "url": "https://requestb.in/10ujt3c1?uniqid=6a7b97984f68e",
    "event_types": [
        {
            "name": "PAYMENT.AUTHORIZATION.CREATED"
        },
        {
            "name": "PAYMENT.AUTHORIZATION.VOIDED"
        }
    ]
}

Response Object

{
    "url": "https://requestb.in/10ujt3c1?uniqid=6a7b97984f68e",
    "event_types": [
        {
            "name": "PAYMENT.AUTHORIZATION.CREATED",
            "description": "A payment authorization is created, approved, executed, or a future payment authorization is created."
        },
        {
            "name": "PAYMENT.AUTHORIZATION.VOIDED",
            "description": "A payment authorization is voided."
        }
    ],
    "id": "9WM93948RW486100T",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/9WM93948RW486100T",
            "rel": "self",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/9WM93948RW486100T",
            "rel": "update",
            "method": "PATCH"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/9WM93948RW486100T",
            "rel": "delete",
            "method": "DELETE"
        }
    ]
}

2. Updated a Webhook

Webhook with ID: 9WM93948RW486100T

Request Object

[
    {
        "op": "replace",
        "path": "/url",
        "value": "https://requestb.in/10ujt3c1?uniqid=6a7b9798dff11"
    },
    {
        "op": "replace",
        "path": "/event_types",
        "value": [
            {
                "name": "PAYMENT.SALE.REFUNDED"
            }
        ]
    }
]

Response Object

{
    "url": "https://requestb.in/10ujt3c1?uniqid=6a7b9798dff11",
    "event_types": [
        {
            "name": "PAYMENT.SALE.REFUNDED",
            "description": "A merchant refunds a sale."
        }
    ],
    "id": "9WM93948RW486100T",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/9WM93948RW486100T",
            "rel": "self",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/9WM93948RW486100T",
            "rel": "update",
            "method": "PATCH"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/9WM93948RW486100T",
            "rel": "delete",
            "method": "DELETE"
        }
    ]
}

Request
Response

Request Object

[
    {
        "op": "replace",
        "path": "/url",
        "value": "https://requestb.in/10ujt3c1?uniqid=6a7b9798dff11"
    },
    {
        "op": "replace",
        "path": "/event_types",
        "value": [
            {
                "name": "PAYMENT.SALE.REFUNDED"
            }
        ]
    }
]

Response Object

{
    "url": "https://requestb.in/10ujt3c1?uniqid=6a7b9798dff11",
    "event_types": [
        {
            "name": "PAYMENT.SALE.REFUNDED",
            "description": "A merchant refunds a sale."
        }
    ],
    "id": "9WM93948RW486100T",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/9WM93948RW486100T",
            "rel": "self",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/9WM93948RW486100T",
            "rel": "update",
            "method": "PATCH"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/9WM93948RW486100T",
            "rel": "delete",
            "method": "DELETE"
        }
    ]
}

❮❮ Back to Samples

1. Created Webhook

Request Object

Response Object

Request Object

Response Object

2. Updated a Webhook

Request Object

Response Object

Request Object

Response Object