New transaction

post

https://spay.payments.wpay.com.au/v1/transaction

This endpoint is used to create new financial transactions.

Supported transaction types:

Purchase
Pre-authorisation
Capture
Refund
Cashout

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Transaction Request

transactionType

string

enum

required

Type of message request.

The table below lists the supported transaction types

Transaction Type	Description
PREAUTH	Perform a card authorisation request
CAPTURE	Complete the capture of a previous successful card authorisation
PURCHASE	Perform a purchase request
REFUND	Perform a new refund request
CASHOUT	Perform a new cashout only transaction request

Allowed:

createdDateTime

date-time

required

length between 24 and 24

It should always be the local date and time stamp when the transaction was initiated. This should be in 24 hrs format.

auditNumber

string

required

length between 6 and 6

System trace audit number. Unique number assigned to identify a transaction at a given terminal. It should remain unchanged throughout the life of a transaction. It should be between"000001-999999"

channel

string

enum

required

Sale channel "ONLINE" or "INSTORE". Use ONLINE for all card not present transactions and INSTORE for all card present transactions. This value must be "INSTORE" for Transaction Type CASHOUT

Allowed:

acquirerId

string

required

length between 8 and 8

ID of the acqurier

transmissionDateTime

date-time

required

length between 24 and 24

Date and time stamp of the transaction when initiated for transmission. GMT time zone is recommended. Trailing Character Z to be passed if date-time is sent in GMT

conditionCode

string

enum

required

The 2-digit Point of Service (POS) condition code identifies how a transaction is presented to the terminal. The only values supported are:

Values	Description
08	Moto order
15	Customer Terminal, or OEM (except refund)
48	Electronic Commerce, scheme token or OEM(refund only)
42	Electronic Payment terminal or standalone application

Allowed:

referenceNumber

string

required

length between 12 and 12

