init version

.env.example

@@ -0,0 +1,6 @@
+CLIENT_ID = ''
+CLIENT_SECRET = ''
+SIGNING_KEY_ID = ''
+SIGNING_KEY = ''
+API_END_POINT = 'https://sandbox.api.payme.hsbc.com.hk'
+API_VERSION = '0.12'

.gitignore

@@ -0,0 +1,3 @@
+/vendor/
+.env
+.php-cs-fixer.cache

README.MD

@@ -0,0 +1,140 @@
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+
+<p align="center">
+
+  <h3 align="center">PayMe API Demo</h3>
+
+  <p align="center">
+    <a href="https://github.com/apphk/payme-api-demo"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/apphk/payme-api-demo">View Demo</a>
+    ·
+    <a href="https://github.com/apphk/payme-api-demo/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/apphk/payme-api-demo/issues">Request Feature</a>
+  </p>
+</p>
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+[![PayMe API Flow][payme-flow]](https://developers.payme.hsbc.com.hk/get-started)
+
+### Built With
+
+* [PHP](https://www.php.net/)
+
+
+
+## Getting Started
+
+### Prerequisites
+
+Get your PayMe business account ready and Receive your API credentials
+* API Credentials consist of 4 parameters
+    ```text
+    Client ID 
+    Secret Key
+    Signing Key ID
+    Signing Key
+    ```
+
+### Installation
+
+1. Get the PayMe API package 
+2. Clone this repo 
+    ```sh
+    git clone https://github.com/apphk/payme-api-demo
+    ```
+3. Rename .env.example to .env and update the variables with your credentials
+    ```sh
+    CLIENT_ID = ''
+    CLIENT_SECRET = ''
+    SIGNING_KEY_ID = ''
+    SIGNING_KEY = ''
+   ...
+    ```
+4. Install packages
+   ```sh
+   composer install
+   ```
+5. Run example.php 
+   ```sh
+   php example.php 
+   ```
+
+## Usage
+
+- Init api client
+    ```php
+    $client = new ApiClient($clientId, $clientSecret, $signingKeyId, $signingKey, $apiUrl);
+    ```
+- Send payment request
+    ```php
+    $response = $client->payment()->requests($request);
+    ```
+- Get payment request status
+    ```php
+    $response = $client->payment()->status($paymentRequestId);
+    ```  
+- Cancel payment request
+    ```php
+    $response = $client->payment()->cancel($paymentRequestId);
+    ```
+- Transactions
+    ```php
+    $response = $client->payment()->transactions();
+    ```
+- Get transaction by id
+    ```php
+    $response = $client->payment()->transaction($transactionId);
+    ```
+- Refunds
+    ```php
+    $response = $client->payment()->refunds($transactionId, $refundsRequest);
+    ```
+  
+_For more api details, please refer to the [Documentation](https://developers.payme.hsbc.com.hk/get-started)_
+
+
+
+<!-- ROADMAP -->
+## Roadmap
+
+See the [open issues](https://github.com/apphk/payme-api-demo/issues) for a list of proposed features (and known issues).
+
+
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<!-- CONTACT -->
+## Contact
+
+Project team: [https://hksay.com](https://hksay.com)
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/apphk/payme-api-demo.svg?style=for-the-badge
+[contributors-url]: https://github.com/apphk/payme-api-demo/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/apphk/payme-api-demo.svg?style=for-the-badge
+[forks-url]: https://github.com/apphk/payme-api-demo/network/members
+[stars-shield]: https://img.shields.io/github/stars/apphk/payme-api-demo.svg?style=for-the-badge
+[stars-url]: https://github.com/apphk/payme-api-demo/stargazers
+[issues-shield]: https://img.shields.io/github/issues/apphk/payme-api-demo.svg?style=for-the-badge
+[issues-url]: https://github.com/apphk/payme-api-demo/issues
+[payme-flow]: https://assets.paymebiz.hsbc.com.hk/public-web-content/public-web-content/drag-dev-portal/img/pmtapi-diagram.png

composer.json

@@ -0,0 +1,12 @@
+{
+    "require": {
+        "kato/payme-api": "dev-master",
+        "vlucas/phpdotenv": "^5.3"
+    },
+    "repositories": [
+        {
+            "type": "path",
+            "url": "../payme-api"
+        }
+    ]
+}

example.php

@@ -0,0 +1,78 @@
+<?php
+
+use Kato\PayMe\ApiClient;
+
+require_once __DIR__ . '/vendor/autoload.php';
+
+$dotenv = Dotenv\Dotenv::createImmutable(__DIR__);
+$dotenv->load();
+
+$clientId = $_ENV['CLIENT_ID'];
+$clientSecret = $_ENV['CLIENT_SECRET'];
+$signingKeyId = $_ENV['SIGNING_KEY_ID'];
+$signingKey = $_ENV['SIGNING_KEY'];
+$apiUrl = $_ENV['API_END_POINT'];
+$version= $_ENV['API_VERSION'];
+
+$client = new ApiClient($clientId, $clientSecret, $signingKeyId, $signingKey, $apiUrl);
+
+$request = json_decode('{
+    "totalAmount": 3.77,
+    "currencyCode": "HKD",
+    "effectiveDuration":600,
+    "notificationUri":"https://webhook.site/a8355331-d748-4951-bf6b-7e02f6fce605",
+    "appSuccessCallback":"www.example.com/success",
+     "appFailCallback":"www.example.com/failure",
+    "merchantData": {
+        "orderId": "ID12345678",
+        "orderDescription": "Description displayed to customer",
+        "additionalData": "Arbitrary additional data - logged but not displayed",
+        "shoppingCart": [
+            {
+                "category1": "General categorization",
+                "category2": "More specific categorization",
+                "category3": "Highly specific categorization",
+                "quantity": 1,
+                "price": 1,
+                "name": "Item 1",
+                "sku": "SKU987654321",
+                "currencyCode": "HKD"
+            },
+            {
+                "category1": "General categorization",
+                "category2": "More specific categorization",
+                "category3": "Highly specific categorization",
+                "quantity": 2,
+                "price": 1,
+                "name": "Item 2",
+                "sku": "SKU678951234",
+                "currencyCode": "HKD"
+            }
+        ]
+    }
+}', true);
+$response = $client->payment()->requests($request);
+var_dump($response);
+
+$requestStatus = $client->payment()->status($response['paymentRequestId']);
+var_dump($requestStatus);
+
+$cancelRequest = $client->payment()->cancel($response['paymentRequestId']);
+var_dump($cancelRequest);
+
+$transactions = $client->payment()->transactions();
+var_dump($transactions);
+
+$transactionId = '1';
+$transaction = $client->payment()->transaction($transactionId);
+var_dump($transaction);
+
+$refundsRequest = json_decode('{
+  "amount": 1.00,
+  "currencyCode": "HKD",
+  "reasonCode": "01",
+  "reasonMessage": "Damaged stock returned to store"
+}', true);
+
+$refunds = $client->payment()->refunds($transactionId, $refundsRequest);
+var_dump($refunds);