For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Online API
    • API Environments
    • Direct Payment Flow
    • REST
    • HTTPS
    • Request Headers
    • Dates
    • Pagination
    • Authentication
    • Idempotent Requests
    • Timeouts
    • API Simulator
    • JavaScript afterpay.js
    • Errors
LogoLogo
On this page
  • Production
  • Sandbox
  • Redirect Method
Online API

JavaScript afterpay.js

Was this page helpful?
Previous

Capture Payment

Next
Built with

Production

All Regions
https://portal.afterpay.com/afterpay.js

Sandbox

All Regions
https://portal.sandbox.afterpay.com/afterpay.js

The afterpay.js is used to launch the Clearpay screenflow, where the consumer logs in (or registers) then confirms their payment schedule.

Note

Before this JavaScript can be used, the merchant must call Create Order from their server backend and retrieve an order token. The token is then used in conjunction with this JavaScript to launch the Clearpay screenflow.

Note

It is only after the consumer completes the Clearpay screenflow and returns to the merchant’s website that a subsequent Capture Payment call can be completed.

Redirect Method

The Redirect Method is used by some merchants. This method redirects the consumer away from the merchant’s website to Clearpay to complete their payment. At the end of the process, the consumer will be redirected back to the merchant’s website.

  • If the Consumer clicks “confirm”, they will be redirected to the redirectConfirmUrl, with the orderToken and a status of “SUCCESS” appended as HTTP query parameters.
  • If the Consumer cancels, they will be redirected to the redirectCancelUrl, with the orderToken and a status of “CANCELLED” appended as HTTP query parameters.

The Merchant defines the redirectConfirmUrl and redirectCancelUrl for each order in their Create Order call.

To implement the Redirect Method, the following two JavaScript functions must be called:

    • Clearpay.redirect - This redirects the consumer’s browser from the merchant’s website to Clearpay. This function accepts one required argument: an object with a required token property. This property must contain the checkout token returned by Create Order.
UK
1<html>
2<head>
3  <script onload="initAfterPay()" src="https://portal.sandbox.afterpay.com/afterpay-async.js" async defer></script>
4</head>
5<body>
6  <p>Your HTML here</p>
7  <script>
8  function initAfterPay () {
9    AfterPay.initialize({countryCode: "GB"});
10    AfterPay.redirect({token: "YOUR_TOKEN"});
11  }
12  </script>
13</body>
14</html>

Try using your Sandbox Merchant credentials to obtain a token from Create Order, then use the token to test the Clearpay screenflow on JSFiddle:

https://jsfiddle.net/afterpay/we9xfqgm/

Note that since JSFiddle loads the Clearpay screenflow inside a frameset, the login and redirect features will not be operational.