Woolworths Group Transaction API is one of 18 APIs that Woolworths Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 30 JSON Schema definitions.
Tagged areas include Transaction. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 30 JSON Schemas.
This API exposes
3 operations
across 3 paths,
and defines 64 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://spay.payments.wpay.com.au/v1.
The identity and technical contract details declared by the specification.
AuthorizationResponse
object
15 properties
1 required
CaptureResponse
object
7 properties
1 required
MerchantAdviceCode
string
TransactionOutcome
string
SchemeExtendedResponseData
object
1 property
CnpTransactionDetailResponse
object
19 properties
18 required
MerchantAuthorizationType
string
CardMetaData
object
6 properties
PermittedTransactionOperationHint
string
Hints for transaction operation permitted for the given transaction state
RefundResponse
object
7 properties
1 required
ProblemDetails
object
5 properties
VoidResponse
object
7 properties
1 required
RequestCardDetails
object
13 properties
2 required
DeviceCoordinates
object
latitude and longitude are optional as a set, but if one is provided, the other must also be provided.
2 properties
auditNumber
string
System trace audit number. Unique number assigned to identify a transaction at a given terminal. It should remain unchanged throughout the life of a transactio…
terminalClassificationCode
string
mPOS terminal classification code representing the type of the mPOS terminal. One of the following values:- | Values | Description | | ------ | ---------------…
RequestMerchantDetails
object
8 properties
4 required
paymentTokenData
string
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 n…
ResponseCardDetails
object
4 properties
keySerialNumber
string
AES DUKPT Key Serial Number
transmissionDateTime
string
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…
acquirerId
string
ID of the acqurier
paymentType
string
Required for card not present transactions. One of the following:- | Values | Description | | ---------------- | ----------------------------------------------…
transactionTypeTransact
string
Type of message request. The table below lists the supported transaction types | Transaction Type | Description | | ---------------- | ------------------------…
TransactionRequest
object
30 properties
12 required
settlementDate
string
Optional. It contains the acquirer's business (settlement) date which is in "MMDD" format, where MM is 01-12 and DD is 01-31.
ErrorResponse
object
3 properties
ErrorMessage
object
2 properties
isRetry
boolean
This element indicates if it is a retry of previous cancel request
fallBackEntry
string
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 val…
ResponseOutcome
object
3 properties
ErrorDetails
object
2 properties
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 for…
ResponseAmount
object
2 properties
merchantInitiatedTransaction
string
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 specif…
RequestCaptureDetails
object
3 properties
channel
string
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…
CancelRequest
object
27 properties
14 required
RequestReferencedTransactionIdentifiers
object
This element is used to identify the original transaction which is to be cancelled.
4 properties
3 required
walletType
string
walletType is included on request messages involving a wallet provider. One of the following: | Values | Description | | ------------- | ----------------------…
securityLevelIndicator
string
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…
conditionCode
string
The 2-digit Point of Service (POS) condition code identifies how a transaction is presented to the terminal. The only values supported are: | Values | Descript…
SchemeExtendedRequestData
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 tra…
1 property
referenceNumber
string
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 re…
TransactionResponse
object
15 properties
walletSecurity
string
Required when walletType is present and the transaction is eCommerce originated. One of the following: | Values | Description | | ------------- | -------------…
Address
object
5 properties
5 required
CancelResponse
object
15 properties
paymentHistory
string
Required for card not present transactions. One of the following:- | Values | Description | | ---------------- | ----------------------------------------------…
SchemeExtendedResponseData_2
object
This element is populated with additional scheme related meta data if available.
1 property
ResponseCaptureTransaction
object
2 properties
programProtocol
string
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…
terminalCapabilityCode
string
Terminal Capability Code. One of the following values:- | Values | Description | | ---------------- | -------------------------------------------------| | 00 |…
terminalId
string
ID of Pinpad Terminal
transactionTypeCancel
string
Type of message request. The table below lists the supported transaction types | transactionType | Description | | ---------------- | -------------------------…
createdDateTime
string
It should always be the local date and time stamp when the transaction was initiated. This should be in 24 hrs format.
RequestAmount
object
5 properties
1 required
ResponseMerchantDetails
object
1 property
walletAuthentication
string
Required when walletType is present and the transaction is eCommerce originated. One of the following: | Values | Description | | ------------- | -------------…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Woolworths Group publishes across the network.
