Accept an Afterpay or Clearpay payment

A Checkout Session must satisfy all of the following conditions to support Afterpay payments:

• You can only use one-time line items (recurring subscription plans are not supported).
• You must express Prices in your domestic currency.
• Shipping addresses must be provided.

Use this guide to learn how to enable Afterpay—it shows the differences between accepting a card payment and using Afterpay.

Enable Afterpay as a payment method

When creating a new Checkout Session, you need to:

1. Add afterpay_clearpay to the list of payment_method_types.
2. Make sure all your line_items use your domestic currency.
3. Collect shipping addresses by adding your country to shipping_address_collection[allowed_countries]. If you don’t collect shipping addresses with Checkout, provide the shipping address using payment_intent_data[shipping].

Stripe::Checkout::Session.create({
      mode: 'payment',
      payment_method_types: ['card'],
      payment_method_types: ['card', 'afterpay_clearpay'],
      line_items: [{
        price_data: {
          currency: 'usd',
          product_data: {
            name: 'T-shirt',
          },
          # Make sure the total amount fits within Afterpay transaction amount limits:
          # https://stripe.com/docs/payments/afterpay-clearpay#collection-schedule
          unit_amount: 2000,
        },
        quantity: 1,
      }],
      shipping_address_collection: {
        # Specify which shipping countries Checkout should provide as options for shipping locations
        allowed_countries: ['AU', 'CA', 'GB', 'NZ', 'US'],
      },
      # If you already have the shipping address, provide it in payment_intent_data:
      # payment_intent_data: {
      #   shipping: {
      #     name: 'Jenny Rosen',
      #     address: {
      #       line1: '1234 Main Street',
      #       city: 'San Francisco',
      #       state: 'CA',
      #       country: 'US',
      #       postal_code: '94111',
      #     },
      #   },
      # },
      success_url: 'https://example.com/success',
      cancel_url: 'https://example.com/cancel',
    })

Fulfill your orders

Use a method such as webhooks to handle order fulfillment, instead of relying on your customer to return to the payment status page.

The following events are sent when the payment status changes:

Learn more about fulfilling orders.

When testing your Checkout integration, select Afterpay as the payment method and click the Pay button.

Test your Afterpay integration with your test API keys by viewing the redirect page. You can test the successful payment case by authenticating the payment on the redirect page. The PaymentIntent will transition from requires_action to succeeded.

To test the case where the user fails to authenticate, use your test API keys and view the redirect page. On the redirect page, click Fail test payment. The PaymentIntent will transition from requires_action to requires_payment_method.

For manual capture PaymentIntents in testmode, the uncaptured PaymentIntent will auto-expire 10 minutes after successful authorization.