Accept an Afterpay or Clearpay payment
Learn how to accept Afterpay (also known as Clearpay in the UK), a payment method in the US, CA, UK, AU, and NZ.
Caution
Stripe automatically presents your customers payment method options by evaluating their currency, payment method restrictions, and other parameters. We recommend that you configure your payment methods from the Stripe Dashboard using the instructions in Accept a payment.
If you want to continue manually configuring the payment methods you present to your customers with Checkout, use this guide. Otherwise, update your integration to configure payment methods in the Dashboard.
Afterpay is a single use, immediate notification payment method that requires customers to authenticate their payment. Customers are redirected to the Afterpay site, where they agree to the terms of an installment plan. When the customer accepts the terms, Afterpay guarantees that the funds are available to the customer and transfers the funds to your Stripe account. The customer repays Afterpay directly over time.
Note
Before you start the integration, make sure your account is eligible for Afterpay by navigating to your Payment methods settings.
Determine compatibility
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.
Accept a payment
Note
This guide builds on the foundational accept a payment Checkout integration.
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:
- Add
afterpay_
to the list ofclearpay payment_
.method_ types - Make sure all your
line_
use your domestic currency.items - Collect shipping addresses by adding your country to
shipping_
. If you don’t collect shipping addresses with Checkout, provide the shipping address usingaddress_ collection[allowed_ countries] 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:
Event Name | Description | Next steps |
---|---|---|
checkout.session.completed | The customer successfully authorized the payment by submitting the Checkout form. | Wait for the payment to succeed or fail. |
payment_intent.succeeded | The customer’s payment succeeded. The PaymentIntent transitions to succeeded . | Fulfill the goods or services that the customer purchased. |
payment_intent.payment_failed | The customer’s payment was declined, or failed for some other reason. The PaymentIntent returns to the requires_ status. | Email the customer to request that they place a new order. |
Learn more about fulfilling orders.
Test your integration
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_
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_
to requires_
.
For manual capture PaymentIntents in testmode, the uncaptured PaymentIntent will auto-expire 10 minutes after successful authorization.
Failed payments
Afterpay takes into account multiple factors when deciding to accept or decline a transaction (for example, length of time buyer has been using Afterpay, outstanding amount customer has to repay, value of the current order).
You should always present additional payment options such as card
in your checkout flow, as Afterpay payments have a higher rate of decline than many payment methods. In these cases, the PaymentMethod is detached and the PaymentIntent object’s status automatically transitions to requires_
.
For an Afterpay PaymentIntent with a status of requires_
, customers need to complete the payment within 3 hours after you redirect them to the Afterpay site (this doesn’t apply to declined payments). If they take no action within 3 hours, the PaymentMethod detaches and the object status for the PaymentIntent automatically transitions to requires_
.
In these cases, inform your customer to try again with a different payment option presented in your checkout flow.
Error codes
These are the common error codes and corresponding recommended actions:
Error Code | Recommended Action |
---|---|
invalid_ | Enter an amount within Afterpay’s default transactions limits for the country. |
invalid_ | Enter an amount within Afterpay’s default transactions limits for the country. |
payment_ | Enter the appropriate currency. Afterpay only supports domestic transactions. |
missing_ | Check the error message for more information about the required parameter. |
nonexistent_ | Enter a valid two-letter ISO country code for the country property in the shipping and billing details. |
payment_ | Provide a return_ when confirming a PaymentIntent with Afterpay. |