Skip to content

Commit 996585c

Browse files
elias-haileselassieelias-haileselassie
committed
webhook samples
1 parent c192089 commit 996585c

7 files changed

+125
-6
lines changed

‎composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "webirr/webirr",
33
"type": "library",
4-
"version": "2.0.0",
4+
"version": "2.0.1",
55
"description": "Official PHP Client Library for WeBirr Payment Gateway APIs",
66
"keywords": ["ethiopia", "fintech"],
77
"homepage": "https://github.com/webirr/webirr-api-php-client",

‎examples/example1.php ‎examples/example1-create-update-bill.php

File renamed without changes.

‎examples/example2.php ‎examples/example2-payment-status-single-poll.php

File renamed without changes.

‎examples/example3.php ‎examples/example3-delete-bill.php

File renamed without changes.

‎examples/example4.php ‎examples/example4-payment-status-bulk-poll.php

+8-5
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ public function Run()
2525
{
2626
while (true) {
2727
echo "\nRetrieving Payments...";
28-
$this->FetchPayments();
28+
$this->fetchAndProcessPayments();
2929
echo "\nSleeping for 5 seconds...";
3030
sleep(5); // Sleep for 5 seconds before the next polling
3131
}
3232
}
3333

34-
private function FetchPayments()
34+
private function fetchAndProcessPayments()
3535
{
3636
$limit = 100; // Number of records to retrieve depending on your processing requirement & capacity
3737
$response = $this->api->getPayments($this->lastTimeStamp, $limit);
@@ -43,7 +43,7 @@ private function FetchPayments()
4343
}
4444
foreach ($response->res as $obj) {
4545
$payment = new Payment($obj);
46-
$this->ProcessPayment($payment);
46+
$this->processPayment($payment);
4747
echo "\n-----------------------------";
4848
}
4949

@@ -59,8 +59,11 @@ private function FetchPayments()
5959
}
6060
}
6161

62-
// Process Payment should be impleneted as idempotent operation for production use cases
63-
private function ProcessPayment(Payment $payment)
62+
/**
63+
* Process Payment should be impleneted as idempotent operation for production use cases
64+
* This method and logic can be shared among all payment processing consumers: 1. bulk polling, 2. webhook, 3. single payment polling.
65+
*/
66+
private function processPayment(Payment $payment)
6467
{
6568
echo "\nPayment Status: " . $payment->status;
6669
if ($payment->IsPaid()) {

‎examples/example5.php ‎examples/example5-stat-report.php

File renamed without changes.

‎examples/example6-payment-status-webhook.php

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
<?php
2+
3+
require 'vendor/autoload.php';
4+
5+
use WeBirr\Payment;
6+
7+
class Webhook
8+
{
9+
/**
10+
* Handle incoming webhook POST requests.
11+
* Validates request method (must be POST).
12+
* Checks authentication using the authKey from the query string, otherwise system will not know if the request is coming from WeBirr(authorized) or not
13+
*/
14+
public function handleRequest()
15+
{
16+
// Validate request method is POST
17+
if ($_SERVER['REQUEST_METHOD'] !== 'POST') {
18+
http_response_code(405); // Method Not Allowed
19+
header('Content-Type: application/json');
20+
echo json_encode(["error" => "Method Not Allowed. POST required."]);
21+
return;
22+
}
23+
24+
// Authenticate using authKey query string parameter, otherwise system will not know if the request is from WeBirr(authorized) or not
25+
if (!$this->isAuthenticated()) {
26+
http_response_code(403);
27+
header('Content-Type: application/json');
28+
echo json_encode(["error" => "Unauthorized access. Invalid authKey."]);
29+
return;
30+
}
31+
32+
// Read the raw JSON input
33+
$rawPayload = file_get_contents('php://input');
34+
if (empty($rawPayload)) {
35+
http_response_code(400); // Bad Request
36+
header('Content-Type: application/json');
37+
echo json_encode(["error" => "Empty request body."]);
38+
return;
39+
}
40+
41+
// Decode the JSON payload into an associative array
42+
$data = json_decode($rawPayload, true);
43+
if (json_last_error() !== JSON_ERROR_NONE) {
44+
http_response_code(400);
45+
header('Content-Type: application/json');
46+
echo json_encode(["error" => "Invalid JSON format."]);
47+
return;
48+
}
49+
50+
try {
51+
$payment = new Payment($data);
52+
} catch (Exception $e) {
53+
http_response_code(400);
54+
header('Content-Type: application/json');
55+
echo json_encode(["error" => "Invalid payment data: " . $e->getMessage()]);
56+
return;
57+
}
58+
59+
// Process the payment asynchronously (or enqueue it for later processing)
60+
// here instead of immediate processing, this should be handled asynchronously or enqueued to a background worker/job.
61+
$this->processPayment($payment);
62+
63+
// Return a JSON success response (can also be just empty body with 200 OK status)
64+
http_response_code(200);
65+
header('Content-Type: application/json');
66+
echo json_encode(["success" => true, "message" => "Payment received and queued for processing"]);
67+
}
68+
69+
/**
70+
* Authenticate the request using authKey from the query string.
71+
*
72+
* The authKey is compared against the environment variable `WB_WEBHOOK_AUTH_KEY`.
73+
*
74+
* @return bool True if authentication succeeds, false otherwise.
75+
*/
76+
private function isAuthenticated(): bool
77+
{
78+
// Retrieve the authKey from the query string
79+
$providedAuthKey = $_GET['authKey'] ?? '';
80+
81+
// TODO: Replace this with your own auth key (preferably from environment variable)
82+
$expectedAuthKey = "please-change-me-to-secure-key-5114831AFD5D4646901DCDAC58B92F8E";
83+
//$expectedAuthKey = getenv('wb_webhook_authkey') !== false ? getenv('wb_webhook_authkey') : "";
84+
85+
// Compare the provided key with the expected key
86+
return !empty($expectedAuthKey) && hash_equals($expectedAuthKey, $providedAuthKey);
87+
}
88+
89+
/**
90+
* Process Payment should be impleneted as idempotent operation for production use cases
91+
* Prefered approach is: Payment should be processed asynchronously or enqueued to a background worker.
92+
* This method and logic can be shared among all payment processing consumers: 1. bulk polling, 2. webhook, 3. single payment polling.
93+
* @param Payment $payment The Payment object.
94+
*/
95+
private function processPayment(Payment $payment)
96+
{
97+
echo "\nPayment Status: " . $payment->status;
98+
if ($payment->IsPaid()) {
99+
echo "\nPayment Status Text: Paid.";
100+
}
101+
if ($payment->IsReversed()) {
102+
echo "\nPayment Status Text: Reversed.";
103+
}
104+
echo "\nBank: " . $payment->bankID;
105+
echo "\nBank Reference Number: " . $payment->paymentReference;
106+
echo "\nAmount Paid: " . $payment->amount;
107+
echo "\nPayment Date: " . $payment->paymentDate;
108+
echo "\nReversal/Cancel Date: " . $payment->canceledTime;
109+
echo "\nUpdate Timestamp: " . $payment->updateTimeStamp;
110+
}
111+
112+
}
113+
114+
// Instantiate and handle the webhook request. once hosted, the url needs to be shared with WeBirr for configuration
115+
$webhook = new Webhook();
116+
$webhook->handleRequest();

0 commit comments

Comments
 (0)