...
This is a simple guide in how to integrate your website with the Blink gateway so that you can accept payments straight from your website. If you require a more advanced integration, please contact our integrations team Integrations Team.
Integration Types
Hosted
The request is made using the urlURL: https://gateway2.blinkpayment.co.uk/hosted, with the merchant credentials (MID and signature key), amount, reference and customer details.
When initiated, the hosted integration will redirect the customer from the merchant site to the Blink Gateway , where the customer fills in their card details and pays.
Once the customer has completed the payment, they can redirected be redirected back to the merchant site, the response fields can be collected on the merchant website.
Info |
---|
For a smoother experience, use https://gateway2.blinkpayment.co.uk/hosted/modal as the url URL and implement the light box method, which will open the gateway in an iframe overlaid on the site, rather then redirecting to a different address. |
Benefits
Easy Set Upset up
Secure (Payment life cycle journey is handled completely by Blink servers)
Disadvantages
Multiple redirects Redirects - Customer has to leave merchant site (using the lightbox overlay mitigates this issue).
Customisation is difficult (can be done using Hosted Payment Fields SDK)
Direct
.
Note |
---|
The I.P IP address of the merchant site must be white-listed whitelisted by Blink. The merchant Site site must have a valid SSL (for 3ds 3DS transactions). |
The request is made using the urlURL: https://gateway2.blinkpayment.co.uk/direct. It is made directly from the merchant site. All payment details (including card details) must be sent in one request.
...
More venerable to security issues/ attacks.
Set up is more complicated as it requires IP whitelisting and implementing 3ds 3DS checking code.
Request
Required Fields
Field Name | Description | |
---|---|---|
1 | Merchant ID | Your Merchant Gateway ID (Can be found on Take a Payment and Request a Payment) |
2 | signature | Unique key related to your merchant ID, the signature key is encrypted before the request is sent. Please contact our support team to find out your signature key. |
3 | action | The Action requested. Typically, it is SALE |
4 | amount | The Transaction Amount of the transaction |
5 | type | 1 - E-commerce (ECOM) - standard online payments. 2 - Mail Order Telephone Order (MOTO) - the merchant is inputting the card details. 9 - Continuous Authority (CA) - for recurring and rerunning transactions. |
6 | countryCode | Merchant’s Location (for UK 826) |
7 | currencyCode | Transaction currency code (for UK 826) |
8 | cardNumber | The primary account number (PAN) as printed on the front of the payment card. Digits and spaces only - Direct Integration Only |
9 | cardExpiryMonth | The card’s expiry month from 1 to 12. - Direct Integration Only |
10 | cardExpiryYear | The card’s expiry year from 00 to 99. - Direct Integration Only |
11 | cardCVV | Payment card’s security number. The 3 -or 4 digit number printed on the signature strip. - Direct Integration Only |
...
Field Name | Description | |
---|---|---|
1 | transactionUnique | You can supply a unique identifier for this transaction. This is an added security feature to combat transaction spoofing. |
2 | customerName | Name of Customer |
3 | customerEmail | Email Address of customer |
4 | customerAddress | Address of customer - may be required depending on AVS checks |
5 | customerPostCode | Post code of customer - may be required depending on AVS checks |
6 | orderRef | Free format text field to store order details, reference numbers, etc. for the Merchant’s records. Essentially, an additional identifier. |
7 | redirectURL | URL to which the hosted form will redirect the Customer’s browser after the transaction has been completed. The URL must be fully qualified and include at least the scheme and host components. (Only relevant to Hosted integration) |
...
Field Name | Description | |
---|---|---|
1 | orderDate | Record Date Recorded date of the transaction |
2 | xref | Refers to a pervious transaction, this is used to rerun or refund previous transactions. |
3 | captureDelay | Number of days to wait between authorisation of a payment and subsequent settlement. |
4 | merchantPwd | Additional password to increase authentication security. |
...
Field Name | Always Returned? | Description |
---|---|---|
respnseCode | Yes | A numeric code providing the specific outcome. Common values are: 0 - Successful / authorised transaction. 1 - Card referred – Refer to card issuer. 2 - Card referred – Special condition. 4 - Card declined – Keep card. 5 - Card declined |
responseStatus | Yes | A numeric code providing the outcome category. Possible values are: 0 – Authorisation Approved / No reason to decline 1 – Authorisation Declined. 2 – Authorisation Error / Transaction malformed. |
responseMessage | Yes | Message received from the Acquiring bank, or any error message. |
transactionID | Yes | A unique ID assigned by the Gateway. |
acquirerResponseXXXX | Depends on the acquirer | Additional Response sent by acquirer |
xref | Yes | Used to rerun or refund transactions at a later point. |
state | Yes | Transaction state |
timestamp | Yes | The time when the transaction was last modified |
cardNumberMask | Yes | Masked card number |
transactionUnique | If sent in request | Any value supplied in the initial request. |
orderRef | If sent in request | Any value supplied in the initial request. |
authorisationCode | If transaction was successful | Authorisation code (Auth Code) received from Acquirer. |
amountReceived | If transaction was successful | Amount the Acquirer authorised. This should always be the full amount in the request. |
cardTypeCode | Yes | Code identifying the type of card used. |
cardType | Yes | Description of the type of card used. |
cardSchemeCode | Yes | Code identifying the Card Scheme used. |
cardScheme | Yes | Description of the Card Scheme used. |
cardIssuer | Yes | Card Issues name |
cardIssuerCountry | Yes | Card issuing country’s name |
cardIssuerCountryCode | Yes | Card issuing country’s ISO-3166 2-letter code |
amountRefunded | On If it is a refund | Total amount of original SALE that has so far been refunded. Returned when action is REFUND_SALE |
...
Code Block | ||||
---|---|---|---|---|
| ||||
<?PHP //Merchant ID $merchantID = '' // Merchant Signature key, $key = ''; // Gateway URL $url = 'https://gateway2.blinkpayment.co.uk/hosted/modal'; if (!isset($_POST['responseCode'])) { // Send request to gateway // Request $req = array( 'merchantID' => $merchantID, 'action' => 'SALE', 'type' => 1, 'countryCode' => 826, 'currencyCode' => 826, 'amount' => 1001, 'orderRef' => 'Test purchase', 'transactionUnique' => uniqid(), 'redirectURL' => ($_SERVER['HTTPS'] == 'on' ? 'https' : 'http') . '://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], ); // Create the signature using the function called below. $req['signature'] = createSignature($req, $key); echo '<form action="' . htmlentities($url) . '" method="post">' . PHP_EOL; foreach ($req as $field => $value) { echo ' <input type="hidden" name="' . $field . '" value="' . htmlentities($value) . '">' . PHP_EOL; } echo ' <input type="submit" value="Pay Now">' . PHP_EOL; echo '</form>' . PHP_EOL; // Check the return signature if (!$signature || $signature !== createSignature($res, $key)) { // You should exit gracefully die('Sorry, the signature check failed'); } // Check the response code if ($res['responseCode'] === "0") { echo "<p>Thank you for your payment.</p>"; } else { echo "<p>Failed to take payment: " . htmlentities($res['responseMessage']) . "</p>"; } } // Function to create a message signature function createSignature(array $data, $key) { // Sort by field name ksort($data); // Create the URL encoded signature string $ret = http_build_query($data, '', '&'); // Normalise all line endings (CRNL|NLCR|NL|CR) to just NL (%0A) $ret = str_replace(array('%0D%0A', '%0A%0D', '%0D'), '%0A', $ret); // Hash the signature string and the key together return hash('SHA512', $ret . $key); } ?> |
Direct Integration (with
...
3DS)
Code Block | ||||
---|---|---|---|---|
| ||||
<?PHP // Merchant ID $merchantID = ''; // Signature key entered on MMS. The demo account is fixed to this value, $key = '61275c33b2d1f'; // Gateway URL $url = 'https://gateway2.blinkpayment.co.uk/direct/'; // Setup PHP session as use it to store data between 3DS steps if (isset($_GET['sid'])) { session_id($_GET['sid']); } session_start(); // Compose current page URL (removing any sid and acs parameters) $pageUrl$pageURL = ((isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https://' : 'http://') . $_SERVER['SERVER_NAME'] . ($_SERVER['SERVER_PORT'] != '80' ? ':' . $_SERVER['SERVER_PORT'] : '') . preg_replace('/(sid=[^&]+&?)|(acs=1&?)/', '', $_SERVER['REQUEST_URI']); // Add back the correct sid parameter (used as session cookie may not be passed when the page is redirected from an IFRAME) $pageUrl$pageURL .= (strpos($pageUrl$pageURL, '?') === false ? '?' : '&') . 'sid=' . urlencodeURLencode(session_id()); // If ACS response into the IFRAME then redirect back to parent window if (!empty($_GET['acs'])) { echo silentPost($pageUrl$pageURL, array('threeDSResponse' => $_POST), '_parent'); exit(); } if (!isset($_POST['threeDSResponse'])) { // Initial request // Gather browser info - can be done at any time prior to the checkout if (!isset($_POST['browserInfo'])) { echo collectBrowserInfo(); exit(); } // Direct Request $req = array( 'merchantID' => $merchantID, 'action' => 'SALE', 'type' => 1, 'currencyCode' => 826, 'countryCode' => 826, 'amount' => 901, 'cardNumber' => '4543059999999990', 'cardExpiryMonth' => 12, 'cardExpiryYear' => 22, 'cardCVV' => '689', 'customerName' => 'Test Customer', 'customerEmail' => 'test@testcustomer.com', 'customerAddress' => '16 Test Street', 'customerPostCode' => 'Tef 5ST', 'orderRef' => '3ds3DS tesrt purchase', // The following fields are mandatory for 3DS v2 'remoteAddress' => $_SERVER['REMOTE_ADDR'], 'threeDSRedirectURL' => $pageUrl$pageURL . '&acs=1', // The following field allows options to be passed for 3DS v2 // and the values here are for demonstration purposes only 'threeDSOptions' => array( 'paymentAccountAge' => '20190601', 'paymentAccountAgeIndicator' => '05', ), ); // Add the browser info as it is mandatory for 3DS v2 $req += $_POST['browserInfo']; } else { // 3DS continuation request $req = array( 'threeDSRef' => $_SESSION['threeDSRef'], 'threeDSResponse' => $_POST['threeDSResponse'], ); } // Create the signature using the function called below. $req['signature'] = createSignature($req, $key); // Initiate and set curlcURL options to post to the gateway $ch = curlcURL_init($url); curlcURL_setopt($ch, CURLOPT_POST, true); curlcURL_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($req)); curlcURL_setopt($ch, CURLOPT_HEADER, false); curlcURL_setopt($ch, CURLOPT_FOLLOWLOCATION, true); curlcURL_setopt($ch, CURLOPT_RETURNTRANSFER, true); // Send the request and parse the response if (($res = curlcURL_exec($ch)) === false) { // You should exit gracefully die('Sorry, the request could not be sent: ' . curlcURL_error($ch)); } parse_str($res, $res); // Close the connection to the gateway curlcURL_close($ch); // Extract the return signature as this isn't hashed $signature = null; if (isset($res['signature'])) { $signature = $res['signature']; unset($res['signature']); } // Check the return signature if (!$signature || $signature !== createSignature($res, $key)) { // You should exit gracefully die('Sorry, the signature check failed'); } // Check the response code if ((int)$res['responseCode'] === 65802) { // Send request to the ACS server displaying response in an IFRAME // Render an IFRAME to show the ACS challenge (hidden for fingerprint method) $style = (isset($res['threeDSRequest']['threeDSMethodData']) ? 'display: none;' : ''); echo "<iframe name=\"threeds_acs\" style=\"height:420px; width:420px; {$style}\"></iframe>\n"; // Silently POST the 3DS request to the ACS in the IFRAME echo silentPost($res['threeDSURL'], $res['threeDSRequest'], 'threeds_acs'); // Remember the threeDSRef as need it when the ACS responds $_SESSION['threeDSRef'] = $res['threeDSRef']; } else if ((int)$res['responseCode'] === 0) { echo "<p>Thank you for your payment.</p>"; } else { echo $res['responseCode']; echo "<p>Failed to take payment: :( " . htmlentities($res['responseMessage']) . "</p>"; } // Function to create a message signature function createSignature(array $data, $key) { // Sort by field name ksort($data); // Create the URL encoded signature string $ret = http_build_query($data, '', '&'); // Normalise all line endings (CRNL|NLCR|NL|CR) to just NL (%0A) $ret = str_replace(array('%0D%0A', '%0A%0D', '%0D'), '%0A', $ret); // Hash the signature string and the key together return hash('SHA512', $ret . $key); } // Return HTML to render a hidden form used to collect some browser details function collectBrowserInfo(array $options = null) { $form_attrs = 'id="collectBrowserInfo" method="post" action="?"'; if (isset($options['formAttrs'])) { $form_attrs .= $options['formAttrs']; } $device_data = array( 'deviceChannel' => 'browser', 'deviceIdentity' => (isset($_SERVER['HTTP_USER_AGENT']) ? htmlentities($_SERVER['HTTP_USER_AGENT']) : null), 'deviceTimeZone' => '0', 'deviceCapabilities' => '', 'deviceScreenResolution' => '1x1x1', 'deviceAcceptContent' => (isset($_SERVER['HTTP_ACCEPT']) ? htmlentities($_SERVER['HTTP_ACCEPT']): null), 'deviceAcceptEncoding' => (isset($_SERVER['HTTP_ACCEPT_ENCODING']) ? htmlentities($_SERVER['HTTP_ACCEPT_ENCODING']) : null), 'deviceAcceptLanguage' => (isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? htmlentities($_SERVER['HTTP_ACCEPT_LANGUAGE']) : null), 'deviceAcceptCharset' => (isset($_SERVER['HTTP_ACCEPT_CHARSET']) ? htmlentities($_SERVER['HTTP_ACCEPT_CHARSET']) : null), ); $form_fields = fieldToHtml('browserInfo', $device_data); if (isset($options['formData'])) { foreach ((array)$options['formData'] as $name => $value) { $form_fields .= fieldToHtml($name, $value); } } $ret = <<<EOS <form {$form_attrs}> {$form_fields} </form> <script> var screen_width = (window && window.screen ? window.screen.width : '0'); var screen_height = (window && window.screen ? window.screen.height : '0'); var screen_depth = (window && window.screen ? window.screen.colorDepth : '0'); var identity = (window && window.navigator ? window.navigator.userAgent : ''); var language = (window && window.navigator ? (window.navigator.language ? window.navigator.language : window.navigator.browserLanguage) : ''); var timezone = (new Date()).getTimezoneOffset(); var java = (window && window.navigator ? navigator.javaEnabled() : false); var fields = document.forms.collectBrowserInfo.elements; fields['browserInfo[deviceIdentity]'].value = identity; fields['browserInfo[deviceTimeZone]'].value = timezone; fields['browserInfo[deviceCapabilities]'].value = 'javascript' + (java ? ',java' : ''); fields['browserInfo[deviceAcceptLanguage]'].value = language; fields['browserInfo[deviceScreenResolution]'].value = screen_width + 'x' + screen_height + 'x' + screen_depth; window.setTimeout('document.forms.collectBrowserInfo.submit()', 0); </script> EOS; return $ret; } // Render HTML to silently POST data to URL in target brower window function silentPost($url = '?', array $post = null, $target = '_self') { $url = htmlentities($url); $target = htmlentities($target); $fields = ''; if ($post) { foreach ($post as $name => $value) { $fields .= fieldToHtml($name, $value); } } $ret = " <form id=\"silentPost\" action=\"{$url}\" method=\"post\" target=\"{$target}\"> {$fields} <noscript><input type=\"submit\" value=\"Continue\"></noscript> </form> <script> window.setTimeout('document.forms.silentPost.submit()', 0); </script> "; return $ret; } // Return a value as hidden HTML FORM fields function fieldToHtml($name, $value) { $ret = ''; if (is_array($value)) { foreach ($value as $n => $v) { $ret .= fieldToHtml($name . '[' . $n . ']', $v); } } else { // Convert all applicable characters or none printable characters to HTML entities if(!$value) $value = " "; $value = preg_replace_callback('/[\x00-\x1f]/', function($matches) { return '&#' . ord($matches[0]) .';'; }, htmlentities($value, ENT_COMPAT, 'UTF-8', true)); $ret = "<input type=\"hidden\" name=\"{$name}\" value=\"{$value}\" />\n"; } return $ret; } ?> |
...