Skip to content
Create account or Sign in
The Stripe Docs logo
/
Create accountSign in

Accept a payment and save a mandate for future PayTo payments

Learn how to collect a PayTo payment and authorise future payments.

PayTo allows customers in Australia to authenticate PayTo mandates for one-off and recurring payments in their banking apps. Customers pay with PayTo by receiving notification of a pending mandate request, authorising the terms of the mandate, then returning to your app where you get delayed notification on whether the payment succeeded or failed.

Setting up a PayTo mandate for future payments allows you to collect future recurring payments without needing customer authorisation again. Customers can view, manage, pause, and cancel their PayTo mandates in their banking apps.

Caution

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

Accepting PayTo payments on your website consists of creating an object to track a payment, collecting payment method information and mandate acknowledgement and submitting the payment to Stripe for processing. Stripe uses this payment object, the PaymentIntent, to track and handle all the states of the payment until the payment completes.

Determine compatibility

To support PayTo payments in Checkout, express all Prices for all line items in AUD (currency code aud).

Accept a payment

Note

This guide builds on the foundational accept a payment Checkout integration.

To enable Payto as a payment method, create a new Checkout Session:

  1. Add payto to the list of payment_method_types.
  2. Make sure all your line_items use the aud currency.
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
Stripe::Checkout::Session.create({
  mode: 'payment',
  payment_method_types: ['card'],
  payment_method_types: ['card', 'payto'],
  line_items: [{
    price_data: {
      currency: 'aud',
      product_data: {
        name: 'T-shirt',
      },
      unit_amount: 2000,
    },
    quantity: 1,
  }],
  payment_method_options: {
    payto: {
      setup_future_usage: 'off_session',
      mandate_options: {
        amount_type: 'maximum',
        amount: 10000,
        payment_schedule: 'adhoc'
      }
    }
  },
  success_url: 'https://example.com/success',
  cancel_url: 'https://example.com/cancel'
})

Fulfill your orders

After accepting a payment, learn how to fulfil orders.

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.

PayIDDescription
{any_prefix}+succeed@{any_domain}The PaymentIntent status transitions from requires_action to processing after 10 seconds, then transitions to succeeded after an additional 5 seconds. The mandate enters an active state.
{any_prefix}+decline@{any_domain}The PaymentIntent status transitions from requires_action to requires_payment_method after 10 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 10 seconds. 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 10 seconds, then transitions to requires_payment_method after an additional 5 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 10 seconds then to succeeded after a further 5 seconds. The mandate begins in an active state and transitions to inactive after 1 minute.
{any_prefix}+agreement_type_not_supported@{any_domain}The PaymentIntent status transitions from requires_action to requires_payment_method after 10 seconds. Stripe returns the payment_method_provider_decline error code. The mandate enters an inactive state.
Was this page helpful?
YesNo