Save Bacs Direct Debit bank details

First, you need a Stripe account. Register now.

Use our official libraries for access to the Stripe API from your application:

# Available as a gem
sudo gem install stripe

# If you use bundler, you can add this line to your Gemfile
gem 'stripe'

To reuse a Bacs Direct Debit payment method for future payments, you must attach it to a Customer. Create a Customer object when someone creates an account with you and associate the ID of the Customer object with your own internal representation of a customer so you can use the stored payment method details later.

If your customer is making a payment as a guest, you can still create a Customer object before payment and associate it with your internal representation of their account later. If you have an existing Customer object, skip this step.

curl https://api.stripe.com/v1/customers \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -X "POST"

Before you can accept Direct Debit payments, your customer must provide their bank account information and give permission to debit their account (also known as a mandate) through Stripe Checkout.

Create a Checkout Session in setup mode to collect the required information. After your customer provides their payment method details, they’re redirected to the success_url, a page on your website that informs them that their payment method was saved successfully.

When your customer clicks on your logo in a Checkout Session without providing their payment method details, Checkout redirects them back to your website by navigating to the cancel_url. This is usually the page on your website that the customer viewed prior to redirecting to Stripe Checkout.

curl https://api.stripe.com/v1/checkout/sessions \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d "payment_method_types[]"="bacs_debit" \
  -d mode=setup \
  -d customer=
"{{CUSTOMER_ID}}" \
  -d success_url="https://example.com/success?session_id={CHECKOUT_SESSION_ID}" \
  -d cancel_url="https://example.com/cancel"

Make the Session ID available on your success page by including the {CHECKOUT_SESSION_ID} template variable in the success_url as in the above example.

To use Checkout on your website, add a snippet of code that includes the Checkout Session ID from the previous step (Checkout relies on Stripe.js). Include the following script tag on your website, and always load it directly from https://js.stripe.com.

<script src="https://js.stripe.com/v3/"></script>

Create an instance of the Stripe object using your publishable API key.

var stripe = Stripe(
'pk_test_TYooMQauvdEDq54NiTphI7jx');

When your customer is ready to save or update their payment method, call redirectToCheckout using the Checkout Session ID.

var stripe = Stripe(
'pk_test_TYooMQauvdEDq54NiTphI7jx');
var checkoutButton = document.getElementById('checkout-button');

checkoutButton.addEventListener('click', function() {
  stripe.redirectToCheckout({
    // Make the id field from the Checkout Session creation API response
    // available to this file, so you can provide it as argument here
    // instead of the {{CHECKOUT_SESSION_ID}} placeholder.
    sessionId: '{{CHECKOUT_SESSION_ID}}'
  }).then(function (result) {
    // If `redirectToCheckout` fails due to a browser or network
    // error, display the localized error message to your customer
    // using `result.error.message`.
  });
});

An event handler typically invokes this code as the result of an action taken by your customer (e.g., clicking on an Save payment method button).

After a customer submits their payment details, retrieve the PaymentMethod object. A PaymentMethod stores the customer’s bank account information for future payments. You can retrieve the PaymentMethod synchronously using the success_url or asynchronously using webhooks.

The decision to retrieve the PaymentMethod synchronously or asynchronously depends on your tolerance for dropoff, as customers may not always reach the success_url after a successful payment (e.g., it’s possible for them close their browser tab before the redirect occurs). Using webhooks prevents your integration from experiencing this form of dropoff.

{
  "id": "evt_1Ep24XHssDVaQm2PpwS19Yt0",
  "object": "event",
  "api_version": "2019-03-14",
  "created": 1561420781,
  "data": {
    "object": {
      "id": "cs_test_MlZAaTXUMHjWZ7DcXjusJnDU4MxPalbtL5eYrmS2GKxqscDtpJq8QM0k",
      "object": "checkout.session",
      "billing_address_collection": null,
      "cancel_url": "https://example.com/cancel",
      "client_reference_id": null,
      "customer": null,
      "customer_email": null,
      "display_items": [],
      "mode": "setup",
      "setup_intent": "seti_1EzVO3HssDVaQm2PJjXHmLlM",
      "submit_type": null,
      "subscription": null,
      "success_url": "https://example.com/success"
    }
  },
  "livemode": false,
  "pending_webhooks": 1,
  "request": {
    "id": null,
    "idempotency_key": null
  },
  "type": "checkout.session.completed"
}

curl https://api.stripe.com/v1/setup_intents/seti_1EzVO3HssDVaQm2PJjXHmLlM \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:

Once the Checkout Session completes, payment details are submitted to the bank as a mandate.

The mandate can change at any time after you’ve collected it. This may be the result of the customer instructing their bank to amend the mandate or because of a change in the bank itself (e.g., the customer changes to a different one). Stripe sends the following events when the mandate changes:

These events are available in the Dashboard, but you can set up a webhook endpoint to handle these programatically.

There are several test bank account numbers you can use in test mode to make sure this integration is ready.

You can test using any of the account numbers provided above. However, because Bacs Direct Debit payments take several days to process, use the test account numbers that operate on a three-minute delay to better simulate the behavior of live payments.

After you set up a PaymentMethod, you can accept future Bacs Direct Debit payments by creating and confirming a PaymentIntent.

curl https://api.stripe.com/v1/payment_intents \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d "payment_method_types[]"="bacs_debit" \
  -d payment_method=
"{{PAYMENT_METHOD_ID}}" \
  -d customer=
"{{CUSTOMER_ID}}" \
  -d confirm=true \
  -d amount=100 \
  -d currency=gbp