User Guide

For detail of settings, see installation notes.

The default configuration helps you manage orders according to how confident you can be in getting your money. 
Where card payments are flagged for futher checking, this is indicated by the order's status.
Where there is a clearance period during which the payment could be cancelled by the payer's bank, this is shown with another status.

Technical Guide

Authentication / Authorization Paradigm

1. Basic authentication with an API key as user in the header.
2. Two types of key - Publishable for use from the browser and Secret for full API access from server

Trusted Frame Flow

1. Web page uses payway.js with publishable key to create a Payway iframe for card details or bank account details
2. iframe sends card details securely to Payway and returns a single use token to the form
3. site uses single use token to take card payment or create customer in vault (for bank debits or quicker future card payments)

Reponse codes for card transactions
https://www.payway.com.au/docs/credit-card-response-codes.html
accepted payments
00 Approved or completed successfully (valid card number, not reported stolen, sufficient funds)
08 Honour with identification (valid card number, not reported stolen, sufficient funds)
declined or errors
01 Refer to card issuer (suspected fraud, insufficient funds, stolen, expired, invalid CVN, not for merchant business type)
03 Invalid merchant (problem with merchant account setup or card type not accepted)
04 Pickup card (card reported stolen, you're supposed to keep it)
05 Do not honour (generic error from issuer - suspected fraud, insufficient funds, stolen, expired, invalid cvn etc)
12 Invalid transaction
14 Invalid card number (no such number)
17 Customer cancellation
22 Suspected malfunction
34 Suspected fraud
etc...

Response codes for bank debit attempts
G "WBC Exception Processing released successfully" - means it worked
2 Payment Stopped
3 Account Closed
5 No Account/Incorrect Account
6 Refer to Customer Contact
9 Other
 

Installation

Unzip and copy

Unzip the files and copy to the shop.

On Phoenix versions below 1.0.7.14 also copy the ht module in the extras folder which fixes an annoying usability 
feature of clearing all the radio buttons on the payments page when choosing a payment module.

Install and set up

Install the payment module (via admin / modules / payment > Install)

From Payway

Log into your Payway account and go to the settings page. 
In the PayWay Modules section, check you have the modules you need: PayWay Net for one-off card payments, PayWay Recurring Billing and Customer Vault if you want to accept bank transfers and let people store a card for future purchases. Fraud Guard helps give confidence in the validity of payments.
In the Banking section, look under merchants. TEST is used for test transactions and your live merchant ID is for live transactions. Copy one of them to your module.
In the Banking section, under Bank Accounts, check if your settlement account is configured. You won't be able to configure the module to accept bank transfers until there is at least one. If there are none, contact Payway support.
In the Access to Payway section, under REST API Keys, you'll need to create a publishable key and a secret key and copy them to your module.

Remaining payment module settings:

Use Vault - when true, customers are offered the option of saving a payment card for future purchases. This is not effective unless the account content module for Payway card management is installed.
Accept Bank Transfers - when true, customers are offered the option of paying by bank transfer (NB see Clearance in User Guide). Not effective unles Merchant Bank Account configured.
Merchant Bank Account - pulls a choice of merchant accounts configured in your Payway account. If you can't see any, check that account!
Vault Emails - this setting is for compatiblity with membership addons and not used in a standard store.
Set Order Status - the status for orders which are successfully and completely paid.
Check Order Status - the status for orders where the payment is flagged for further checking (some card payments)
Clearing Order Status - the status for orders paid by bank transfer, to remind you to wait until they've cleared
Transaction Order Status - the status for information records about the transaction against the order
Payment Zone - when set, the module is only available to customers in this zone
Proxy Server - if behind a proxy, set this for curl
Debug email address - when set, details of failed transactions are sent here