README

This is the euPago solution for omnipay payment processing library

Eupago is one Portuguese payment gateway that has multiple methods available. For use it you need create one account in euPago website. Once installed and configured you are able to use all the features of our API.

Instalation

For instalation details please check the omnipay git page.

Implemented Payment Methods

Multibanco - Create MB references with and without start/end date, minimum/maximum amount support (just set the respective parameters)
MBWay - MBWay payment system
PayShop
Pagaqui

Future implementations:

Credit Card

Required fields

'apiKey' - to generate your api key please create an account on their website
'currency' - currency is required and must be 'EUR' or '€'
'amount' - Purchase amount
'transactionId' - usually this is the order ID

Examples

Create Multibanco reference

$gateway = Omnipay::create('Eupago_Multibanco');

// required fields
$gateway->setApiKey('xxx-xxx-xxx-xxx');
$gateway->setCurrency('EUR');
$gateway->setTransactionId('xxxxx');
// Optionally with start/end date
$gateway->setStartDate(new \DateTime);
$gateway->setEndDate((new \DateTime)->modify('48 hours'));

$response = $gateway->purchase(['amount' => '10.00'])->send();

if ($response->isSuccessful()) {
	// return the euPago api response with payment credentials
	// see src/Message/MultibancoResponse.php methods for more information
	$paymentData = $response->getData();

	// return the Transaction Reference
	// the transaction Reference is required for call the status of payment, you should store them in your "orders" table related database
	$referenceId = $response->getTransactionReference();
} else {
    // Transaction creation failed: display message to customer
    echo $response->getMessage();
}

Check Multibanco reference status

$gateway = Omnipay::create('Eupago_Multibanco');

// The transaction reference is required
$paymentStatus = $gateway->checkStatus([
	'transactionReference' => 'xxxxxx'
])->send();

if ($paymentStatus->isPaid()) {
    // payment was successful: update database
} else {
    // payment failed: display message to customer
    echo $paymentStatus->getMessage();
}

michelmelo / omnipay-eupago

Maintainers

Details