Openpay

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 Method	Transaction Flows	Transaction Types
Openpay	Full-Page Redirect	Debit, Refund

Additional Parameters

Name	Type	Required	Description
firstName (Customer)	string	true	The customer’s first name
lastName (Customer)	string	true	The customer’s family name
email (Customer)	string	true	The customer’s email
birthDate (Customer)	string	false	The customer’s date of birth
shippingAddress1 (Customer)	string	true	The first address line
shippingAddress2 (Customer)	string	false	The second address line
shippingCity (Customer)	string	true	The address suburb, town or county
shippingState (Customer)	string	true	The address state (case-sensitive)
shippingPostcode (Customer)	string	true	The address postcode
billingAddress1 (Customer)	string	false	The first address line
billingAddress2 (Customer)	string	false	The first address line
billingCity (Customer)	string	false	The address suburb, town or county
billingState (Customer)	string	false	he address state (case-sensitive)
billingPostcode (Customer)	string	false	The address postcode
items	object	false	The object containing cart items
extraData	object	false	object containing key-value pairs (string-to-string)
↳extraData.source	string	false	The type of customer journey being started Enum: "Online" "PosApp" "PosWeb"
↳extraData.deliveryMethod	string	false	Enum: "Delivery" "Pickup" "Email"
↳extraData.goodsDescription	string	false	Brief description of goods being purchased

Item

Name	Type	Required	Description
identification	string	true	An internal stock number for this item
name	string	true	A description of the item used by the retailer
quantity	number	false	How many of the items were purchased
price	number	true	The 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)
extraData	object	true	object containing key-value pairs (string-to-string)
↳itemRetailCharge	string	true	The 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)
↳itemGroup	string	false	A group level description if available
↳itemGroupCode	string	false	If 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