<th>
Type
</th>
<th>
Description
</th>
<th>
Required
</th>
</tr>
<td>
string
</td>
<td>
The amount is a string representation of a decimal number, rounded to 2 decimal places.
</td>
<td>
<span style="display: block;text-align: center;">Y</span>
</td>
</tr>
<tr>
<td>
currency
</td>
<td>
string
</td>
<td>
The currency in <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO 4217</a> format. Currently it support only “AUD”. However, the value provided MUST correspond to the currency of the Merchant account making the request.
</td>
<td>
<span style="display: block;text-align: center;">Y</span>
</td>
</tr>
Attribute
amount
Example of Money Object
{
"amount": "29.99",
"currency": "AUD"
}
Discount Object
ATTRIBUTES
<th>
Type
</th>
<th>
Description
</th>
<th>
Required
</th>
</tr>
<td>
string
</td>
<td>
A display name for the discount. Limited to 150 characters.
</td>
<td>
<span style="display: block;text-align: center;">Y</span>
</td>
</tr>
<tr>
<td>
amount
</td>
<td>
<a href="#money-object">Money</a>
</td>
<td>
The discount amount.
</td>
<td>
<span style="display: block;text-align: center;">Y</span>
</td>
</tr>
<th>
Type
</th>
<th>
Description
</th>
<th>
Required
</th>
</tr>
<td>
string
</td>
<td>
Item Name. Limited to 300 characters
</td>
<td>
<span style="display: block;text-align: center;">Y</span>
</td>
</tr>
<tr>
<td>
sku
</td>
<td>
string
</td>
<td>
Product SKU. Limited to 150 characters.
</td>
<td>
</td>
</tr>
<tr>
<td>
quantity
</td>
<td>
integer
</td>
<td>
The quantity of the item, stored as a signed 32-bit integer.
</td>
<td>
<span style="display: block;text-align: center;">Y</span>
</td>
</tr>
<tr>
<td>
pageURL
</td>
<td>
string
</td>
<td>
URL for the item's Product Detail Page. Limited to 1500 characters
</td>
<td>
</td>
</tr>
<tr>
<td>
imageURL
</td>
<td>
string
</td>
<td>
A URL for a web-optimised photo of the item, suitable for use directly as the src attribute of an img tag. Limited to 1500 characters
</td>
<td>
</td>
</tr>
<tr>
<td>
price
</td>
<td>
<a href="#money-object">Money</a>
</td>
<td>
The unit price of the individual item. Must be a positive value.
</td>
<td>
<span style="display: block;text-align: center;">Y</span>
</td>
</tr>
<tr>
<td>
categories
</td>
<td>
string [][]
</td>
<td>
An array of arrays to accommodate multiple categories that apply to the item. Each array represents a hierarchical path to a category, with the left-most category being the top-level parent category.
</td>
<td>
</td>
</tr>
<th>
Type
</th>
<th>
Description
</th>
<th>
Required
</th>
</tr>
<td>
string
</td>
<td>
Customer will be redirected to this URL if wizit approve the purchase and first payment is complete
</td>
<td>
<span style="display: block;text-align: center;">Y</span>
</td>
</tr>
<tr>
<td>
redirectCancelURL
</td>
<td>
string
</td>
<td>
Customer will be redirected to this URL if wizit decline the purchase
</td>
<td>
<span style="display: block;text-align: center;">Y</span>
</td>
</tr>
<th>
Type
</th>
<th>
Description
</th>
<th>
Required
</th>
</tr>
<td>
string
</td>
<td>
A unique request ID, required (in conjunction with merchantReference) for safe retries. It is recommended that the merchant generate a UUID for each unique refund.
</td>
<td>
</td>
</tr>
<tr>
<td>
amount
</td>
<td>
<a href="#money-object">Money</a>
</td>
<td>
The refund amount.
</td>
<td>
<span style="display: block;text-align: center;">Y</span>
</td>
</tr>
<tr>
<td>
merchantReference
</td>
<td>
string
</td>
<td>
The merchant's corresponding refund ID or reference, required (in conjunction with requestId) for safe retries.
</td>
<td>
</td>
</tr>
<tr>
<td>
refundId
</td>
<td>
string
</td>
<td>
The unique, Wizit-generated refund ID.
</td>
<td>
</td>
</tr>
<tr>
<td>
refundedAt
</td>
<td>
string
</td>
<td>
AEST timestamp of the refund creation time, in ISO 8601 format.
</td>
<td>
</td>
</tr>
<tr>
<td>
refundMerchantReference
</td>
<td>
string
</td>
<td>
A unique reference for the individual refund event. If provided, the value will appear in the reference column of settlement file.
</td>
<td>
</td>
</tr>
<tr>
<td>
TransactionId
</td>
<td>
long
</td>
<td>
The unique, permanent, Wizit-generated transaction ID.
</td>
<td>
</td>
</tr>
<td>
string
</td>
<td>
The unique, permanent, Wizit-generated transaction ID.
</td>
</tr>
<tr>
<td>
token
</td>
<td>
string
</td>
<td>
Checkout token that was used to complete payment.
</td>
</tr>
<tr>
<td>
transactionStatus
</td>
<td>
string
</td>
<td>
An order status of "APPROVED" or "DECLINED" or COMPLETED (captured completed/voided)
</td>
</tr>
<tr>
<td>
paymentCompleted
</td>
<td>
string
</td>
<td>
The AEST timestamp of when the payment was completed, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format.
</td>
</tr>
<tr>
<td>
OriginalAmount
</td>
<td>
<a href="#money-object">Money</a>
</td>
<td>
Total amount charged to the customer for the order.
</td>
</tr>
<tr>
<td>
pendingCaptureAmount
</td>
<td>
<a href="#money-object">Money</a>
</td>
<td>
Remaining amount that can be captured. Will always be zero for <a href="/reference/post_api-payment-transactioncapture">Immediate Payment Flow</a> orders.
</td>
</tr>
<tr>
<td>
paymentStatus
</td>
<td>
string
</td>
<td>
Current state for capturing payments. Will be one of: "AUTH\_APPROVED", "AUTH\_DECLINED", "PARTIALLY\_CAPTURED", "CAPTURED", "CAPTURE\_DECLINED",\
"VOIDED".
</td>
</tr>
<tr>
<td>
merchantReference
</td>
<td>
string
</td>
<td>
The merchant's order id/reference that this payment corresponds to.
</td>
</tr>
<tr>
<td>
refunds
</td>
<td>
<a href="#refund-object">Refund</a>\[]
</td>
<td>
An array of refunds.
</td>
</tr>
<tr>
<td>
transactionDetails
</td>
<td>
<a href="#transactiondetail-object">TransactionDetail</a>
</td>
<td>
The details of the order bound to the payment.
</td>
</tr>
