internetrix/silverstripe-payment-eway

A forked silverstripe payment module for eway

SilverStripe Payment Eway Module

Work in progress, some changes to the API still to come, _(*1)

Maintainer Contacts

• Frank Mullenger

Requirements

• SilverStripe 3.0.x
• Payment module 1.0.x

Documentation

Paystation integration for payment module. This module currently supports Rapid 3.0 processing only. The Rapid 3.0 API works by using a form hosted on the merchants website to capture the credit card details, this form is posted directly to eWay., _(*2)

Developer documentation

How to get started with the Rapid 3.0 API.
Rapid 3.0 API documentation.
Gateway response codes.
How to trigger response codes from the gateway using cents values., _(*3)

Installation Instructions

1. Place this directory in the root of your SilverStripe installation and call it 'payment-eway'.
2. Visit yoursite.com/dev/build?flush=1 to rebuild the database.

Note: Because the credit card details are entered by the customer on a page residing on your website (and not a page on the gateway) ensure you have an SSL/TLS cert installed for security., _(*4)

Usage Overview

Enable in your application YAML config (e.g: mysite/_config/payment.yaml):, _(*5)

PaymentGateway:
  environment:
    'dev'

PaymentProcessor:
  supported_methods:
    dev:
      - 'EwayRapid'
    live:
      - 'EwayRapid'

Configure using your Eway account details in the same file:, _(*6)

RapidGateway:
  live:
    # User credentials
    Payment.Username: ""
    Payment.Password: ""

    #Method Options: SOAP,POST,REST,RPC
    "Request:Method": 'SOAP'

    #Format Options: JSON, XML
    "Request:Format": 'JSON'
  dev:
    # User credentials
    Payment.Username: ""
    Payment.Password: ""

    #Method Options: SOAP,POST,REST,RPC
    "Request:Method": 'SOAP'

    #Format Options: JSON, XML
    "Request:Format": 'JSON'

    # Set to 1 to see the response objects for CreateAccessCode & GetAccessCodeResult
    # Also, it is able to see the raw response/request messages in either JSON or XML format being sent to the RapidAPI End Point.
    ShowDebugInfo: 0

By default the gateway class can accept NZD or AUD (see RapidGateway::$supportedCurrencies). Usually your Eway account will be for a single currency that matches your merchant account. To specify this currency as the single acceptable currency alter the YAML config file e.g: a configuration that will only process payments in Australian dollars:, _(*7)

RapidGateway:
  live:
    # User credentials
    Payment.Username: ""
    Payment.Password: ""

    #Method Options: SOAP,POST,REST,RPC
    "Request:Method": 'SOAP'

    #Format Options: JSON, XML
    "Request:Format": 'JSON'

    # Set supported currency
    supported_currencies:
      'AUD' : 'Australian Dollar'
  dev:
    # User credentials
    Payment.Username: ""
    Payment.Password: ""

    #Method Options: SOAP,POST,REST,RPC
    "Request:Method": 'SOAP'

    #Format Options: JSON, XML
    "Request:Format": 'JSON'

    # Set supported currency
    supported_currencies:
      'AUD' : 'Australian Dollar'

Note: Remember to ?flush=1 after changes to the config YAML files., _(*8)

TODO

• Translation support
• Unit tests
• Capture customer and order information and pass to the gateway
• Test error responses in RapidGateway::process()