---
title: "List BACS direct debit mandates [beta]"
method: GET
path: "/v1/payments/bacs/directdebit/mandates"
tags: ["BACS direct debit"]
---

# List BACS direct debit mandates \[beta\]

`GET /v1/payments/bacs/directdebit/mandates`

## Request

- Base URL: `https://sandbox.pismolabs.io/bacs`
- URL: `https://sandbox.pismolabs.io/bacs/v1/payments/bacs/directdebit/mandates`
- Auth: none declared. Required headers: `Authorization`

List BACS direct debit mandates for an account. 

This endpoint takes an account token - an access token encoded with a Pismo account ID.  The account is parsed from the token.

## Query parameters

- `id` string
- `status` 'CREATED' | 'CANCELLED'
- `source` 'auddis' | 'non-electronic'
- `beginDate` string
- `endDate` string
- `afterId` string
- `pageSize` integer

## Headers

- `Authorization` string, required
- `x-cid` string

## Response `200`

Paginated list of direct debit mandates

- ListingMandateListResponse: Paginated list of BACS direct debit mandates.
  - `items` ListingMandate[]
    - `id` string: Form3-assigned mandate ID
    - `external_id` string: Form3-assigned mandate ID (omitted until submitted)
    - `org_id` string: Organization/tenant ID
    - `account_id` integer: Account ID
    - `role` 'PAYER' | 'PAYEE': Transaction role
    - `source` 'auddis' | 'non-electronic': Distinguishes electronic (AUDDIS) from paper mandates, per Form3's mandate `source` field. * `auddis` - electronic mandate * `non-electronic` - paper mandate
    - `status` 'CREATED' | 'SUBMITTED' | 'CONFIRMED' | 'AMEND_PENDING' | 'AMENDED' | 'CANCEL_PENDING' | 'CANCELLED' | 'FAILED': Mandate lifecycle status. * `CREATED` - Mandate persisted and imported into Form3; pending submission * `SUBMITTED` - Mandate submitted to the scheme * `CONFIRMED` - Mandate confirmed and active * `AMEND_PENDING` - Amend intent accepted; pending submission to Form3 * `AMENDED` - Amend confirmed * `CANCEL_PENDING` - Cancel intent accepted; pending submission to Form3 * `CANCELLED` - Mandate cancelled. Terminal state * `FAILED` - Mandate processing failed. Terminal state
    - `reference` string: Reference note
    - `form3_submission_id` string: Form 3 submission ID
    - `status_reason` ListingStatusReason: Present on rejections or returns.
      - `code` '1' | '2' | '3' | '5' | '6' | 'B' | 'C' | 'F' | 'G' | 'H' | 'I' | 'K': Reason for the return: * `1` - Instruction cancelled by payer * `2` - Payer deceased * `3` - Account transferred to a new bank or building society * `5` - No account. Handled automatically by Form3 when using Bacs Mandate Management. * `6` - No instruction. Handled automatically by Form3 when using Bacs Mandate Management. * `B` - Account closed * `C` - Account transferred to a different branch of the bank/building society * `F` - Invalid account type * `G` - Bank will not accept direct debits on account * `H` - Instruction has expired. Handled automatically by Form3 when using Bacs Mandate Management. * `I` - Payer reference is not unique. Handled automatically by Form3 when using Bacs Mandate Management. * `K` - Instruction cancelled by paying bank.
      - `description` string: Human-readable status reason.
    - `created_at` string, date-time: Created at date-time. RFC 3339 format
    - `updated_at` string, date-time: Updated at date-time. RFC 3339 format
  - `next_page` boolean: Are there more results?
  - `after_id` string: Pagination cursor to pass as query parameter to get the next page

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `500`: Internal Server Error

---

[API](https://skmtc.dev/pismo/apis/payment-rails-bacs-payments.md) - [All operations](https://skmtc.dev/pismo/apis/payment-rails-bacs-payments/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/payment-rails-bacs-payments/revisions/d0f145ee1aba?raw)