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
Initiates a new payment transaction.
| Parameter | Type | Details |
|---|---|---|
| amount | decimal | Your Amount , Must be rounded at 2 precision. |
| currency | string | Currency Code, Must be in Upper Case (Alpha-3 code) |
| success_url | string | Enter your return or success URL |
| cancel_url | string (optional) | Enter your cancel or failed URL |
Request Example (guzzle)
<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', $base_url.'create-order', [
'headers' => [
'Authorization' => 'Bearer '. $authorizationToken,
'accept' => 'application/json',
'content-type' => 'application/json',
],
'form_params' => [
'amount' => '$amount',
'currency' => 'currency',
'success_url' => 'success_url',
'cancel_url' => 'cancel_url',
],
]);
echo $response->getBody();
**Response: SUCCESS (200 OK)**
{
"message": {
"success": [
"Order created successfully."
]
},
"data": {
"redirect_url":"https://example.com/login/OISADFDFSDFSF",
"order_details":{
"amount" : "10",
"fixed_charge" : 2,
"percent_charge" : 1,
"total_charge" : 3,
"total_payable" : 13,
"currency" : "USD",
"expiry_time": "2024-04-25T06:48:35.984285Z",
"success_url": "http://127.0.0.1/nfcpay/user/transaction/success",
"cancel_url": "http://127.0.0.1/nfcpay/user/transaction/cancel"
}
},
"type": "success"
}
**Response: ERROR (400 FAILED)**
{
"message": {
"error": [
"Invalid token."
]
},
"data": null,
"type": "error"
}