How can I easily add Afterpay Messaging to my site?
Merchants using our legacy documentation
If you’re using a previous version of our Javascript documentation you can find it here
The current JavaScript library Afterpay.js is the primary integration tool for merchants to use. Merchants who integrated before August 2020 should upgrade to the new library.
Afterpay’s JavaScript Library allows you to easily display installment amounts throughout the checkout flow.
The Afterpay.js script loads various Afterpay Messaging and Assets for merchants to utilize throughout their store. To load the Afterpay.js library add the following async script tag to the <head> section of your site.
If you are using a specific version of the script, please update to version 1.x.js
To display the Installment Messaging add the <afterpay-placement> tag to the product and cart HTML files. The messaging should be placed immediately below the price element on both product and cart pages.
To render Afterpay messaging with the correct language and calculated installment amount, provide the locale, currency, and amount attributes to the custom element.
data-min and data-max define the minimum and maximum for the messaging. When a product or cart total is outside of this range, the messaging will read like so:
Often merchants want to restrict customers from using Afterpay on items that fall outside a specific price range. To configure the minimum an maximum threshold, add the following attribute to the Afterpay.js Script tag: E.g)
The min and max values only affect the amounts used in the messaging. To request a different minimum or maximum threshold for your account, please contact your sales rep.
