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:
- Collect shopper details, and specify these in your payment request. Afterpay uses these for risk checks.
- 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:
- Make sure that you have set up your back end implementation, and created an instance of
AdyenCheckout
. -
Add Afterpay in your Customer Area.
Show Afterpay in your payment form
To present the Afterpay Component in your payment form:
-
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
-
Pass the full response from the /paymentMethods call as the
paymentMethodsResponse
object when creating an instance of theAdyenCheckout
. - 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 astate.data
object including the shopper's selected payment method. If your integration is set up correctly, thestate.data
is passed on to your server.
Make a payment
From your server, make a POST /payments, specifying:
paymentMethod
: Thestate.data.paymentMethod
from theonSubmit
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://
orhttps://
. 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",
"amountExcludingTax": "331",
"taxAmount": "69",
"id":"Item #1"
},
{
"description":"Socks",
"quantity":"2",
"amountIncludingTax":"300",
"amountExcludingTax": "248",
"taxAmount": "52",
"id":"Item #2"
}
]
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
response = adyen.checkout.payments({
:merchantAccount => "YOUR_MERCHANT_ACCOUNT",
:reference => "YOUR_ORDER_NUMBER",
:amount => {
:currency => "AUD",
:value => 1000
},
:paymentMethod => {
:type => "afterpaytouch"
},
:returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
:countryCode => "AU",
:shopperName => [
:firstName => "Simon",
:lastName => "Hopper"
],
:shopperEmail => "s.hopper@example.com",
:shopperReference => "YOUR_UNIQUE_SHOPPER_ID",
: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",
:amountExcludingTax => "331",
:taxAmount => "69",
:id => "Item #1"
},
{
:description => "Socks",
:quantity => "2",
:amountIncludingTax => "300",
:amountExcludingTax => "248",
:taxAmount => "52",
:id => "Item #2"
}
]
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
Checkout checkout = new Checkout(client);
PaymentsRequest paymentsRequest = new PaymentsRequest();
String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
paymentsRequest.setMerchantAccount(merchantAccount);
Amount amount = new Amount();
amount.setCurrency("AUD");
amount.setValue(1000L);
paymentsRequest.setAmount(amount);
DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
paymentMethodDetails.setType("afterpaytouch");
paymentsRequest.setPaymentMethod(paymentMethodDetails);
paymentsRequest.setReference("YOUR_ORDER_NUMBER");
paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");
Name shopperDetails = new Name();
shopperDetails.setFirstName("Simon");
shopperDetails.setLastName("Hopper");
paymentsRequest.setShopperName(shopperDetails);
paymentsRequest.setShopperReference("YOUR_UNIQUE_SHOPPER_ID");
paymentsRequest.setCountryCode("AU");
paymentsRequest.setTelephoneNumber("+61 2 8520 3890");
paymentsRequest.setShopperEmail("s.hopper@example.com");
BillingAddress billingAdress = new BillingAddress();
billingAddress.setCountry("AU");
billingAddress.setCity("Sydney");
billingAddress.setHouseNumberOrName("123");
billingAddress.setStreet("Happy Street");
billingAddress.setPostalCode("2000");
billingAddress.setStateOrProvince("NSW");
paymentsRequest.setBillingAddress(billingAddress);
DeliveryAddress deliveryAddress = new DeliveryAddress();
deliveryAddress.setCountry("AU");
deliveryAddress.setCity("Sydney");
deliveryAddress.setHouseNumberOrName("123");
deliveryAddress.setStreet("Happy Street");
deliveryAddress.setPostalCode("2000");
deliveryAddress.setStateOrProvince("NSW");
paymentsRequest.setDeliveryAddress(deliveryAddress);
List<LineItem> lineItems = new ArrayList<>();
lineItems.add(
new LineItem()
.quantity(1L)
.description("Shoes")
.id("Item #1")
.amountIncludingTax(400L)
.amountExcludingTax(331L)
.taxAmount(69L)
);
lineItems.add(
new LineItem()
.quantity(2L)
.description("Socks")
.id("Item #2")
.amountIncludingTax(300L)
.amountExcludingTax(248L)
.taxAmount(52L)
);
paymentsRequest.setLineItems(lineItems);
PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);
$params = [
"merchantAccount" => "YOUR_MERCHANT_ACCOUNT",
"reference" => "YOUR_ORDER_NUMBER",
"amount" => [
"currency" => "AUD",
"value" => 1000
],
"paymentMethod" => [
"type" => "afterpaytouch"
],
"returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
"countryCode" => "AU",
"shopperName" => [
"firstName" => "Simon",
"lastName" => "Hopper"
],
"shopperEmail" => "s.hopper@example.com",
"shopperReference" => "YOUR_UNIQUE_SHOPPER_ID",
"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",
"amountExcludingTax" => "331",
"taxAmount" => "69",
"id" => "Item #1"
],
[
"description" => "Socks",
"quantity" => "2",
"amountIncludingTax" => "300",
"amountExcludingTax" => "248",
"taxAmount" => "52",
"id" => "Item #2"
]
]
];
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'
result = adyen.checkout.payments({
"merchantAccount": "YOUR_MERCHANT_ACCOUNT",
"reference": "YOUR_ORDER_NUMBER",
"amount": {
"value": 1000,
"currency": "AUD"
},
"paymentMethod": {
"type": "afterpaytouch"
},
"returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..",
"countryCode":"AU",
"shopperName": {
"firstName":"Simon",
"lastName":"Hopper"
},
"shopperEmail":"s.hopper@example.com",
"shopperReference":"YOUR_UNIQUE_SHOPPER_ID",
"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",
"amountExcludingTax": "331",
"taxAmount": "69",
"id":"Item #1"
},
{
"description":"Socks",
"quantity":"2",
"amountIncludingTax":"300",
"amountExcludingTax": "248",
"taxAmount": "52",
"id":"Item #2"
}
]
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);
var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
Reference = "YOUR_ORDER_REFERENCE",
PaymentMethod = new DefaultPaymentMethodDetails { Type = "afterpaytouch" },
Amount = new Model.Checkout.Amount(Currency: "AUD", Value: 1000),
CountryCode = "AU",
TelephoneNumber = "+61 2 8520 3890",
ShopperEmail = "s.hopper@example.com",
ShopperName = new Model.Checkout.Name
{
FirstName = "Simon",
LastName = "Hopper"
},
ShopperReference = "YOUR_UNIQUE_SHOPPER_ID",
BillingAddress = new Model.Checkout.Address
{
City = "Sydney",
Country = "AU",
HouseNumberOrName = "123",
PostalCode = "2000",
StateOrProvince = "NSW",
Street = "Happy Street"
},
DeliveryAddress = new Model.Checkout.Address
{
City = "Sydney",
Country = "AU",
HouseNumberOrName = "123",
PostalCode = "2000",
StateOrProvince = "NSW",
Street = "Happy Street"
},
ReturnUrl = "https://your-company.com/checkout?shopperOrder=12xy..",
LineItems = new List<LineItem>
{
new LineItem(Quantity:1, Description:"Shoes",Id:"Item #1", AmountIncludingTax:400, AmountExcludingTax: 331, TaxAmount: 69),
new LineItem(Quantity:2, Description:"Socks",Id:"Item #2", AmountIncludingTax:300, AmountExcludingTax: 248, TaxAmount: 52)
}
};
return paymentRequest;
}
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
amount: {
currency: "AUD",
value: 1000
},
paymentMethod: {
type: 'afterpaytouch'
},
reference: "YOUR_ORDER_NUMBER",
shopperReference: "YOUR_UNIQUE_SHOPPER_ID",
merchantAccount: config.merchantAccount,
returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..",
countryCode: "AU",
shopperName: {
firstName: "Simon",
lastName: "Hopper"
},
shopperEmail: "s.hopper@example.com",
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",
amountExcludingTax: "331",
taxAmount: "69",
id:"Item #1"
},
{
description:"Socks",
quantity:"2",
amountIncludingTax:"300",
amountExcludingTax: "248",
taxAmount: "52",
id:"Item #2"
}
]
}).then(res => res);
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 yourreturnURL
using the same method.
{
"resultCode":"RedirectShopper",
"action":{
"method":"GET",
"paymentData":"Ab02b4c0!BQABAgCSZT7t...",
"paymentMethodType":"afterpaytouch",
"type":"redirect",
"url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=..."
},
"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:
-
Call
createFromAction
, passing theaction
object from the previous step. This will return a new Component that you need to mount:
The Component redirects the shopper to Afterpay to complete the payment.checkout.createFromAction(action).mount('#my-container');
- After the shopper is redirected back to your website, URL-decode the
redirectResult
that was appended to yourreturnUrl
when the shopper was redirected back to your site, and pass it to your back end. -
Check the payment result by making a POST /payments/details request, specifying:
-
paymentData
: The value you received in the /payments response. -
details
: Object that contains the URL-decoded values of the parameters that were appended to thereturnUrl
when the shopper was redirected back to your site.
-
resultCode
: Use this to present the payment result to your shopper. -
pspReference
: Our unique identifier for the transaction.
-
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 ask them to select a different payment method. | |
Pending or 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 the shopper failed to return to your website or app, wait for notification webhooks to know the outcome of the payment:
eventCode | success field | Description | Action to take |
---|---|---|---|
AUTHORISATION | false | The transaction failed. | Cancel the order and inform the shopper that the payment failed. |
AUTHORISATION | true | The shopper successfully completed the payment. | Inform the shopper that the payment has been successful and proceed with the order. |
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.
Partial captures
To partially capture a payment, specify in your /capture request:
-
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 /payments 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.
{
"originalReference":"COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE",
"merchantAccount":"YOUR_MERCHANT_ACCOUNT",
"modificationAmount":{
"currency":"AUD",
"value":"700"
},
"additionalData":{
"openinvoicedata.numberOfLines":"2",
"openinvoicedata.line1.currencyCode":"AUD",
"openinvoicedata.line1.description":"Shoes",
"openinvoicedata.line1.itemAmount":"331",
"openinvoicedata.line1.itemVatAmount":"69",
"openinvoicedata.line1.numberOfItems":"1",
"openinvoicedata.line2.currencyCode":"AUD",
"openinvoicedata.line2.description":"Socks",
"openinvoicedata.line2.itemAmount":"248",
"openinvoicedata.line2.itemVatAmount":"52",
"openinvoicedata.line2.numberOfItems":"1",
},
"reference":"YOUR_CAPTURE_REFERENCE"
}
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.
Refunds and cancellations
If a payment has not yet been captured, you can cancel it. If the Afterpay payment has already been captured and you want to return the funds to the shopper, you need to refund it.
Partial refunds
To partially refund a payment, specify in your /refund request:
-
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 /payments 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.
{
"merchantAccount":"YOUR_MERCHANT_ACCOUNT",
"originalReference":"COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE",
"modificationAmount":{
"currency":"EUR",
"value":"400"
},
"additionalData":{
"openinvoicedata.numberOfLines":"1",
"openinvoicedata.line1.currencyCode":"AUD",
"openinvoicedata.line1.description":"Shoes",
"openinvoicedata.line1.itemAmount":"331",
"openinvoicedata.line1.itemVatAmount":"69",
"openinvoicedata.line1.numberOfItems":"1"
},
"reference":"YOUR_REFUND_REFERENCE"
}
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:
- 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 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.