Set up future PayTo paymentsInvite only

Learn how to set up future PayTo payments.

PayTo allows customers in Australia to authenticate PayTo agreements for one-off and recurring payments in their banking apps. Customers pay with PayTo by receiving notification of a pending agreement request, authorising the terms of the agreement, then returning to your app.

Setting up a PayTo agreement for future payments allows you to get customer authorisation now for collecting future payments. Customers can view, manage, pause, and cancel their PayTo agreements in their banking apps.

Caution

Stripe doesn’t support modification or pausing of PayTo agreements by customers. If a customer attempts to pause or modify an agreement, we cancel the agreement and send you a mandate.updated webhook. After receiving the webhook, you can contact your customer to find out why they adjusted their agreement, as well as set up a new agreement.

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.

Set up Stripe
Server-side

First, you need a Stripe account. Register now.

To access the Stripe API from your application, use our official libraries:

Create a Customer
Server-side

Create a Customer after they create an account with your business and associate it with your internal representation of their account. This enables you to retrieve and use their saved payment method details later.

Create a SetupIntent
Server-side

A SetupIntent is an object that represents your intent to collect a future payment from a customer and tracks the authorisation process. To create a SetupIntent that accepts a PayTo payment method, specify the terms of the agreement, and payto in the payment_method_types list. If you maintain a list of payment method types that you pass when creating a SetupIntent, add payto to it.

Specify the terms of the agreement you want your customer to agree to using payment method options.

Stripe supports various types of agreements, with controls for the amount, duration, cadence, and purpose of the agreement. Specify agreement terms that match your requirements as closely as possible – customers see these precise terms at authorisation time, so accuracy can improve your conversion rate.

Beta

The default purpose is set to retail. Override this field using any of the valid values if retail doesn’t accurately represent the purpose of the agreement.

Retrieve the client secret

The SetupIntent includes a client secret that the client side uses to securely complete the payment process. You can use different approaches to pass the client secret to the client side.

Retrieve the client secret from an endpoint on your server, using the browser’s fetch function. This approach is best if your client side is a single-page application, particularly one built with a modern front-end framework such as React. Create the server endpoint that serves the client secret:

And then fetch the client secret with JavaScript on the client side:

(async () => {
  const response = await fetch('/secret');
  const {client_secret: clientSecret} = await response.json();
  // Render the form using the clientSecret
})();

Collect payment method details and submit the request for authorisation
Client-side

Collect payment details on the client with the Payment Element. The Payment Element is a pre-built UI component that simplifies collecting payment details for a variety of payment methods.

The Payment Element contains an iframe that securely sends payment information to Stripe over an HTTPS connection. Avoid placing the Payment Element within another iframe because some payment methods require redirecting to another page for payment confirmation.

The checkout page address must start with https:// rather than http:// for your integration to work. You can test your integration without using HTTPS, but remember to enable it when you’re ready to accept live payments.

Set up Stripe.js

The Payment Element is automatically available as a feature of Stripe.js. Include the Stripe.js script on your checkout page by adding it to the head of your HTML file. Always load Stripe.js directly from js.stripe.com to remain PCI compliant. Don’t include the script in a bundle or host a copy of it yourself.

checkout.html
<head>
  <title>Checkout</title>
  <script src="https://js.stripe.com/v3/"></script>
</head>

Create an instance of Stripe with the following JavaScript on your checkout page:

checkout.js
// Set your publishable key: remember to change this to your live publishable key in production
// See your keys here: https://dashboard.stripe.com/apikeys
const stripe = Stripe('pk_test_TYooMQauvdEDq54NiTphI7jx'
, {
  betas: 'payto_pm_beta_1',
});

Add the Payment Element to your payment page

The Payment Element needs a place to live on your payment page. Create an empty DOM node (container) with a unique ID in your payment form:

checkout.html
<form id="payment-form">
  <div id="payment-element">
    <!-- Elements will create form elements here -->
  </div>
  <button id="submit">Submit</button>
  <div id="error-message">
    <!-- Display error message to your customers here -->
  </div>
</form>

When the previous form loads, create an instance of the Payment Element and mount it to the container DOM node. Pass the client secret from the previous step into options when you create the Elements instance:

Handle the client secret carefully because it can complete the charge. Don’t log it, embed it in URLs, or expose it to anyone but the customer.

checkout.js
const options = {
  clientSecret: '{{CLIENT_SECRET}}',
  // Fully customizable with appearance API.
  appearance: {/*...*/},
};

// Set up Stripe.js and Elements to use in checkout form, passing the client secret obtained in a previous step
const elements = stripe.elements(options);
// Optional: Autofill user's saved payment methods. If the customer's
// email is known when the page is loaded, you can pass the email
// to the linkAuthenticationElement on mount:
//
//   linkAuthenticationElement.mount("#link-authentication-element",  {
//     defaultValues: {
//       email: 'jenny.rosen@example.com',
//     }
//   })

