Cash App Afterpay Drop-in integration

Our Android Drop-in renders Cash App Afterpay in your payment form, and redirects the shopper to complete the payment. As with other redirect payment methods, you need to check the payment result after the shopper returns to your app.

When making a Cash App Afterpay payment, you also need to:

1. Collect shopper details, and specify these in your payment request. Cash App Afterpay uses these for risk checks.
2. Provide information about the purchased items in your payment request.

Requirements

Show Cash App Afterpay in your payment form

Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.

To show Cash App Afterpay in your payment form, specify in your /paymentMethods request the following combination of countryCode and amount.currency::

Make a payment

When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod.

1. Pass the paymentComponentData.paymentMethod to your server.

2. From your server, make a /payments request, specifying:

   • paymentMethod: the paymentComponentData.paymentMethod from Drop-in.

   • shopperName: the shopper's full name. 

   • shopperEmail: the shopper's email address.  

   • telephoneNumber

     Optional
     : 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.  

   curlJavaPHPC#NodeJS (JavaScript)PythonRubycurlJavaPHPC#NodeJS (JavaScript)PythonRuby

   Expand view

   Copy link to code block

   Copy code

   Copy code

   curl https://checkout-test.adyen.com/checkout/v68/payments \
   -H 'x-api-key: ADYEN_API_KEY' \
   -H 'content-type: application/json' \
   -d '{
     "paymentMethod":{
        "type":"afterpaytouch_US"
     },
     "amount":{
        "value":1000,
        "currency":"USD"
     },
     "shopperName":{
        "firstName":"Simon",
        "lastName":"Hopper"
     },
     "shopperEmail":"`s.hopper@example.com`",
     "shopperReference":"YOUR_UNIQUE_SHOPPER_ID",
     "reference":"YOUR_ORDER_REFERENCE",
     "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
     "returnUrl":"adyencheckout://your.package.name",
     "countryCode":"US",
     "telephoneNumber":"+16123456789",
     "billingAddress":{
        "city":"San Francisco",
        "country":"US",
        "houseNumberOrName":"274",
        "postalCode":"94107",
        "stateOrProvince":"CA",
        "street":"Brennan St."
     },
     "deliveryAddress":{
        "city":"San Francisco",
        "country":"US",
        "houseNumberOrName":"274",
        "postalCode":"94107",
        "stateOrProvince":"CA",
        "street":"Brennan St."
     },
     "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"
        }
     ]
   }'

3. The /payments response includes the action object with information that you must use to redirect the shopper.

   /payments response

   Expand view

   Copy link to code block

   Copy code

   Copy code

   {
     "resultCode":"RedirectShopper",
     "action":{
       "paymentMethodType":"afterpaytouch_US",
       "method":"GET",
       "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
       "type":"redirect"
     }
   }

If your integration is set up correctly, the action object is passed from your server to the client.

Check the payment result

Drop-in redirects the shopper to complete the payment. When the shopper returns back to your app, Drop-in provides the actionComponentData object.

From your server, make a POST /payments/details request providing:

• details: The actionComponentData.details object from Drop-in.

curl https://checkout-test.adyen.com/checkout/v68/payments/details \
-H 'x-api-key: ADYEN_API_KEY' \
-H 'content-type: application/json' \
-d '{
     "details": {
       "redirectResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ=="
   }
}'

You receive a response containing:

• resultCode: Use this to present the payment result to your shopper.
• pspReference: Our unique identifier for the transaction.

{
     "resultCode": "Authorised",
     "pspReference": "PPKFQ89R6QRXGN82"
}

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 Cash App Afterpay are:

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

Capture the payment

Depending on your merchant account configuration, Cash App 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, Cash App 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, Cash App Afterpay cancels the payment and refunds the first installment to the shopper.

Partial captures

To partially capture a payment, in your  /payments/{paymentPspReference}/captures request specify:

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

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":"USD",
      "value":"700"
   },
   "additionalData":{
      "openinvoicedata.numberOfLines":"2",
      "openinvoicedata.line1.currencyCode":"USD",
      "openinvoicedata.line1.description":"Shoes",
      "openinvoicedata.line1.itemAmount":"331",
      "openinvoicedata.line1.itemVatAmount":"69",
      "openinvoicedata.line1.numberOfItems":"1",
      "openinvoicedata.line2.currencyCode":"USD",
      "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 a payment has already been captured and you want to return the funds to the shopper, you need to refund the payment.

Partial refunds

To partially refund a payment, in your /payments/{paymentPspReference}/refunds request specify:

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

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":"USD",
      "value":"400"
   },
   "additionalData":{
      "openinvoicedata.numberOfLines":"1",
      "openinvoicedata.line1.currencyCode":"USD",
      "openinvoicedata.line1.description":"Shoes",
      "openinvoicedata.line1.itemAmount":"331",
      "openinvoicedata.line1.itemVatAmount":"69",
      "openinvoicedata.line1.numberOfItems":"1"
   },
   "reference":"YOUR_REFUND_REFERENCE"
}

Discounts

To offer discounts, your payment request must include the negative amount to be added to the original price. The following example shows how to specify a discount of 1 USD on Item #2:

Copy code
{
  "amount":{
     "value":800,
     "currency":"USD"
  },
  ...
  "lineItems":[
 
     {
        "description":"Test Cash App Afterpay 1",
        "quantity":"1",
        "amountIncludingTax":"400",
        "id":"Item #1"
     },
     {
        "description":"Test Cash App 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 Cash App Afterpay payments, you need a test shopper account in the Afterpay sandbox environment.

To create a test account:

1. Go to https://portal.sandbox.afterpay.com/.
2. Enter a real email address and select Continue. You will get confirmations of payments and refunds like any other shopper on this email address.
3. From the drop-down menu, select the country/region for which you want to create a test shopper account: US.
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 will not 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 Cash App Afterpay payments, you need to submit a request for Cash App Afterpay in your live Customer Area.

See also