<?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();
}
}
Get access token to initiates payment transaction.
generate-token
| Parameter | Type | Comments |
|---|---|---|
| client_id | string | Enter merchant API client/primary key |
| secret_id | string | Enter merchant API secret key |
| env | string | Enter merchant API environment |
| merchant_id | string | Enter merchant API merchant id |
Request Example (guzzle)
<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', $base_url. 'v1/generate-token', [
'headers' => [
'accept' => 'application/json',
'content-type' => 'application/json',
],
'form_params' => [
'client_id' => '$client_id',
'secret_id' => 'secret_id',
'env' => 'env',
'merchant_id' => 'merchant_id',
],
]);
echo $response->getBody();
**Response: SUCCESS (200 OK)**
{
"message": {
"success": [
"Successfully token is generated"
]
},
"data": {
"token":"eyJpdiI6InpkczhjTjhQdVhUL2lKQ0pSUUx6aUE9PSIsInZhbHVlIjoiVGVBTVBDTXltbjNZcEIvdEJveGpTSno3TU5NRUtnVkhCZ1pHTFNCUnZGQ2UxMnYxN202cEE1YVRDTEFsc0ZERExoTjdtL0dTL2xoU3QzeUJJOExiMUx5T0w1L0llUXhTUkU1cWVLWEdEbEplb0dKNXcwbTNRM0VxdkUwYzZuNFdtNkhMQ0pRZysyNWkvdzBxSlBoSVBSOGFTekNnR2RXNHVtcG9lMGZOTmNCcm1hR3c5Sk9KTnB4Y3ltZDl6cm90MThrR21Ca3B1azc3bXRiQ0J6SW96UVo1elNkU1ZqeE05bTcwWGp1MEUxWlJFdnNWTmpSbnVpeW92b2U4dXZkUGgyb1VmK0luaGdyaFlsVTZlcVpVRnZlTG1DeFF6Ykk2T2h6Z3JzbnIyNHpNdHowSE5JdDR0Y0pZT20zUm1XYW8iLCJtYWMiOiJlY2M4NGE1OGUzYzkzYzk0YzljNmVmNjE0YWI0ZDIwOGI3NDQ2YWEyY2ZhNzc0NzE4ZmY1ZmYyMz
IyZmQzNDY1IiwidGFnIjoiIn0=",
},
"type": "success"
}
**Response: ERROR (400 FAILED)**
{
"message": {
"error": [
"Invalid credentials."
]
},
"data": null,
"type": "error"
}