Skip to content

Latest commit

 

History

History
121 lines (99 loc) · 3.49 KB

README.md

File metadata and controls

121 lines (99 loc) · 3.49 KB
Raw

PHP SnapScan Class

Open a terminal and start playing.

Clone in

git clone git@github.com:drpain/SnapScan.git
cd SnapScan

Like Docker, run this with it :-D

docker run -it --rm --name PHP-SnapScan \
-v "$PWD":/usr/src/myapp \
-w /usr/src/myapp \
php:7.2-fpm php index.php

Hopefully you have Docker installed already, otherwise this will not work.

Example usage 'index.php'

<?php

// This file shows you sample usage of the SnapScan class I wrote
// SnapScan is a awesome service, and I would like to contribute to it's success
// Even if it just shows you possible usage

// Add the required files
require_once('class.qrcode.php');
require_once('class.snapscan.php');

// Initialize SnapScan. Used to be able to generate your Custom SnapScan
// QRCode
$snapMerchantId = "SnapSanID1232_test";
SnapScan::Init($snapMerchantId);

// Generating your custom QR Code. There are some options available
// Where amount is the only required parameter.
// $strict means that a client can overpay, but not overpay.
//
// QR($amount=false, $id=false, $strict=true, $size=300, $margin=0)
// Generate a R50 QRCode
$QRCode = SnapScan::QR(50);
?>

<img
    src="<?php echo $QRCode ?>"
    width="300"
    height="300"
    alt="ScanScan Barcode"
/>

<?php
// Generate the QR Code with a unique reference to keep track of the transaction
// Generate a R100 QRCode, with a Unique Reference
$uniqueId = "Super_Awesome_Unique_ID_101201";
$QRCode = SnapScan::QR(100, $uniqueId);
?>

<img
    src="<?php echo $QRCode ?>"
    width="300"
    height="300"
    alt="ScanScan Barcode"
/>

<?php

// To be able to do calls against the API, you will need to obtain a
// API Token from SnapScan, and specify it.
$snapToken = "0a63fca2-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
SnapScan::setApiToken($snapToken);

// After you have set your API Token you can check that a transaction was successful
$uniqueId = "Super_Awesome_Unique_ID_101201";
$checkPayment = SnapScan::checkPayment($uniqueId);

// returns [] With payment details / False depending on whether the payment was successful
// Or fails miserably
if (!empty($checkPayment)) {
    echo "FOUND PAYMENT!!!" . PHP_EOL;
    echo print_r($checkPayment, true) . PHP_EOL;
} else {
    echo "PAYMENT NOT FOUND!" . PHP_EOL;
}

Get a list of your payments:

<?php
// Include the required files
require_once('class.qrcode.php');
require_once('class.snapscan.php'

// Initialize the class and set your API Token
SnapScan::Init(<your-merchant-id>);
SnapScan::setApiToken(<your-merchant-api-key>);

// This will default to the last 3 years worth of payments to date
$payments = SnapScan::payments();

// You can also override the default date range by passing in the following options, as parameters:
// For example the last 2 weeks up until yesterday's payments
$payments = SnapScan::payments([
    'startDate' => date('c', strtotime('-2 weeks')),
    'endDate' => date('c', strtotime('-1 day'))
]);

/** These match the options as available on the API:
startDate	Payments that were started at or after this time, eg: 2000-01-01T01:00:00Z
endDate	Payments that were started before this time, eg: 2000-01-01T01:00:00Z
status	A comma separated string of the following values: completed, error or pending, eg. completed,pending
snapCode	Payments with the SnapCode.
snapCodeReference	Payments with the SnapCode reference.
userReference	Payments with the user reference.
merchantReference	Payments with your reference.
statementReference	Payments included in the settlement with the provided reference.
*/