Afterpay for API only

Accept Afterpay payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Before you begin

These instructions explain how to add Afterpay to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.

Before starting your integration:

1. Make sure that you have set up your back end implementation.
2. Add Afterpay in your test Customer Area.

Build your payment form for Afterpay

If you're using /paymentMethods to show which payment methods are available to the shopper,
specify in your request 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

To perform risk checks, Afterpay requires you to collect the following shopper details:

• Full name
• Email address
• Billing address and delivery address.

Make a payment

Make a /payments request from your server, specifying:

• paymentMethod: afterpaytouch

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

The /payments response contains an action object with the information needed to redirect the shopper.

Handle the redirect

1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.

2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

   • details: Object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.

You receive a response containing:

• resultCode: Use this to present the 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 webhook.
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 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  /payments/paymentPspReference/captures 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 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.

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 /payments/paymentPspReference/refunds 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 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, specify in your payment request 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:

1. Go to https://portal.sandbox.afterpay.com/.
2. Enter a real email address and select 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 select 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 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.

See also