Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Afterpay Touch Redirect Component

Add Afterpay Touch to an existing Components integration.

You can use our Redirect Component to handle the redirect to Afterpay.

When adding Afterpay to your existing Components integration, you also need to:

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

Before you begin

This page explains how to add Afterpay to your existing Android Components integration. The Android 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 for making API requests.
  2. Add Afterpay in your test Customer Area.

Show Afterpay in your payment form

Include Afterpay in the list of available payment methods, and collect the required shopper details:

  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

The response contains paymentMethod.type: afterpaytouch.

  1. Collect the following shopper details:
  • Full name
  • Email address
  • Billing address and delivery address.

Afterpay uses this information for risk checks.

We provide an Afterpay logo which you can use on your payment form. For more information, refer to Downloading logos.

Make a payment

When the shopper proceeds to pay, make a /payments request from your server, specifying:

  • paymentMethod.type: Set this to afterpaytouch to redirect to Afterpay.
  • returnURL: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).
{
  "paymentMethod":{
    "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:

  • action: Object containing information about the redirect.

    {
      "resultCode":"RedirectShopper",
      "action":{
         "method":"GET",
         "paymentData":"Ab02b4c0!BQABAgCSZT7t...",
         "paymentMethodType":"alipay_wap",
         "type":"redirect",
         "url":"https://test.adyen.com/hpp/redirectIdeal.shtml?brandCode=ideal.."
      },
      "details":[
         {
            "key":"payload",
            "type":"text"
         }
      ],
      ...
    }
  1. Pass the action object to your client app. You need this to initialize the Redirect Component.

Handle the redirect

Use the Redirect Component to redirect the shopper to Afterpay.

After the shopper is redirected back to your app, make a /payments/details call to check the payment result.

For more information and detailed instructions, refer to Using the Redirect Component.

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:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment was successful.
Cancelled The shopper cancelled the payment. Ask the shopper whether they want to continue with the order, or request that they select a different payment method.
Pending
Received
The shopper has completed the payment but the final result is not yet known. It may take minutes or hours to confirm this. Inform the shopper that you've received their order, and are waiting for the payment to be completed.
To know the final result of the payment, wait for the AUTHORISATION notification.
Refused The payment was refused by Afterpay. Ask the shopper to try the payment again using a different payment method.
If a shopper completed the payment but failed to return to your website or app, you will receive the outcome of the payment in an AUTHORISATION notification.

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