Skip to main content


This page provides an overview of the payments methods provided by the Openpay adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating Openpay within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.

The required currency is AUD (Australian dollar).

Payment Methods

Payment MethodTransaction FlowsTransaction Types
OpenpayFull-Page RedirectDebit, Refund

Additional Parameters

firstName (Customer)stringtrueThe customer’s first name
lastName (Customer)stringtrueThe customer’s family name
email (Customer)stringtrueThe customer’s email
birthDate (Customer)stringfalseThe customer’s date of birth
shippingAddress1 (Customer)stringtrueThe first address line
shippingAddress2 (Customer)stringfalseThe second address line
shippingCity (Customer)stringtrueThe address suburb, town or county
shippingState (Customer)stringtrueThe address state (case-sensitive)
shippingPostcode (Customer)stringtrueThe address postcode
billingAddress1 (Customer)stringfalseThe first address line
billingAddress2 (Customer)stringfalseThe first address line
billingCity (Customer)stringfalseThe address suburb, town or county
billingState (Customer)stringfalsehe address state (case-sensitive)
billingPostcode (Customer)stringfalseThe address postcode
itemsobjectfalseThe object containing cart items
extraDataobjectfalseobject containing key-value pairs (string-to-string)
↳extraData.sourcestringfalseThe type of customer journey being started Enum: "Online" "PosApp" "PosWeb"
↳extraData.deliveryMethodstringfalseEnum: "Delivery" "Pickup" "Email"
↳extraData.goodsDescriptionstringfalseBrief description of goods being purchased


identificationstringtrueAn internal stock number for this item
namestringtrueA description of the item used by the retailer
quantitynumberfalseHow many of the items were purchased
pricenumbertrueThe individual retail price charged for the item An integer number in the lowest denomination in the currency being used (e.g. 1034 indicates $10.34)
extraDataobjecttrueobject containing key-value pairs (string-to-string)
↳itemRetailChargestringtrueThe overall retail charge for the quantity of items An integer number in the lowest denomination in the currency being used (e.g. 1034 indicates $10.34)
↳itemGroupstringfalseA group level description if available
↳itemGroupCodestringfalseIf a group has an internal code that may be used to refer to it, it can be supplied

Options Request

Get Configured Min Max Purchase Price

In order to get the configured Min and Max purchase price range an Options Request is required.

Please use minMaxPrice as an identifier e.g. POST /options/{apiKey}/minMaxPrice.

You can find more information about the options request here: Options Request