devture/omnipay-econtext

Econtext (http://www.econtext.jp/) driver for the Omnipay PHP payment processing library

Omnipay: Econtext

Econtext driver for the Omnipay PHP payment processing library, _(*1)

Omnipay is a framework agnostic, multi-gateway payment processing library for PHP 5.3+. This package implements Econtext support for Omnipay., _(*2)

Preface

This driver is still in early development. Do not use in production (yet)., _(*3)

Installation

Omnipay is installed via Composer. To install, simply add it to your composer.json file:, _(*4)

{
    "require": {
        "devture/omnipay-econtext": "@dev"
    }
}

And run composer to update your dependencies:, _(*5)

$ curl -s http://getcomposer.org/installer | php
$ php composer.phar update

Basic Usage

The following gateways are provided by this package:, _(*6)

• Econtext_Merchant (Econtext Merchant API)

For general usage instructions, please see the main Omnipay repository., _(*7)

Initializing the gateway

$gateway = \Omnipay\Omnipay::create('Econtext_Merchant');
$gateway->initialize(array(
    'siteId' => 'Econtext-provided shopId',
    'siteCheckCode' => 'Econtext-provided chkCode',
    'testMode' => true, //or set to true for production
));

Create a Card (stores it on the Econtext server)

$creditCard = new \Omnipay\Common\CreditCard(array(
    'firstName' => '寛',
    'lastName' => '山田',
    'number' => '4980111111111111',
    'cvv' => '123',
    'expiryMonth' => '1',
    'expiryYear' => '2017',
    'email' => 'testcard@example.com',
));

$transaction = $gateway->createCard(array('card' => $creditCard));

//Don't forget to catch some exceptions here
$transactionResponse = $transaction->send();

var_dump($transactionResponse->isSuccessful());
var_dump($transactionResponse->getCardReference());

Retrieve a stored (partial) Card from the Econtext server

$cardReference = 'from createCard / $transactionResponse->getCardReference()';
$transaction = $gateway->retrieveCard(array('cardReference' => $cardReference));

//Don't forget to catch some exceptions here
$transactionResponse = $transaction->send();

var_dump($transactionResponse->isSuccessful());

//You don't really have the full credit card information.
//Pretty much just the last 4 digits of the number are exposed to you.
var_dump($transactionResponse->getCard()->getNumberLast4());

Delete a Card stored on the Econtext server

$cardReference = 'from createCard / $transactionResponse->getCardReference()';
$transaction = $gateway->deleteCard(array('cardReference' => $cardReference));

//Don't forget to catch some exceptions here
//Idempotent - feel free to delete as many times as you wish!
$transactionResponse = $transaction->send();

var_dump($transactionResponse->isSuccessful());

Purchase using an inline-provided Card

$creditCard = new \Omnipay\Common\CreditCard(array(
    'firstName' => '寛',
    'lastName' => '山田',
    'number' => '4980111111111111',
    'cvv' => '123',
    'expiryMonth' => '1',
    'expiryYear' => '2017',
    'email' => 'testcard@example.com',
));

$transaction = $gateway->purchase(array(
    'card' => $creditCard,
    'amount' => 500,
    'description' => 'Noodles',
));

//Don't forget to catch some exceptions here
$transactionResponse = $transaction->send();

var_dump($transactionResponse->isSuccessful());

//Keep your transaction reference if you want to perform refunds later
var_dump($transactionResponse->getTransactionReference());

//As a side-effect, the card gets stored on the Econtext server for you.
var_dump($transactionResponse->getCardReference());

Purchase using a previously stored Card

$cardReference = 'from createCard / $transactionResponse->getCardReference()';

$transaction = $gateway->purchase(array(
    'cardReference' => $cardReference,
    'amount' => 500,
    'description' => 'Noodles',
));

//Don't forget to catch some exceptions here
$transactionResponse = $transaction->send();

var_dump($transactionResponse->isSuccessful());

//Keep your transaction reference if you want to perform refunds later
var_dump($transactionResponse->getTransactionReference());

Purchase in a safe/idempotent way

$transactionReference = 'your-custom-transaction-reference';
//You can also easily generate safe/random ones like this:
//$transactionReference = $gateway->purchase()->getTransactionReference();

$transaction = $gateway->purchase(array(
    'transactionReference' => $transactionReference,
    'cardReference' => $cardReference,
    'amount' => 500,
    'description' => 'Noodles',
));

//Don't forget to catch other potential exceptions below
try {
    $transactionResponse = $transaction->send();
} catch (\Omnipay\Econtext\Exception\BadTransactionReferenceException $e) {
    //The transactionReference you've provided is either a bad one,
    //or this transaction had already been processed.
    //Unfortunately, we don't know which, but if you're using references
    //generated by this library, it's safe to say this is indeed a duplicate.
}

var_dump($transactionResponse->isSuccessful());

Refund a purchase

$transactionReference = 'from purchase / $transactionResponse->getTransactionReference()';

$transaction = $gateway->refund(array(
    'transactionReference' => $transactionReference,
));

//Don't forget to catch some exceptions here
//NOT idempotent - subsequent refund() calls will fail
$transactionResponse = $transaction->send();

var_dump($transactionResponse->isSuccessful());

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., _(*8)

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., _(*9)

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., _(*10)