Using the Clearpay API

Using Clearpay analytics

Setting up Clearpay analytics collection

Clearpay analytics are collected as part of the ClearpayJS library. The Clearpay JavaScript library must be included in all pages where analytics metrics might be gathered.

To include the Clearpay JavaScript library in a page, add the following <script> tag in the <head> HTML section:

ClearpayJS
1<script src="https://portal.afterpay.com/afterpay.js"</script>

Order confirmation analytics

Clearpay analytics records an order_confirmation event each time a customer reaches an order confirmation screen. Each order confirmation event records whether Clearpay was used, as well as the order value, currency, merchant ID, and order ID.

PropertyTypeDescription
is_afterpay_usedbooleanIf true, Clearpay was used to pay for this order.
merchant_idstringClearpay merchant ID.
order_amountstringValue of the order that has been captured.
order_currencystringThe currency of the order, using ISO 4217 currency codes.
order_idstring (optional)Optional field containing the merchant identifier of this order.

If a GBP 100 order was completed on your site using Clearpay with an Order Number of 11443 you would use the following attributes:

1AfterPay.analyticsEvent('order_confirmation', {
2	is_afterpay_used: true,
3	merchant_id: '1123533532',
4	order_amount: '100',
5	order_currency: 'GBP',
6	order_id: '11443'
7});