eurolink/sagepay-form-php

A simple package to integrate SagePay/Opayo Form v3.00 into your website.

v2.0.0 2022-11-14 10:49 UTC

Requires

• php: >=7.4
• phpseclib/mcrypt_compat: ^1.0

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• Eurolink

• php
• sagepay
• Eurolink
• opayo

README

Official Documentation

See SagePay PDF documentation.

Installation

You can install the package via composer:

composer require eurolink/sagepay-form-php

Usage

Outgoing

$sagePay = new \Eurolink\SagePayForm\Builder([
    'isProduction' => FALSE,
    'encryptPassword' => 'XXXXXXXXXXXXXXXX',
    'vendor' => 'ZZZZZZZZZZZZZZZZ',
]);

$sagePay->setVendorTxCode( rand( 0, 32000 ) * rand( 0, 32000 ) );
$sagePay->setCurrency( 'GBP' );
$sagePay->setAmount( 100 );
$sagePay->setDescription('Payment' );
$sagePay->setSendEMail( 1 );
$sagePay->setBillingSurname( 'Smith' );
$sagePay->setBillingFirstnames( 'John' );
$sagePay->setBillingCity( 'London' );
$sagePay->setBillingPostCode( 'LN1 ON' );
$sagePay->setBillingAddress1( '1 An Other Road' );
$sagePay->setCustomerEMail( '[e-mail]' );
$sagePay->setCustomerName( 'John Smith' );
$sagePay->setBillingCountry( 'GB' );
$sagePay->setDeliverySameAsBilling();
$sagePay->setSuccessURL( 'http://example.com/sage?outcome=success' );
$sagePay->setFailureURL( 'http://example.com/sage?outcome=failure' );

<form method="POST" action="<?php echo $sagePay->getFormEndpoint(); ?>">
    <input type="hidden" name="VPSProtocol" value="<?php echo $sagePay->getVPSProtocol(); ?>">
    <input type="hidden" name="TxType" value="<?php echo $sagePay->getTxType(); ?>">
    <input type="hidden" name="Vendor" value="<?php echo $sagePay->getVendorCode(); ?>">
    <input type="hidden" name="Crypt" value="<?php echo $sagePay->getCrypt(); ?>">
    <button type="submit">Pay with SagePay</button>
</form>

Incoming

$sagePay = new \Eurolink\SagePayForm\Builder([
    'isProduction' => FALSE,
    'encryptPassword' => 'XXXXXXXXXXXXXXXX',
    'vendor' => 'ZZZZZZZZZZZZZZZZ',
]);

$sagePay->decode( $_GET['crypt'] );

// has response been successfully decrypted
var_dump( $sagePay->isResponseValid() );

// is response successful?
var_dump( $sagePay->isResponseStatusOK() );

// return the success or error message
var_dump( $sagePay->getResponseStatusMessage() );

// return vendor code (as previously submitted)
var_dump( $sagePay->getResponseVendorCode() );

// return transaction ID
var_dump( $sagePay->getResponseVendorCode() );

// return transaction ID (excluding curly brackets)
var_dump( $sagePay->getResponseTransactionIDFormatted() );

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credit

Credit goes to tolzhabayev for the initial PHP class.

License

The MIT License (MIT). Please see License File for more information.