Accept an Afterpay or Clearpay payment

When a customer exits your app (for example to authenticate in Safari or their banking app), provide a way for them to automatically return to your app. Many payment method types require a return URL. If you don’t provide one, we can’t present payment methods that require a return URL to your users, even if you’ve enabled them.

To provide a return URL:

1. Register a custom URL. Universal links aren’t supported.
2. Configure your custom URL.
3. Set up your root component to forward the URL to the Stripe SDK as shown below.

import { useEffect, useCallback } from 'react';
import { Linking } from 'react-native';
import { useStripe } from '@stripe/stripe-react-native';

export default function MyApp() {
  const { handleURLCallback } = useStripe();

  const handleDeepLink = useCallback(
    async (url: string | null) => {
      if (url) {
        const stripeHandled = await handleURLCallback(url);
        if (stripeHandled) {
          // This was a Stripe URL - you can return or add extra handling here as you see fit
        } else {
          // This was NOT a Stripe URL – handle as you normally would
        }
      }
    },
    [handleURLCallback]
  );

  useEffect(() => {
    const getUrlAsync = async () => {
      const initialUrl = await Linking.getInitialURL();
      handleDeepLink(initialUrl);
    };

    getUrlAsync();

    const deepLinkListener = Linking.addEventListener(
      'url',
      (event: { url: string }) => {
        handleDeepLink(event.url);
      }
    );

    return () => deepLinkListener.remove();
  }, [handleDeepLink]);

  return (
    <View>
      <AwesomeAppComponent />
    </View>
  );
}

For more information on native URL schemes, refer to the Android and iOS docs.

You can optionally accept line item data to provide more risk signals to Afterpay. This feature is currently in private beta. To request access, contact us.

Unlike separate authorisation and capture for card payments, Afterpay charges the customer the first instalment of the payment at the time of authorisation. You then have up to 13 days after authorisation to capture the rest of the payment. If you don’t capture the payment in this window, the customer receives a refund of the first instalment, and they aren’t charged for any further instalments. In these cases, Stripe also cancels the PaymentIntent and sends a payment_intent.canceled event.

If you know that you can’t capture the payment, we recommend cancelling the PaymentIntent instead of waiting for the 13-day window to elapse. Proactively cancelling the PaymentIntent immediately refunds the first instalment to your customer, avoiding any confusion about charges on their statement.

Tell Stripe to authorize only

To indicate that you want separate authorisation and capture, set capture_method to manual when creating the PaymentIntent. This parameter instructs Stripe to only authorise the amount on the customer’s Afterpay account.

curl https://api.stripe.com/v1/payment_intents \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "amount"=1099 \
  -d "currency"="usd" \
  -d "payment_method_types[]"="afterpay_clearpay" \
  -d "capture_method"="manual" \
  -d "shipping[name]"="Jenny Rosen" \
  -d "shipping[address][line1]"="1234 Main Street" \
  -d "shipping[address][city]"="San Francisco" \
  -d "shipping[address][state]"="CA" \
  -d "shipping[address][country]"="US" \
  -d "shipping[address][postal_code]"=94111

Upon authorisation success, Stripe sends a payment_intent.amount_capturable_updated event. Check out our Events guide for how it may help.

Capture the funds

After the authorisation succeeds, the PaymentIntent status transitions to requires_capture. To capture the authorised funds, make a PaymentIntent capture request. The total authorised amount is captured by default – you can’t capture more than this, but you can capture less.

curl https://api.stripe.com/v1/payment_intents/
{{PAYMENT_INTENT_ID}}
/capture \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount_to_capture=750

Optional Cancel the authorisation

If you need to cancel an authorisation, you can cancel the PaymentIntent.

Stripe sends a payment_intent.succeeded event when the payment completes. Use the Dashboard, a custom webhook, or a partner solution to receive these events and run actions, like sending an order confirmation email to your customer, logging the sale in a database, or starting a shipping workflow.

Listen for these events rather than waiting on a callback from the client. On the client, the customer could close the browser window or quit the app before the callback executes, and malicious clients could manipulate the response. Setting up your integration to listen for asynchronous events also helps you accept more payment methods in the future. Learn about the differences between all supported payment methods.

• Handle events manually in the Dashboard

  Use the Dashboard to View your test payments in the Dashboard, send email receipts, handle payouts or retry failed payments.

• Build a custom webhook

  Build a custom webhook handler to listen for events and build custom asynchronous payment flows. Test and debug your webhook integration locally with the Stripe CLI.

• Integrate a prebuilt app

  Handle common business events, such as automation or marketing and sales, by integrating a partner application.

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.