A PHP-SDK for developing against the OnPay.io platform. API documentation at: https://manage.onpay.io/docs/api_v1.html
PHP 5.6 and later.
You can install the SDK via Composer. Run the following command:
composer require onpayio/php-sdkA simple example of how to create a payment window v3.
Read more about the fields here: https://manage.onpay.io/docs/paymentwindow_v3.html
<?php
require_once 'vendor/autoload.php';
$paymentWindow = new \OnPay\API\PaymentWindow();
$paymentWindow->setGatewayId("YourGatewayId");
$paymentWindow->setSecret("YourSecret");
$paymentWindow->setCurrency("DKK");
$paymentWindow->setAmount("123400");
// Reference must be unique (eg. invoice number)
$paymentWindow->setReference("UniqieReferenceId");
$paymentWindow->setAcceptUrl("https://example.com/payment?success=1");
$paymentWindow->setDeclineUrl("https://example.com/payment?success=0");
$paymentWindow->setType("payment");
$paymentWindow->setDesign("DesignName");
// Force 3D secure
$paymentWindow->setSecureEnabled(true);
// Set payment method to be card
$paymentWindow->setMethod(\OnPay\API\PaymentWindow::METHOD_CARD);
// Enable testmode
$paymentWindow->setTestMode(true);
$paymentWindow->setLanguage("en");
// Add additional info
$paymentInfo = new \OnPay\API\PaymentWindow\PaymentInfo();
$paymentInfo->setName('Test Pærsån');
$paymentInfo->setEmail('emil@example.com');
// And so on, a lot more fields should be set if data available for it
$paymentWindow->setInfo($paymentInfo);
?>
<?php if($paymentWindow->isValid()) { ?>
<form method="post" action="<?php echo $paymentWindow->getActionUrl(); ?>" accept-charset="UTF-8">
<?php
foreach ($paymentWindow->getFormFields() as $key => $value) { ?>
<input type="hidden" name="<?php echo $key;?>" value="<?php echo htmlspecialchars($value, ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401, 'UTF-8');?>">
<?php } ?>
<input type="submit" value="Make payment">
</form>
<?php } else { ?>
<h1>Payment window is not configured correct</h1>
<?php } ?>You can create a transaction automatically when creating a new subscription using the following functions for the $paymentWindow variable:
$paymentWindow->setType("subscription");
$paymentWindow->setSubscriptionWithTransaction(true);Verifying a payment from the acceptment page can easily be done as following:
$payment = new \OnPay\API\PaymentWindow();
$payment->setSecret('YourSecret');
if($payment->validatePayment($_GET)) {
echo "Payment was successfull";
} else {
echo "There was an error with the payment";
}A simple usage example looks like:
<?php
require_once __DIR__ . '/vendor/autoload.php';
class TokenStorage implements \OnPay\TokenStorageInterface {
protected $token;
protected $fileName;
public function __construct($filename) {
$this->fileName = $filename;
if (file_exists($filename)) {
$this->token = file_get_contents($this->fileName);
}
}
public function getToken() {
return $this->token;
}
public function saveToken($token) {
$this->token = $token;
file_put_contents($this->fileName, $token);
}
}
// TODO: It is extremely important that the .token.bin file is not accessible from the internet.
// It gives complete API access to anyone that gets a hold of it, treat it like a database password!
$tokenStorage = new TokenStorage(__DIR__ . '/.token.bin');
$onPayAPI = new \OnPay\OnPayAPI($tokenStorage, [
'client_id' => 'example.com', // It is recommended to set it to the domain name the integration resides on
'redirect_uri' => 'http://localhost/onpay-php-sdk/example2.php?auth',
'gateway_id' => '1234', // Should be set to the gateway id you are integrating with
]);
// Special handling if we are about to auth against the API
if (isset($_GET['auth'])) {
if (!isset($_GET['code'])) {
$authUrl = $onPayAPI->authorize();
header('Location: ' . $authUrl);
} else {
$onPayAPI->finishAuthorize($_GET['code']);
echo 'Authorized :tada:' . PHP_EOL;
}
exit;
}
// Check if we need to authenticate
if (!$onPayAPI->isAuthorized()) {
echo 'Not authorized for the API! ' . PHP_EOL;
echo '<a href=?auth>Click here to initiate authorization</a>' . PHP_EOL;
exit;
}
// Execute API method
var_dump($onPayAPI->ping());<?php
if($onPayAPI->isAuthorized()) {
$paymentWindow = new OnPay\API\PaymentWindow();
// -- Required fields -- //
// see: https://onpay.io/docs/technical/api_v1.html#create-a-new-payment-request
// for a detailed explanation of each field.
$paymentWindow->setCurrency("DKK");
$paymentWindow->setAmount("39999");
$paymentWindow->setReference('your_reference');
$paymentWindow->setWebsite('https://yourwebsite');
// -- Optional fields -- //
// see: https://onpay.io/docs/technical/api_v1.html#create-a-new-payment-request
// for a detailed explanation of each field.
$paymentWindow->setAcceptUrl('https://yourwebsite/accepturl.php');
$paymentWindow->setDeclineUrl('https://yourwebsite/declineurl.php');
$paymentWindow->setCallbackUrl('https://yourwebsite/callbackurl.php');
$paymentWindow->setType('subscription');
$paymentWindow->setMethod(OnPay\API\Util\PaymentMethods\Enums\Methods::CARD);
$paymentWindow->setLanguage('da');
$paymentWindow->setDesign('my_window');
$paymentWindow->setExpiration(86400);
$paymentWindow->setTestMode(true);
// -- Optional Payment Info Fields -- //
// see: https://onpay.io/docs/technical/api_v1.html#paymentinfo
// for a detailed explanation of each field.
$paymentInfo = new OnPay\API\PaymentWindow\PaymentInfo();
$paymentInfo->setName('individuals name');
$paymentInfo->setEmail('individual@email.address');
$paymentInfo->setAddressIdenticalShipping('Y'); // Or 'N'
$paymentInfo->setDeliveryEmail('delivery@email.address');
$paymentInfo->setDeliveryTimeFrame('03');
$paymentInfo->setPreorder('Y');
$paymentInfo->setPreorderDate(new DateTime('+1 month'));
$paymentInfo->setReorder('N');
$paymentInfo->setShippingMethod('01');
// -- Optional Gift card options -- //
$paymentInfo->setGiftCardAmount('3799');
$paymentInfo->setGiftCardCount('1');
// -- Optional Account options -- //
// see: https://onpay.io/docs/technical/api_v1.html#account
// for a detailed explanation of each field.
$paymentInfo->setAccountId('123-321');
$paymentInfo->setAccountDateCreated('2020-02-15');
$paymentInfo->setAccountDateChange('2020-03-02');
$paymentInfo->setAccountDatePasswordChange('2020-03-02');
$paymentInfo->setAccountPurchases(3);
$paymentInfo->setAccountAttempts(0);
$paymentInfo->setAccountShippingFirstUseDate('2020-02-15');
$paymentInfo->setAccountShippingIdenticalName('Y');
$paymentInfo->setAccountSuspicious('N');
$paymentInfo->setAccountAttemptsDay('3');
$paymentInfo->setAccountAttemptsYear('3');
// -- Optional Shipping options -- //
// see: https://onpay.io/docs/technical/api_v1.html#shipping
// for a detailed explanation of each field.
$paymentInfo->setShippingAddressCity('city');
$paymentInfo->setShippingAddressCountry('208');
$paymentInfo->setShippingAddressLine1('line 1');
$paymentInfo->setShippingAddressLine2('line 2');
$paymentInfo->setShippingAddressLine3('line 3');
$paymentInfo->setShippingAddressPostalCode('8660');
$paymentInfo->setShippingAddressState('NY');
// -- Optional Billing options -- //
// see: https://onpay.io/docs/technical/api_v1.html#billing
// for a detailed explanation of each field.
$paymentInfo->setBillingAddressCity('city');
$paymentInfo->setBillingAddressCountry('208');
$paymentInfo->setBillingAddressLine1('line 1');
$paymentInfo->setBillingAddressLine2('line 2');
$paymentInfo->setBillingAddressLine3('line 3');
$paymentInfo->setBillingAddressPostalCode('8660');
$paymentInfo->setBillingAddressState('NY');
// -- Optional Phone options -- //
// see: https://onpay.io/docs/technical/api_v1.html#phone
// for a detailed explanation of each field.
$paymentInfo->setPhoneHome('45', '37123456');
$paymentInfo->setPhoneMobile('45', '37123456');
$paymentInfo->setPhoneWork('45', '37123456');
// Assign the above settings to the window
$paymentWindow->setInfo($paymentInfo);
// -- (N.B Required for some card methods!) Cart options -- //
// see: https://onpay.io/docs/technical/api_v1.html#paymentcart
// for a detailed explanation of each field.
$paymentCart = new OnPay\API\PaymentWindow\Cart();
// see: https://onpay.io/docs/technical/api_v1.html#shippingobject
$paymentCart->setShipping(500, 25, 40);
// see: https://onpay.io/docs/technical/api_v1.html#handlingobject
$paymentCart->setHandling(500, 25);
$paymentCart->setDiscount(25);
// see: https://onpay.io/docs/technical/api_v1.html#itemobject
$cartItem1 = new OnPay\API\PaymentWindow\CartItem('item1 name', 250, 1, 12, 'item1 description', 'item1 sku');
$cartItem2 = new OnPay\API\PaymentWindow\CartItem('item2 name', 250, 1, 12, 'item2 description', 'item2 sku');
$paymentCart->setItems([$cartItem1, $cartItem2]);
// Assign the cart to the window
$paymentWindow->setCart($paymentCart);
// Finally - submit the payment request via the api
$paymentService = new OnPay\API\PaymentService($onPayAPI);
$paymentResult = $paymentService->createNewPayment($paymentWindow);
}<?php
if($onPayAPI->isAuthorized()) {
// Get list of transactions
$onPayAPI->transaction()->getTransactions()->transactions;
// Get the pagination object
$onPayAPI->transaction()->getTransactions()->pagination;
// Get specific transaction
$onPayAPI->transaction()->getTransaction("00000000-0000-0000-0000-000000000000");
// Capture transaction
$onPayAPI->transaction()->captureTransaction("00000000-0000-0000-0000-000000000000");
// Cancel transaction
$onPayAPI->transaction()->cancelTransaction("00000000-0000-0000-0000-000000000000");
}<?php
if($onPayAPI->isAuthorized()) {
// Get list of subscriptions
$onPayAPI->subscription()->getSubscriptions()->subscriptions;
// Get the pagination object
$onPayAPI->subscription()->getSubscriptions()->pagination;
// Get details about a specific subscription
$onPayAPI->subscription()->getSubscription("00000000-0000-0000-0000-000000000000");
// Create transaction from subscription
$onPayAPI->subscription()->createTransactionFromSubscription("00000000-0000-0000-0000-000000000000", 100, "orderId");
}