// Create and mount the Payment Element
const paymentElementOptions = { layout: 'accordion'};
const paymentElement = elements.create('payment', paymentElementOptions);
paymentElement.mount('#payment-element');

Use stripe.confirmSetup to complete the setup using details from the Payment Element. This sends an authorisation request to the buyer.

Note

stripe.confirmSetup might take several seconds to complete while waiting for customers to authorise the payment. During that time, disable your form from being resubmitted and show a waiting indicator like a spinner. If you receive an error, show it to the customer, re-enable the form, and hide the waiting indicator.

checkout.js
const form = document.getElementById('payment-form');

form.addEventListener('submit', async (event) => {
  event.preventDefault();

  const {error, setupIntent} = await stripe.confirmSetup({
    //`Elements` instance that was used to create the Payment Element
    elements,
    redirect: 'if_required',
    confirmParams: {
      mandate_data: {
      customer_acceptance: {
          type: 'online',
          online: {
            infer_from_client: true,
          },
        },
      }
    }
  });

  const message = document.querySelector('#message')
  if (error) {
    // This point will only be reached if there is an immediate error when
    // confirming the SetupIntent. Show error to your customer (for example, payment
    // details incomplete)
    message.innerText = error.message;
  } else {
    // This will execute if the confirm request is successful, or if the
    // setup fails asynchronously.
    switch (setupIntent.status) {
      case 'succeeded':
        message.innerText = 'Success! Payment received.';
        break;

      case 'processing':
        message.innerText = "Payment processing. We'll update you when payment is received.";
        break;

      case 'requires_payment_method':
        message.innerText = 'Payment failed. Please try another payment method.';
        // Redirect your user back to your payment page to attempt collecting
        // payment details again
        break;

      default:
        message.innerText = 'Something went wrong.';
        break;
    }
  }
});

Charge the PayTo PaymentMethod later

When you need to charge your customer, create a new PaymentIntent. Find the mandate ID, customer ID, and payment method ID by retrieving the previous SetupIntent.

View the necessary IDs in the response below.

{
  // ...
  "customer": "cus_PW6rQWRGAaBD7z",  // <---- Here is the customer
  "mandate": "mandate_1Ok6ZrA8DuEjWaGw2nrO9xeS", // <---- Here is the mandate
  "metadata": {},
  "next_action": null,
  "on_behalf_of": null,
  "payment_method": "pm_1Ok4l9A8DuEjWaGwhB4SGrWh", // <---- Here is the payment method
  "payment_method_configuration_details": null,
  "payment_method_options": {
    "payto": {
      "mandate_options": {
        "amount": 150000,
        "amount_type": "maximum",
        "start_date": "2026-12-25",
        "end_date": "2036-12-25",
        "payment_schedule": "annual",
        "payments_per_period": 13,
        "purpose": "mortgage",
      }
    }
  },
  "payment_method_types": [
    "payto"
  ],
  "single_use_mandate": null,
  "status": "succeeded",
  "usage": "off_session"
  // ...
}

Create a PaymentIntent with the PaymentMethod, Mandate, and Customer IDs.

Test your integration

Test your PayTo integration with your test API keys by using the various test PayIDs and bank account details below. Each set of details results in a different scenario your integration might commonly face in live mode.

PayID	Description

`{any_prefix}+succeed@{any_domain}`	The PaymentIntent status transitions from `requires_action` to `processing` after 60 seconds, then transitions to `succeeded` after an additional 2 seconds. The mandate enters an `active` state.
`{any_prefix}+decline@{any_domain}`	The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 60 seconds. Stripe returns the `payment_method_provider_decline` error code and an `invalid_authorization` decline code. The mandate enters an `inactive` state.
`{any_prefix}+expire@{any_domain}`	The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 5 minutes. Stripe returns the `payment_method_provider_decline` error code and a `generic_decline` decline code. The mandate enters an `inactive` state.
`{any_prefix}+insufficient_funds@{any_domain}`	The PaymentIntent status transitions from `requires_action` to `processing` after 60 seconds, then transitions to `requires_payment_method` after an additional 2 seconds. Stripe returns the `payment_method_provider_decline` error code and an `insufficient_funds` decline code. The mandate enters an `inactive` state.
`{any_prefix}+revoke@{any_domain}`	The PaymentIntent status transitions from `requires_action` to `processing` after 60 seconds then to `succeeded` after a further 2 seconds. The mandate begins in an `active` state and transitions to `inactive` after 5 minutes.

Set up future PayTo paymentsInvite only

Learn how to set up future PayTo payments.

Caution

Caution

Set up StripeServer-side

Create a CustomerServer-side

Create a SetupIntentServer-side

Beta

Retrieve the client secret

Collect payment method details and submit the request for authorisationClient-side

Set up Stripe.js

Add the Payment Element to your payment page

Note

Charge the PayTo PaymentMethod later

Test your integration

OptionalHandle post-payment events

Set up Stripe
Server-side

Create a Customer
Server-side

Create a SetupIntent
Server-side

Collect payment method details and submit the request for authorisation
Client-side