API Reference

Cancel transaction

post
https://spay.payments.wpay.com.au/v1/cancel

This endpoint allows you to send reversal request for previous transactions including requests that have not yet received any response from the Wpay API. You can also use this endpoint to send a VOID request.

The table below defines the pre-defined value of transactionType that API will accept

transactionTypeDescription
CANCELTo send a reversal request
VOIDTo Void a PREAUTH transaction
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Cancel Object

string
enum
required

Type of message request.

The table below lists the supported transaction types

transactionTypeDescription
CANCELTo send a reversal request
VOIDTo Void a PREAUTH transaction
Allowed:
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.

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"

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:
string
required
length between 8 and 8

ID of the acqurier

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

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:

ValuesDescription
08Moto order
15Customer Terminal, or OEM (except refund)
48Electronic Commerce, scheme token or OEM(refund only)
42Electronic Payment terminal or standalone application
Allowed:
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.

string
required
length between 4 and 4

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

boolean
required
Defaults to false

This element indicates if it is a retry of previous cancel request

card
object
merchant
object
amount
object
cancelTransactionIdentifiers
object

This element is used to identify the original transaction which is to be cancelled.

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.

string
required
length ≤ 16

ID of Pinpad Terminal

Headers
string
required

Mac of the payload

string
required

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

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

500

An internal server error occurred.

Updated 4 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago