Developer
<?php
namespace Srmklive\PayPal\Traits\PayPalAPI;
trait WebHooks
{
/**
* Create a new web hook.
*
* @param string $url
* @param array $events
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_post
*/
public function createWebHook(string $url, array $events)
{
$this->apiEndPoint = 'v1/notifications/webhooks';
$data = ['url' => $url];
$data['event_types'] = collect($events)->map(function ($item) {
return ['name' => $item];
})->toArray();
$this->options['json'] = $data;
$this->verb = 'post';
return $this->doPayPalRequest();
}
/**
* List all web hooks.
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_list
*/
public function listWebHooks()
{
$this->apiEndPoint = 'v1/notifications/webhooks';
$this->verb = 'get';
return $this->doPayPalRequest();
}
/**
* Delete a web hook.
*
* @param string $web_hook_id
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_delete
*/
public function deleteWebHook(string $web_hook_id)
{
$this->apiEndPoint = "v1/notifications/webhooks/{$web_hook_id}";
$this->verb = 'delete';
return $this->doPayPalRequest(false);
}
/**
* Update an existing web hook.
*
* @param string $web_hook_id
* @param array $data
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_update
*/
public function updateWebHook(string $web_hook_id, array $data)
{
$this->apiEndPoint = "v1/notifications/webhooks/{$web_hook_id}";
$this->options['json'] = $data;
$this->verb = 'patch';
return $this->doPayPalRequest();
}
/**
* Show details for an existing web hook.
*
* @param string $web_hook_id
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_get
*/
public function showWebHookDetails(string $web_hook_id)
{
$this->apiEndPoint = "v1/notifications/webhooks/{$web_hook_id}";
$this->verb = 'get';
return $this->doPayPalRequest();
}
/**
* List events for an existing web hook.
*
* @param string $web_hook_id
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_get
*/
public function listWebHookEvents($web_hook_id)
{
$this->apiEndPoint = "v1/notifications/webhooks/{$web_hook_id}/event-types";
$this->verb = 'get';
return $this->doPayPalRequest();
}
}
Developer
In case of an error, the API will return an error response containing a specific error code 400, 403 Failed and a user-friendly message. Refer to our API documentation for a comprehensive list of error codes and their descriptions.