PIpismo
BACS direct debit

List BACS direct debit mandates [beta]

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.

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

Query parameters

idstring

Transaction or mandate ID filter

status'CREATED' | 'CANCELLED'

Mandate status filter.

source'auddis' | 'non-electronic'

Mandate source filter:

  • auddis - Electronic
  • non-electronic - Paper<br /> Default is all.
beginDatestring
Example:2026-08-01T00:00:00Z

Return records created on or after this date/time (RFC3339).

endDatestring
Example:2026-08-31T23:59:59Z

Return records created on or before this date/time (RFC3339).

afterIdstring

Pagination cursor. Pass this field as a query parameter to get the next page.

pageSizeinteger
Example:50

Maximum number of items to return per page. Default is 10.

Headers

Authorizationstring required

Account token - access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message

x-cidstring

Request tracking ID. If not provided, a random UUID is generated.

Response

Paginated list of direct debit mandates

next_pageboolean

Are there more results?

after_idstring

Pagination cursor to pass as query parameter to get the next page

Example response

{
  "items": [
    {
      "id": "b254bb5e-6f1a-4c2b-9c1e-2f0a6d3e8c11",
      "external_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "org_id": "TN-KGIOODJD...1000",
      "account_id": 12345678,
      "role": "PAYER",
      "source": "auddis",
      "status": "CREATED",
      "reference": "Weekly money for Mom",
      "form3_submission_id": "9f8c7d6e-5b4a-3c2d-1e0f-a1b2c3d4e5f6",
      "status_reason": {
        "code": "2",
        "description": "Mandate transferred to a new bank"
      },
      "created_at": "2026-08-05T10:15:00Z",
      "updated_at": "2026-08-05T10:15:00Z"
    }
  ],
  "next_page": true,
  "after_id": "019e92ec-3362-7c54-9d17-89f5542a06e4"
}

Changes

No recorded changes to this operation across all 1 revision of this API.