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

Check a Mandate Status

After the customer signs a mandate, request the check mandate status service periodically to know when the status of a pending mandate updates.

You should request a mandate check status under these circumstances:

The customer is redirected to one of the merchant URLs that you included in the mandate service request.

The customer has not returned to the merchant URL within 35 minutes of being redirected to the mandate creation page.

If you are managing your mandates using a third-party mandate management system, you cannot use Cybersource to verify the status of a mandate.

Endpoints

Set the

apMandateStatusService_run

field to

true

, and send the request to one of these endpoints:

Production:

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

Test:

https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor

Response Statuses

The check mandate status service responds with one of these statuses in the

apMandateStatusReply_status

field:

Active

: The mandate is successfully created, updated, or imported. A direct debit can be sent for this mandate ID.

Expired

: The mandate deadline has passed.

Failed

: The customer was not authenticated.

Pending

: The mandate is not signed yet.

Revoked

: The mandate was cancelled.

The check mandate status service also responds with a reason code in the

apMandateStatusReply_reasonCode

field.

If Cybersource cannot find a mandate ID in the partner system, the system responds with a

150

error which indicates a general system failure. The mandate ID might not exist or is still in the signature flow process if it is a new mandate.

For more information about reason codes, see the Reason Codes for Bacs Direct Debits for the Simple Order API.

Back to top