Are you looking for test card numbers?

Would you like to contact support?

No momento, esta página não está disponível em português
Payment-method icon

Afterpay Drop-in integration

Add Afterpay to anexisting iOS Drop-in integration.

On this page, you can find additional configuration for adding Afterpay to your Drop-in integration.

Before you begin

This page assumes you've already:

API reference

Select which endpoint you're integrating:

This is the default with Drop-in v5.0.0 or later.
Parameter name Required Description
shopperName -white_check_mark- The shopper's full name.
shopperEmail -white_check_mark- The shopper's email address.
shopperReference -white_check_mark- A unique reference to identify the shopper. Minimum length: three characters.
countryCode -white_check_mark- The shopper's country.
billingAddress -white_check_mark- The postal address to be included on the invoice.
deliveryAddress -white_check_mark- The postal address where the goods will be shipped.
lineItems -white_check_mark- Price and product information about the purchased items.  
telephoneNumber The shopper's telephone number, if provided.
curl https://checkout-test.adyen.com/v69/sessions \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "amount":{
     "value":1000,
     "currency":"AUD"
  },
  "shopperName":{
     "firstName":"",
     "lastName":""
  },
  "shopperEmail":"s.hopper@example.com",
  "shopperReference":"",
  "reference":"YOUR_ORDER_REFERENCE",
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "returnUrl":"my-app://",
  "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"
     }
  ]
}'
Client client = new Client("Your X-API-KEY", Environment.TEST);
Checkout checkout = new Checkout(client);

CreateCheckoutSessionRequest sessionRequest = new CreateCheckoutSessionRequest();
sessionRequest.setMerchantAccount("YOUR_MERCHANT_ACCOUNT");
sessionRequest.setReference("YOUR_ORDER_REFERENCE");

Amount amount = new Amount();
amount.setCurrency("AUD");
amount.setValue(1000L);
sessionRequest.setAmount(amount);

sessionRequest.setCountryCode("AU");
sessionRequest.setTelephoneNumber("+61 2 8520 3890");
sessionRequest.setShopperEmail("s.hopper@example.com");

Name shopperName = new Name();
shopperName.setFirstName("");
shopperName.setLastName("");
sessionRequest.setShopperName(shopperName);

sessionRequest.setShopperReference("");

Address billingAddress = new Address();
billingAddress.setCity("Sydney");
billingAddress.setCountry("AU");
billingAddress.setHouseNumberOrName("123");
billingAddress.setPostalCode("2000");
billingAddress.setStateOrProvince("NSW");
billingAddress.setStreet("Happy Street");
sessionRequest.setBillingAddress(billingAddress);

Address deliveryAddress = new Address();
deliveryAddress.setCity("Sydney");
deliveryAddress.setCountry("AU");
deliveryAddress.setHouseNumberOrName("123");
deliveryAddress.setPostalCode("2000");
deliveryAddress.setStateOrProvince("NSW");
deliveryAddress.setStreet("Happy Street");
sessionRequest.setDeliveryAddress(deliveryAddress);

sessionRequest.returnUrl("my-app://");

LineItem lineItem1 = new LineItem();
lineItem1.setQuantity(1L);
lineItem1.setAmountExcludingTax(331L);
lineItem1.setDescription("Shoes");
lineItem1.setId("Item #1");
lineItem1.setTaxAmount(69L);
lineItem1.setAmountIncludingTax(400L);

LineItem lineItem2 = new LineItem();
lineItem2.setQuantity(2L);
lineItem2.setAmountExcludingTax(248L);
lineItem2.setDescription("Socks");
lineItem2.setId("Item #2");
lineItem2.setTaxAmount(52L);
lineItem2.setAmountIncludingTax(300L);

List<LineItem> lineItems = new ArrayList<LineItem>();
lineItems.add(lineItem1);
lineItems.add(lineItem2);
sessionRequest.setLineItems(lineItems);

CreateCheckoutSessionResponse sessionResponse = checkout.sessions(sessionRequest);
var paymentRequest = new PaymentRequest
{
    MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
    Reference = "YOUR_ORDER_REFERENCE",
    Amount = {
    Currency = "AUD",
    Value = 1000
  },
    CountryCode = "AU",
    TelephoneNumber = "+61 2 8520 3890",
    ShopperEmail = "s.hopper@example.com",
    ShopperName = {
    FirstName = "",
    LastName = ""
  },
    ShopperReference = "",
    BillingAddress = {
    City = "Sydney",
    Country = "AU",
    HouseNumberOrName = "123",
    StateOrProvince = "NSW",
    PostalCode = "2000",
    Street = "Happy Street"
  },
    DeliveryAddress = {
    City = "Sydney",
    Country = "AU",
    HouseNumberOrName = "123",
    StateOrProvince = "NSW",
    PostalCode = "2000",
    Street = "Happy Street"
  },
    ReturnUrl = "my-app://",
    LineItems = new System.Collections.Generic.List<LineItem> {
    new LineItem {
      Quantity = 1,
        AmountExcludingTax = 331,
        Description = "Shoes",
        Id = "Item #1",
        TaxAmount = 69,
        AmountIncludingTax = 400
    },
    new LineItem {
      Quantity = 2,
        AmountExcludingTax = 248,
        Description = "Socks",
        Id = "Item #2",
        TaxAmount = 52,
        AmountIncludingTax = 300
    }
  }
};

Drop-in configuration

If your integration uses iOS Components v5.0.0 or later, configure and create an instance of the Afterpay Component:
//Create a payment method object for Afterpay.
let paymentMethod = paymentMethods.paymentMethod(ofType: afterpaytouchComponentPaymentMethod.self)
//Create a configuration object for the Afterpay Component.
var afterpaytouchComponentConfiguration = afterpaytouchComponent.Configuration()
//Set additional parameters on the configuration object.
afterpaytouchComponentConfiguration.localizationParameters = //Optional custom localization parameters.
There is no required Afterpay specific integration for Components.

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.

For testing purposes, Afterpay authorisation expires in one day. When you use manual capture, Afterpay payments have to be captured within one day after authorisation.

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.

/capture 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.

To set up multiple partial captures, contact our Support Team. Multiple partial captures will create a new invoice for each capture. 

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.

/refund request
{
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
   "originalReference":"COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE",
   "modificationAmount":{
      "currency":"AUD",
      "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 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