behzadbabaei/omnipay-revolut

Revolut driver for the Omnipay payment processing library

v2.0.2 2021-09-09 09:07 UTC

Requires

• php: ^7.2|^8
• ext-json: *
• omnipay/common: ^3

Requires (Dev)

• omnipay/tests: ^3

MIT

• Behzad Babaei

• omnipay
• revolut

README

Revolut gateway for Omnipay payment processing library This package has implemtend the MErchant API of Revolut Payment systems For more information please visit the following link:Developer Document

Installation

Omnipay is installed via Composer. To install, simply add it to your composer.json file:

{
    "require": {
        "behzadbabaei/omnipay-revolut": "dev-master"
    }
}

And run composer to update your dependencies:

composer update

Or you can simply run

composer require behzadbabaei/omnipay-revolut

Basic Usage

1. Use Omnipay gateway class:

    use Omnipay\Omnipay;

1. Initialize Revolut gateway:

    $gateway = Omnipay::create('Revolut');
    $gateway->setAccessToken('Access-Token');
    $gateway->setLanguage('EN'); // Language
    $gateway->setAccountId('Merchant-Accounti-Id');
    $gateway->setAmount(31.90); // Amount to charge
    $gateway->setTransactionId(XXXX); // Transaction ID from your system

Creating an order

Call purchase, it will return the response which includes the public_id for further process. Please refer to the Developer Document for more information.

         $purchase = $gateway->purchase();
         $purchase->setAmount(12.12);
         $purchase->setCurrency("USD");
         $purchase->setCaptureMode('AUTOMATIC');
         $purchase->setMerchantOrderReference('123121');
         $purchase->setEmail('[e-mail]');
         $purchase->setDescription('order test');
         $purchase->setSettlementCurrency('GBP');
         $purchase->setCustomerId(1212);
         $result = $purchase->send()->getData();

OR

         $result1 = $gateway->purchase([
              'amount'      => 12.12,
              'currency'    => 'USD',
              'captureMode' => 'AUTOMATIC',
              'merchantOrderReference' => 123121,
              'email' => '[e-mail]',
              'description' => 'order test',
              'settlementCurrency' => 'GBP',
              'customerId' => 1212,
         ])->send()->getData();

Capture an order

Please refer to the Developer Document for more information.

        $capture = $gateway->capture();
        $capture->setAmount(31.90);
        $capture->setOrderId(1);
        $result = $capture->send()->getData();

OR

       $result = $gateway->capture([
            'amount'  => 31.90,
            'orderId' => 1
        ])->send()->getData();

Confirm an order

Please refer to the Developer Document for more information.

        $complete = $gateway->completePurchase();
        $complete->setAmount(31.90);
        $complete->setOrderId(1);
        $complete->setPaymentMethod(12121);
        $result1 = $complete->send()->getData();

OR

        $result = $gateway->completePurchase([
            'orderId'       => 1,
            'paymentMethod' => 1
        ])->send()->getData();

Refund an order

Please refer to the Developer Document for more information.

        $refund = $gateway->refund();
        $refund->setAmount(31.90);
        $refund->setCurrency('USD');
        $refund->setOrderId(1);
        $refund->setMerchantOrderReference(1);
        $refund->setDescription("Test Description");
        $result1 = $refund->send()->getData();

OR

         $result = $gateway->refund([
            'amount'                 => 31.90,
            'currency'               => 'USD',
            'orderId'                => 1,
            'merchantOrderReference' => 1000,
            'description'            => 'Test Description',
        ])->send()->getData();

Cancel an order

Please refer to the Developer Document for more information.

        $cancel = $gateway->cancel();
        $cancel->setOrderId(1);
        $result1 = $cancel->send()->getData();

OR

       $result = $gateway->cancel([
            'orderId'                => 1,
        ])->send()->getData();

Retrieve an order

Please refer to the Developer Document for more information.

        $fetch = $gateway->fetchTransaction();
        $fetch->setOrderId(1);
        $result1 = $fetch->send()->getData();

OR

        $result = $gateway->fetchTransaction([
            'orderId'                => 1,
        ])->send()->getData();

For general usage instructions, please see the main Omnipay repository.

Support

If you are having general issues with Omnipay, we suggest posting on Stack Overflow. Be sure to add the omnipay tag so it can be easily found.

If you want to keep up to date with release anouncements, discuss ideas for the project, or ask more detailed questions, there is also a mailing list which you can subscribe to.

If you believe you have found a bug, please report it using the GitHub issue tracker, or better yet, fork the library and submit a pull request.