Welcome to Zuora Product Documentation

Explore our rich library of product information

Direct Debit UK (BACS)

This document provides guidance on creating and managing tokenized payment methods using Direct Debit UK (BACS) through various approaches, including API operations and hosted payment pages.

Approach

Description

Example

Create a payment method API operation

Option 1: Pass in existing tokens and masked account number

  • Pass in Stripe Customer Id through tokens > tokenId .

  • Pass in Stripe Payment Method Id through tokens > secondTokenId .

  • Pass in the masked account number through accountMaskNumber .

  • Pass in the other required fields:

    • type

    • accountHolderInfo

    • bankCode

For other optional fields, see Create a payment method .

Tokenizing BACS payment methods through this option is generally available in Sandbox environments. To enable it in Production environments, submit a request at Zuora Global Support .

{
   "accountKey": "402881868ab1b937018ab2314b91234a",
   "bankCode": "10880",
   "accountHolderInfo": {
            …
    },
    "type": "Bacs",
    "accountMaskNumber": "****2345",
    "tokens": {
        "gatewayType": "Stripe",
        "tokenId": "cus_xxxxxxxx",
        "secondTokenId": "pm_xxxxxxxx"
    }
}

Option 2: Pass in the account number and the fields that are required by Stripe for validating the tokenized payment method

  • Pass in the account number through accountNumber .

  • Pass in the following Gateway Options fields:

    • ipAddress

    • UserAgent

  • Pass in the other required fields:

    • type

    • accountHolderInfo

    • bankCode

For other optional fields, see Create a payment method .

Tokens will be generated and stored for the payment method.

{
    "accountNumber": "00012345",
    "accountKey": "402881868ab1b937018ab2314b91234a",
    "bankCode": "10880",
    "accountHolderInfo": {
            …
    },
    "type": "Bacs",
    "gatewayOptions": {
         "ipAddress": "3:3:3:3:3:3:2:1",
         "UserAgent": "Test123456"
    }
}

UI

Tokens will be automatically generated and stored for the payment method.

Hosted payment page

Tokens will be automatically generated and stored for the payment method.

For tokenized payment methods, you must validate them in Zuora so that payments made with these payment methods are successful. To validate tokenized payment methods, enable the following settings on the gateway instance configuration page:

  • Verify new payment method

  • Verify updated payment method