This field will be present in all Financial Request messages from Webpay. It remains unchanged for all messages throughout the life of a transaction (except refund transaction), for example, PURCHASE -> RESPONSE -> CANCEL-> RESPONSE all have the same Retrieval Reference Number (RRN). In refund transaction, use system trace audit number (or STAN) to populate this field. Above logic can be overridden when retrieval reference number is provided from the request. The receipt number is right justified and left zero filled within this field. It is expected the content of this field should follow the following (ydddhhnnnnnn. • yddd (positions 1-4) is the year and day of year, y=0-9,ddd=001-366 • hh (position 5-6) is the hours value. • nnnnn (position 7-12) is the value from auditNumber.

settlementDate

string

required

length between 4 and 4

Mandatory for all requests. It contains the acquierer's business (settlement) date which is in "MMDD" format.

terminalId

string

required

length ≤ 16

ID of Pinpad Terminal

keySerialNumber

string

length between 26 and 26

AES DUKPT Key Serial Number

fallBackEntry

string

enum

Electronic Fallback Entry Indicator is used in PURCHASE and REFUND requests via Store and Forward (SAF) transactions only. Setting this field to a non-null value enables SAF functionality. SAF transactions must also have a non-null value in the capture.captureRetry field.

Values	Description
E	The Fallback transaction was automatically generated by the pinpad.
V	The Fallback transaction was generated due to a completion from the POS.
A	Manually entered Card number via VAE (Voucher Authorisation Entry)

Allowed:

terminalCapabilityCode

string

enum

Terminal Capability Code. One of the following values:-

Values	Description
00	Unknown
01	Magenetic stripe reader
03	Magnetic stripe and Contact ICC reader
04	Contactless ICC reader
05	Magnetic stripe, Contactless ICC readers
06	Contact and Contactless ICC readers
07	Magnetic stripe, Contact and Contactless ICC readers

Allowed:

terminalClassificationCode

string

enum

mPOS terminal classification code representing the type of the mPOS terminal. One of the following values:-

Values	Description
AC	Mobile point-of-sale (mPOS) accessory/dongle with contact and contactless interfaces, with or without PIN pad
AS	mPOS accessory/dongle with contact and contactless interfaces and PIN on glass support (Software-based PIN on commercial of the shelf (COTS))
CC	Contactless payment on COTS (CPoC) - mobile device based contactless only mPOS without PIN support
CS	CPoC - mobile device based contactless only mPOS with PIN on glass support.

Allowed:

paymentHistory

string

enum

Required for card not present transactions. One of the following:-

Values	Description
0	Unknown
1	Telephone Order
2	Mail Order
3	Internet Order Subsequent
4	Internet Order First

Allowed:

paymentType

string

enum

Required for card not present transactions. One of the following:-

Values	Description
1	Single Transaction
2	Fixed Frequency Recurring Transaction
3	Instalment Payment
4	Post purchase adjustment
5	Deferred payment

Allowed:

securityLevelIndicator

string

enum

This indicator is mandatory where the ECM tag value starts with ‘3’ or ‘4’, otherwise this tag shall not be present. The Security Level Indicator is used with the electronic Commerce indicator. It identifies the leve of security used over an open network (e.g. the Internet). One of the following:-

Values	Description
00	Not Applicable
01 -04	Reserved for future use
05	Authenticated secure electronic commerce transaction
06	No-authenticated secure electronic Commerce transaction where merchant is certified to perform authentication
07	Authenticated secure electronic commerce transaction where authentication cannot be performed. Other security mechanisms may be present e.g. channel encryption
08	Non-secure transaction in the clear over an open network

merchantChoiceRouting

boolean

Merchant Choice Routing should be 'true' if routing is performed by the merchant. It is required by EFTPOS to indicate that a transaction has been diverted form its normal route by the merchant/partner's choice routing mechanism

walletType

string

enum

walletType is included on request messages involving a wallet provider. One of the following:

Values	Description
AP	Apple Pay
NP	Android Pay
SP	Samsung Pay
MR	MasterPass Remote
VC	Visa Checkout
VO	Visa COF token
MD	MDES merchant wallet program
AX	Amex

walletSecurity

string

enum

Required when walletType is present and the transaction is eCommerce originated. One of the following:

Values	Description
0	Filler
1	Commerce/3D Secure
2	Processed through MasterPass
4	Digital Secure Remote Payment (DSRP) with Card Authentication data

Allowed:

walletAuthentication

string

enum

Required when walletType is present and the transaction is eCommerce originated. One of the following:

Values	Description
0	Cardholder authentication is not supported by the merchant or merchant has chosen not to undertake 3D Secure on this transaction.
1	Cardholder authentication is supported by the merchant, and attempted authentication data is present.
2	Cardholder authentication is supported by the merchant, and full authentication data is present.
3	Cardholder authentication is supported by the merchant, and Static Accountholder Authentication Value data is present.
6	Merchant Risk Based decision
7	Partial shipment or recurring payment. Liability will depend on the original authentication values provided and matching with the initial transaction.

Allowed:

merchantInitiatedTransaction

string

enum

Merchant Initiated Transacton (MIT) is used by the merchant to indicate to the acquirer the reason for the merchant to initiate the transaction. It will specify the type of industry practice or standing instruction that triggered the transaction. One of the following values:

Values	Description
01	Re-authorisation
02	Unscheduled
03	Recurring
04	Instalment
05	Re-submission
06	Delayed
07	No Show

Allowed:

programProtocol

string

enum

This element indicates the Program Protocol for eCommerce 3DS transactions. If this is passed as 2.2.0 then its version is identified as version 2 and if it is not passed in the request then it is identified as version 1 in the switch.

Allowed:

paymentTokenData

string

length ≤ 999

Applicable to EFTPOS debit accounts. The payment token data are used to transmit information that is specific to the use of a Payment token in a financial or non-financial transaction. It is formed as a serie of TLV (Tag, Length, value) individual data objects where: T = 3-digit numeric encoded as 3 ASCII digits L = 3-digit length (represented as number of bytes) of following variable value (exclusive of the tag ID and length indicators) encoded as 3 ASCII digits V = variable value. Tags may be present in any order.

capture

object

card

object

merchant

object

amount

object

schemeExtendedData

object

This element is used to provide additional data about the transaction. This element is optional and can be used to provide additional information about the transaction.

deviceCoordinates

object

Headers

X-Authorization

string

required

Mac of the payload

X-Authorization-Timestamp

string

required

If this value differs by more than 900 seconds (15 minutes) from the time of the server, the request will be rejected.

X-Authorization-Content-SHA256

string

required

The base64 encoded SHA-256 hash value used to generate the signature base string. This is analogous to the standard Content-MD5 header. Required for any request where Content-Length is not 0 (for example, a POST request with a body).

Responses

200The transaction has been created. Refer to the response body for the transaction outcome.

400The request was invalid.

500An internal server error occurred.