Afterpay

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

Afterpay supports the following currencies: AUD, NZD, USD and CAD. The used currency must also match the currency of the Afterpay merchant account.

Payment Methods

Payment Method	Transaction Flows	Transaction Types	Supported Currencies
Afterpay	Full-Page Redirect	Debit, Preauthorize, Capture, Void, Refund	AUD, NZD, USD, CAD

Mandatory Parameters

Name	Type	Required	Description
firstName (Customer)	string	true	The customer’s first name and any middle names
lastName (Customer)	string	true	The customer’s last name
email (Customer)	string	true	The customer’s email address
billingAddress1 (Customer)	string	true	First line of the address.
billingCity (Customer)	string	true	Australian suburb, New Zealand town or city, U.K. Postal town, U.S. or Canadian city
billingState (Customer)	string	true	Australian state, New Zealand region, U.K. county, Canadian Territory or Province, or U.S. state
billingPostcode (Customer)	string	true	ZIP or postal code
billingCountry (Customer)	string	true	The two-character country code
shippingFirstName (Customer)	string	true	Shipping first name
shippingLastName (Customer)	string	true	Shipping last name
shippingAddress1 (Customer)	string	true	First line of the address
shippingCity (Customer)	string	true	Australian suburb, New Zealand town or city, U.K. Postal town, U.S. or Canadian city
shippingState (Customer)	string	true	Australian state, New Zealand region, U.K. county, Canadian Territory or Province, or U.S. state
shippingPostcode (Customer)	string	true	ZIP or postal code
shippingCountry (Customer)	string	true	The two-character country code
extraData.billingName (Customer)	string	true	The full name of contact (first and last name)

Additional Parameters

Name	Type	Required	Description
extraData.billingCity2 (Customer)	string	false	New Zealand suburb or U.K. village or local area
extraData.shippingCity2 (Customer)	string	false	New Zealand suburb or U.K. village or local area
extraData.shippedAt	string	false	The time at which the order was shipped, in ISO 8601 format
extraData.courierName	string	false	The name of the courier
extraData.tracking	string	false	The tracking number provided by the courier
extraData.priority	string	false	The shipping priority. If provided, must be either 'STANDARD' or 'EXPRESS'
extraData.taxAmount	string	false	The included tax amount after applying all discounts
extraData.shippingAmount	string	false	The shipping amount

Item Parameters

If items are given with the transaction data, the following parameters can or must be given:

Name	Type	Required	Description
name (Item)	string	true	Product name or display name for the discount
quantity (Item)	string	conditional	Required for normal items, not mandatory for discount items
price (Item)	string	false	The unit price of the individual item. Must be a positive value
extraData.type (Item)	string	false	Set this parameter to 'discount' if the item should be sent as a discount item. Otherwise the field can be left empty
extraData.sku (Item)	string	false	Product SKU
extraData.pageUrl (Item)	string	false	The canonical URL for the item's Product Detail Page
extraData.imageUrl (Item)	string	false	A URL for a web-optimised photo of the item, suitable for use directly as the src attribute of an img tag
extraData.estimatedShipmentDate (Item)	string	false	The estimated date when the order will be shipped, in YYYY-MM or YYYY-MM-DD format

Options Request

Get Configured Min Max Purchase Amount

In order to get the configured Min and Max purchase amount 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