Afterpay Component

Our Afterpay Component renders Afterpay in your payment form. As with other redirect payment methods, you need to use createFromAction to redirect the shopper, and handle the redirect after the shopper returns to your website.

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.

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 Afterpay integration:

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

Show Afterpay in your payment form

To present the Afterpay Component in your payment form:

1. From your server, make a POST /paymentMethods request specifying one of the following combinations of countryCode and amount.currency:

   Country	countryCode	amount.currency
   Australia	AU	AUD
   New Zealand	NZ	NZD
   United States	US	USD
   Canada	CA	CAD

2. Pass the full response from the /paymentMethods call as the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

3. Add the Afterpay 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 and mount an instance of the Afterpay Component using its component name, afterpaytouch. This renders a button on your payment form.

   function handleOnSubmit(state, component) {
       // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
       state.isValid // True or false. Specifies if all the information that the shopper provided is valid.
       state.data // Provides the data that you need to pass in the `/payments` call.
       component // Provides the active component instance that called this event.
   }
   const afterpaytouchComponent =  checkout.create('afterpaytouch', {
       onSubmit: handleOnSubmit // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
   }).mount('#afterpaytouch-container');

   When the shopper selects the payment method, the Component calls the onSubmit event, which contains a state.data object including the shopper's selected payment method. If your integration is set up correctly, the state.data is passed on to your server.

Make a payment

From your server, make a POST /payments, specifying:

• paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.
• returnUrl: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol: http:// or https://. For example, https://your-company.com/checkout/. You can also include your own additional query parameters, for example, shopper ID or order reference number.

• 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.  

Here is how you would make a payment request for 10 AUD:

curl https://checkout-test.adyen.com/v66/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "{hint:`state.data.paymentMethod` from `onSubmit`}paymentMethod{/hint}":{
     "type":"afterpaytouch"
  },
  "amount":{
     "value":1000,
     "currency":"AUD"
  },
  "shopperName":{
     "firstName":"Simon",
     "lastName":"Hopper"
  },
  "shopperEmail":"s.hopper@example.com",
  "shopperReference":"YOUR_UNIQUE_SHOPPER_ID",
  "reference":"YOUR_ORDER_REFERENCE",
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy..",
  "countryCode":"AU",
  "telephoneNumber":"+61 2 8520 3890",
  "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:

• action.method: GET. 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.

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

If your integration is set up correctly, the action object is passed from your server to the client, and the action.paymentData temporarily stored on your server.

Handle the redirect

Handling the redirect works the same way for all redirect payment methods:

1. Call createFromAction, passing the action object from the previous step. This will return a new Component that you need to mount:

   checkout.createFromAction(action).mount('#my-container');

   The Component redirects the shopper to Afterpay to complete the payment.
2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
   • paymentData: The value your received in the /payments response.
   • details: Object that contains the URL-decoded values of the parameters that were returned when the shopper was redirected back to your site.
   https://docs.adyen.com/payment-methods/afterpaytouch/web-component#-payments-details-request

   /payments/details request

   {
         "paymentData":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
         "details":{
           "redirectResult":"Ab02b4c0!BQABAgCW5sxB4e/=="
         }
   }

   The /payments/details response contains:
   • resultCode: Use this to present the payment result to your shopper.
   • pspReference: Our unique identifier for the transaction.
   https://docs.adyen.com/payment-methods/afterpaytouch/web-component#-payments-details-response

   /payments/details response

   {
         "resultCode": "Authorised",
         "pspReference": "88154795347618C"
   }

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:

If the shopper failed to return to your website or app, wait for notification webhooks to know the outcome of the payment:

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 AUD on Item 2:

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

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

     {
        "description":"Discount",
        "quantity":"2",
        "amountIncludingTax":"-1000",
        "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:

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

To test payments, 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.

See also