API Overview

Bacs UK Direct Debit for Alternative Payment Processing Developer Guide
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to Direct Debits
- Mandate Requirements
- Handling Mandates Passed Through Third-Party Systems
- Direct Debit Batching Schedule
- Chargebacks
- Execution Date and Refund Period

Overview of Processing Direct Debits
- Create a Mandate Workflow
- Update a Mandate Workflow
- Revoke a Mandate Workflow
- Import a Mandate Workflow
- Process a Sale Workflow
- Cancel a Direct Debit Workflow
- Refund a Direct Debit Workflow
- Create a Mandate Statuses Workflow
- Import a Mandate Statuses Workflow
- Process a Sale Statuses Workflow

Requesting Direct Debits
- Create a Mandate
  - Required Fields for Creating a Mandate
  - Optional Fields for Creating a Mandate
  - Test Triggers for Creating a Mandate
  - Simple Order Example: Creating a Mandate
- Update a Mandate
  - Required Fields for Updating a Mandate
  - Optional Fields for Updating a Mandate
  - Test Triggers for Updating a Mandate
  - Simple Order Example: Updating a Mandate
- Import a Mandate
  - Required Fields for Importing a Mandate
  - Optional Fields for Importing a Mandate
  - Test Triggers for Importing a Mandate
  - Simple Order Example: Importing a Mandate Service
- Revoke a Mandate
  - Required Fields for Revoking a Mandate
  - Optional Field for Revoking a Mandate
  - Test Triggers for Revoking a Mandate
  - Simple Order Example: Revoking a Mandate
- Check a Mandate Status
  - Required Fields for Checking a Mandate Status
  - Simple Order Example: Checking Mandate Status
- Process a Direct Debit Sale
  - Required Fields for Processing a Direct Debit
  - Test Triggers for Processing Direct Debits
  - Simple Order Example: Processing a Direct Debit
- Check a Direct Debit Status
  - Required Fields for Checking Direct Debit Status
  - Test Triggers for Checking Statuses
  - Simple Order Example: Checking Direct Debit Status
- Cancel a Direct Debit
  - Required Fields for Cancelling a Direct Debit
  - Test Triggers for Cancelling a Direct Debit
  - Simple Order Example: Cancelling a Direct Debit
- Refund a Direct Debit
  - Required Fields for Refunding a Direct Debit
  - Test Triggers for Refunds
  - Simple Order Example: Refunding a Direct Debit

Reference Information
- Merchant Account Types
- Reason Codes for Bacs Direct Debits for the Simple Order API
- Export Compliance Reason Codes
- Generating Reports Using the Business Center
- Terminology

Simple Order Example: Importing a Mandate Service

Request

1234567891011121314151617181920212223
<="urn:schemas-cybersource-com:transaction-data-1.214">
	<merchantID>test-merchant</merchantID>
	<merchantReferenceCode>refnum-1234</merchantReferenceCode>
	<paymentScheme>bacs</paymentScheme>
	<mandateID>12345678912345</mandateID>
	<billTo>
		<firstName>John</firstName>
		<lastName>Smith</lastName>
		<street1>321 Trafalgar Square</street1>
		<city>Sunnyville</city>
		<postalCode>55555</postalCode>
		<country>UK</country>
		<email>test@cybs.com</email>
		<customerID>ddd09876543212434</customerID>
	</billTo>
	<fundTransfer>
            <iban>GB82HLFX11087412413569</iban>
       </fundTransfer>
	<apPaymentType>STL</apPaymentType>
	<apImportMandateService run="true">
		<dateSigned>20240220</dateSigned>
	</apImportMandateService>
</>

Response to a Successful Request

1234567891011121314151617
<:c="urn:schemas-cybersource-com:transaction-data-1.214">
    <merchantReferenceCode>refnum-1234</merchantReferenceCode>
    <requestID>7084683629286990803007</requestID>
    <decision>ACCEPT</decision>
    <reasonCode>100</reasonCode>
    <requestToken>Axin7wSTgA+8cJLsU/A///8ZYjWmdmnTkx5TiwnvvwyjXoA/Thk0ky9GK/uLAD6TgA+8cJLsU/A/AAAA9xPv</requestToken>
    <apImportMandateReply>
        <reasonCode>100</reasonCode>
        <mandateID>AKXEASSG5J5Z</mandateID>
        <status>ACTIVE</status>
        <responseCode>00015</responseCode>
        <processorTransactionID>b1344353-cb24-4d19-b27e-f43bc1963613</processorTransactionID>
        <dateSigned>20240220</dateSigned>
        <dateCreated>20240220</dateCreated>
        <dateTime>2024-02-20T22:32:44Z</dateTime>
    </apImportMandateReply>
</>