Cart Resources

A cart is a collection of sales which all have the same cart ID. A single session with a ticket buyer will create a cart.

Get Cart ID

Description
Gets an unused cart ID.
Method
GET
URL
https://api.iwannaticket.com.au/api/v2/cart/

This is useful in integration projects where an IWT cart ID needs to be generated by a server in order to link multiple IWT widgets in a page via a common cart.

Get Cart Contents

Description
Gets the current contents of the cart.
Method
GET
URL
https://api.iwannaticket.com.au/api/v2/cart/{cartId}

Output

Name Type Description
key String The ID of this cart.
total Currency The total price for this cart.
gst Currency GST included in this price.
sales List[CartSale] The reserved sales currently in the cart.
expirySeconds Number The number of seconds until the cart expires.

Pay for Cart

Description
Attempts to pay for the contents of the cart.
Method
POST
URL
https://api.iwannaticket.com.au/api/v2/cart/{cartId}/payment

The credit card is not required if the sale is for $0.

Input

Name Type Description
amount Number The amount to be paid.
creditCard optional CreditCard The card to be charged.

Output

Name Type Description
type String The type of result.
  • NO_SALES - there were no sales in the cart
  • WRONG_STATE - some of the sales were in an inappropriate state to be paid for
  • REFUSED - IWannaTicket refused to process some sales
  • SUCCESS - payment was processed for all sales
  • WRONG_AMOUNT - the payment request was for the wrong amount
payments List[CartSalePaymentResponse] The payments attempted and what happened.
amount Currency The value of the cart that should be paid.

Lock Cart

Description
Lock all RESERVED sales in the cart before payment.
Method
POST
URL
https://api.iwannaticket.com.au/api/v2/cart/{cartId}/lock

Input

The body of the request contains payee details, which are additional fields on the payee. Those listed here are required, but others may be present.

Name Type Description
FIRST_NAME String Payee first name
LAST_NAME String Payee last name
EMAIL String Payee email

Unlock Cart

Description
Unlock all LOCKED sales in the cart after a payment failure.
Method
POST
URL
https://api.iwannaticket.com.au/api/v2/cart/{cartId}/unlock

Update Cart User Details

Description
Update all sales in the cart with the given user details. You would use this if you are gathering the details, but not handling payment.
Method
PUT
URL
https://api.iwannaticket.com.au/api/v2/cart/{cartId}/data

Input

The body of the request contains payee details, which are additional fields on the payee. Those listed here are required, but others may be present.

Name Type Description
FIRST_NAME String Payee first name
LAST_NAME String Payee last name
EMAIL String Payee email