List Checkouts

Query Params
string
required

RSQL is a REST query language that allows you to filter resources based on their attributes. The RSQL query is a string that represents a query in a human-readable format. The RSQL query is passed as a query parameter in the URL and is used to filter the resources based on the attributes of the resource. See RSQL queries for Checkout API for example filters to use with the Checkout API. See ![RSQL](RSQl https://aboullaite.me/rsql/) for more information on RSQL queries.

string
length ≤ 255

The ordering sequence of the selected checkouts If not selected then a default order is based on created Date Time. The value of order_criteria can be one of the following:

  • amount
  • currency_code
  • created_at
  • updated_at
string
enum

The ordering sequence of the selected customers If not selected then Descending order is the default order.

Allowed:
number
≥ 1

A filter query in RSQL format to retrieve customers based on page number. If not selected then a default pageNumber is 1.

number
≥ 0

A filter query in RSQL format to retrieve customers based on page size. If not selected then a default pageSize is 50

boolean
Defaults to false

A query param to allow customer details to be populated for the customer id attached to checkout.

Responses

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

Terms and conditions Website requirements Other fees and charges

This information is a general statement for information purposes only and should only be used as a guide. While all care has been taken in preparation of this document, no member of the Westpac Group, nor any of their employees or directors gives any warranty of accuracy or reliability nor accepts any liability in any other way, including by reason of negligence for any errors or omissions contained herein, to the extent permitted by law. Unless otherwise specified, the products and services described are available only in Australia.

© Westpac Banking Corporation ABN 33 007 457 141 AFSL and Australian credit licence 233714.