Afterpay Touch Component

Our Afterpay Touch Component renders Afterpay in your payment form, and redirects the shopper to Afterpay to complete the payment.

When making an Afterpay payment, you also need to:

1. Collect shopper details, and specify these in your payment request.
   Afterpay uses these for risk checks.
2. Provide information about the purchased items in your payment request.
3. Handle the redirect result when the shopper returns to your website.

Before you begin

This page explains how to add Afterpay to your existing Web Components integration. The Web Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your integration:

1. Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
2. Add Afterpay in your test Customer Area.

Show Afterpay in your payment form

To show Afterpay in your payment form, you need to:

1. Specify in your /paymentMethods request one of the following combinations of countryCode and amount.currency:

   Country	countryCode	amount.currency
   Australia	AU	AUD
   New Zealand	NZ	NZD

   Pass the full response to the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

2. Add the Afterpay Touch Component:

   a. Create a DOM element for Afterpay, placing it where you want the form to be rendered:

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

   b. Create an instance of the Afterpay Touch Component, and mount it.

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

Make a payment

When the shopper selects to pay, the Component calls the onChange event, which contains a state.data.

1. If state.isValid is true, collect the state.data and pass this to your server.

• paymentMethod: The state.data.paymentMethod from the onChange event from your front end.

  • shopperName: The shopper's full name. 
  • shopperEmail: The shopper's email address.  
  • telephoneNumberOptional: The shopper's phone number.
  • billingAddress: The postal address to be included on the invoice. 
  • deliveryAddress: The postal address where the goods will be shipped.
  • lineItems: Price and product information about the purchased items.  

{
   "{hint:`state.data.paymentMethod` from `onChange` or `onSubmit`}paymentMethod{/hint}":{
     "type":"afterpaytouch"
   },
   "amount":{
      "value":1000,
      "currency":"AUD"
   },
   "shopperName":{
      "firstName":"Happy",
      "lastName":"Testing"
   },
   "shopperEmail":"shopper@email.com",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID",
   "reference":"YOUR_ORDER_REFERENCE",
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
   "returnUrl":"https://www.yourshop.com/checkout/result",
   "countryCode":"AU",
   "telephoneNumber":"+85121212121",
   "billingAddress":{
      "city":"Sydney",
      "country":"AU",
      "houseNumberOrName":"123",
      "postalCode":"2000",
      "stateOrProvince":"NSW",
      "street":"Happy Street"
   },
   "deliveryAddress":{
      "city":"Sydney",
      "country":"AU",
      "houseNumberOrName":"123",
      "postalCode":"2000",
      "stateOrProvince":"NSW",
      "street":"Happy Street"
   },
   "lineItems":[
      {
         "description":"Shoes",
         "quantity":"1",
         "amountIncludingTax":"400",
         "id":"Item #1"
      },
      {
         "description":"Socks",
         "quantity":"2",
         "amountIncludingTax":"300",
         "id":"Item #2"
      }
   ]
}

The /payments response contains:

• resultCode: RedirectShopper
• details: Array that contains the key parameter name and the corresponding data type that you should expect when the shopper is redirected to your returnURL. You need to submit this value in your /payments/details request when handling the redirect.
• action: Object containing information about the redirect.
• action.paymentData: Value that you need to submit in your /payments/details request when handling the redirect.
• action.method: GET or POST. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to your returnURL using the same method.
  The redirect method depends on your payment method configuration and the length of the data included in the request, so make sure that your integration can handle both HTTP GET and HTTP POST methods.

{
   "resultCode":"RedirectShopper",
   "action":{
      "method":"GET",
      "paymentData":"abcxyz...",
      "paymentMethodType":"afterpaytouch",
      "type":"redirect",
      "url":"https://test.adyen.com/hpp/skipDetails.shtml?billingAddress. ..."
   },
   "details":[
      {
         "key":"redirectResult",
         "type":"text"
      }
   ],
   ...
}

Handle the redirect result

The Component uses the action object to redirect the shopper to Afterpay. After the shopper is redirected back to your website, you need to check the payment result by making a /payments/details request.

For more information and detailed instructions, refer to Handling the redirect result.

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.
The resultCode values you can receive for Afterpay are:

Discounts

To offer discounts, specify in your /payments request the negative amount to be added to the original price. The following example shows how to specify a discount of $ 10 on Item 2:

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

     {
        "description":"Test Afterpay Touch 1",
        "quantity":"1",
        "amountIncludingTax":"4550",
        "id":"Item #1"
     },
     {
        "description":"Test Afterpay Touch 2",
        "quantity":"2",
        "amountIncludingTax":"2650",
        "id":"Item #2"
     }

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

Test and go live

While you're going through the certification process, Afterpay will provide you with a merchantID and a password that you can use for testing. After reviewing your test transactions, Afterpay will provide you the credentials for processing live transactions.

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.

See also