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

On This Page

Required Fields for Cancelling a Direct Debit

apCancelService_run: Set to
true
.
apCancelService_saleRequestID: Set to the request ID from the sale response.
apPaymentType: Set to
STL
.
merchantID
merchantReferenceCode

Back to top