BACS Direct Debit for API only

You can add BACS Direct Debit to your existing integration. The following instructions show only what you must add to your integration specifically for BACS Direct Debit.

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.

Requirements

How it works

1. The shopper selects BACS Direct Debit as the payment method.
2. The shopper enters their details in the payment form that you build.
3. When you make the payment request, you include additional information about the items that the shopper intends to purchase.

Build your payment form

Include BACS Direct Debit in the list of available payment methods.

Get BACS Direct Debit as an available payment method

When you make the /paymentMethods to get available payment methods, specify the following so that BACS Direct Debit is included in the response.

Add additional parameters to your /payments request

When you make a payment, add the following parameters:

Parameter	Required	Description
shopperEmail		The email of the shopper.
paymentMethod.type		Set to directdebit_GB.
paymentMethod.holderName		The bank account holder's name.
paymentMethod.bankAccountNumber		The bank account holder's bank account number.
paymentMethod.bankLocationId		The bank routing number of the account.

The response includes the action.type: Direct.

Recurring payments

If you have a recurring or subscription business model, we recommend tokenizing the shopper's payment details. When you create a shopper token from a BACS Direct Debit payment, we store the shopper's payment details with the token. You can use this token to make recurring BACS Direct Debit payments.

You need to use the /payments endpoint to make recurring payments with the token.

Create shopper token

Tokenize the shopper's payment details when you make the initial BACS Direct Debit payment.

1. When you make a POST request to /payments to make a payment, additionally include:

• shopperReference: Your unique ID for this shopper.
• paymentMethod.storePaymentMethod: true.

2. When you receive the recurring.token.created, store the storedPaymentMethodId. This is the token you will need to make recurring payments for this shopper.

Make recurring payments

For each recurring payment for this shopper, make a BACS Direct Debit payment with a POST request to the /payments endpoint, and additionally include:

• paymentMethod.recurringDetailReference or paymentMethod.storedPaymentMethodIdfor API v49 and above. This is the storedPaymentMethodId returned in the recurring.token.created webhook when you created the token.
• shopperReference: the unique shopper ID you used to create the shopper token.
• shopperInteraction: ContAuth.

{
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
   "reference":"BACS test payment",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
   "shopperInteraction":"ContAuth",
   "amount":{
      "currency":"",
      "value":49900
   },
   "paymentMethod":{
      "type":"directdebit_GB",
      "storedPaymentMethodId":"7219687191761347"
   },
   "countryCode":"",
   "shopperLocale":"",
   "returnUrl":""
}

If the payment was successfully received the response will contain the resultCode Received and a pspReference, which is our unique identifier for this transaction. You can track whether the payment was successful using webhooks.

Test and go live

Before accepting live BACS Direct Debit payments, test your integration using the following details:

Check the status of BACS Direct Debit test payments in your Customer Area > Transactions > Payments.

Before you can accept live BACS Direct Debit payments, you need to submit a request for BACS Direct Debit in your live Customer Area.

See also