BACS Direct Debit for API only

Accept BACS Direct Debit payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Requirements

Build your payment form for BACS Direct Debit

Include BACS Direct Debit in the list of available payment methods. You do not need to collect any information from the shopper in your payment form.

If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:

• countryCode: GB
• amount.currency: GBP.
• channel: Specify Web, iOS, or Android.

The response contains paymentMethod.type: directdebit_GB.

Make a payment

In your /payments request, specify:

• paymentMethod.type: directdebit_GB
• paymentMethod.holderName: Name of the account holder.
• paymentMethod.bankAccountNumber: The bank account number.
• paymentMethod.bankLocationId: The unique identifier (sort code) for a bank location.
• shopperEmail: The shopper's email address.

For a received payment, the /payments response contains the action.url that you need in the next step.

{
    "resultCode": "Received",
    "action": {
        "type": "voucher",
        "paymentMethodType": "directdebit_GB",
        "url": "PDF_MANDATE_URL"
    }
}

Present the payment result

Use the  resultCode that you received in the /payments response to present the payment result to your shopper.

The resultCode values you can receive for BACS Direct Debit are:

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 payment, we store the shopper's payment details with the token. You can use this token to make recurring 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 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_CONTRACT webhook, store the pspReference. 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 pspReference returned in the RECURRING_CONTRACT webhook when you created the token.
• shopperReference: The same 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 payments, test your integration using the following details:

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

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

See also