Afterpay Component

Add Afterpay to your existing Components integration.

This page explains how to add Afterpay to your existing Web Components integration.

Requirements

Select which endpoint you are using:

When making an Afterpay payment, you also need to:

Collect shopper details, and specify these in your payment request. Afterpay uses these for risk checks.
Provide information about the purchased items.
Make sure that you use a supported combination of country/region and currency.

API reference

Select which endpoint you are using:

Component configuration

Step 1: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:

 <div id="afterpaytouch-container"></div>

Step 2: Create an instance of the Component

v6.0.0 or later

Create an instance of the Component, passing:

Your instance of AdyenCheckout.

const afterpaytouch = new AfterPay(checkout).mount('#afterpaytouch-container');

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component:

const afterpaytouchComponent = checkout.create('afterpaytouch').mount('#afterpaytouch-container');

Capture the payment

Depending on your merchant account configuration, Afterpay payments are captured automatically after authorisation, or manually captured.

If you prefer to capture the payment after the goods have been sent, or if you want to partially capture payments, you need to set up a capture delay or use manual capture. When you use manual capture, Afterpay payments have to be captured within 13 days after authorisation.

During authorisation, the shopper is charged for the first installment. If the payment isn't captured within 13 days, before the second installment, Afterpay cancels the payment and refunds the first installment to the shopper.

For testing purposes, Afterpay authorisations expire in one day. When you use manual capture, you need to capture test Afterpay payments within one day after authorisation.

Partial captures

To partially capture a payment, in your /payments/{paymentPspReference}/captures request specify:

modificationAmount: the amount that the shopper should pay.
additionalData.openinvoicedata:
Optional
price and product information for the items that the shopper should pay for.

Although the field names are different, the information in additionalData.openinvoicedata is the same as what you provided in lineItems when making a payment request:

openinvoicedata	lineItems	Description
`itemAmount`	`amountExcludingTax`	The price for one item, without the tax, in minor units.
`itemVatAmount`	`taxAmount`	The tax amount for one item, in minor units.

The following example shows how to make a partial capture request if the shopper only kept one pair of socks from the two included in the original payment request.

Any unclaimed amount that is left over after partially capturing a payment is automatically cancelled. When your account is enabled for multiple partial captures, the unclaimed amount after an initial capture is not automatically cancelled.

To set up multiple partial captures, contact our Support Team. Multiple partial captures will create a new invoice for each capture.

Refunds and cancellations

If a payment has not yet been captured, you can cancel it. If a payment has already been captured and you want to return the funds to the shopper, you need to refund the payment.

Partial refunds

To partially refund a payment, in your /payments/{paymentPspReference}/refunds request specify:

modificationAmount: the amount to be refunded to the shopper.
additionalData.openinvoicedata:
Optional
price and product information about the returned items.

Providing additionalData.openinvoicedata is optional, and although the field names are different, the information is the same as what you provided in lineItems when making a payment request:

openinvoicedata	lineItems	Description
`itemAmount`	`amountExcludingTax`	The price for one item, without the tax, in minor units.
`itemVatAmount`	`taxAmount`	The tax amount for one item, in minor units.

The following example shows how to make a partial refund request if the shopper returned the shoes included in the original payment request.

Discounts

To offer discounts, your payment request must include the negative amount to be added to the original price. The following example shows how to specify a discount of 1 AUD on Item #2:

{
  "amount":{
     "value":800,
     "currency":"AUD"
  },
  ...
  "lineItems":[

     {
        "description":"Test Afterpay 1",
        "quantity":"1",
        "amountIncludingTax":"400",
        "id":"Item #1"
     },
     {
        "description":"Test Afterpay 2",
        "quantity":"2",
        "amountIncludingTax":"300",
        "id":"Item #2"
     }

     {
        "description":"Discount",
        "quantity":"2",
        "amountIncludingTax":"-100",
        "id":"Item #2 Discount"
     }
  ]
}

Test and go live

To test Afterpay payments, you need a test shopper account in the Afterpay sandbox environment. If you are testing in multiple countries or regions, create a different test account for each.

To create a test account:

Go to https://portal.sandbox.afterpay.com/.
Enter a real email address and select Continue. You'll get confirmations of payments and refunds like any other shopper on this email address.
From the drop-down menu, select the country/region for which you want to create a test shopper account. Select Australia, New Zealand, US, or Canada.
Enter any mobile telephone number that is formatted correctly, and select Continue. Check the input box for hints on the format. The phone number won't be used.
When you are prompted to enter your SMS verification code, enter 111111.
Follow the instructions on your screen to complete your profile, accept the terms and conditions, and select Continue.

To test payments, add a test card to your Afterpay test shopper account.

You can use the card details provided in the Afterpay developer documentation, or use one of the Adyen test cards. Use CVV 000 to simulate authorised payments, or CVV 051 to simulate refused payments.

You can check the status of test payments in your Customer Area > Transactions > Payments.

Before you can accept live Afterpay payments, you need to submit a request for Afterpay in your live Customer Area.