---
updatedAt: 2026-10-07T16:46:14.000Z
agentTools:
  siteIndex: https://developers.pismo.io/llms.txt
  projectIndex: https://developers.pismo.io/pismo-docs/llms.txt
---

# List BACS Direct Debit indemnity claims [beta]

List DDIC claims 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. 

This endpoint does not return claim reversals.


# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Payment rails - BACS payments",
    "description": "BACS payments system API",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    },
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io/bacs",
      "description": "Sandbox API server for testing"
    }
  ],
  "tags": [
    {
      "name": "BACS direct debit"
    }
  ],
  "components": {
    "parameters": {
      "afterIdQuery": {
        "name": "afterId",
        "in": "query",
        "description": "Pagination cursor. Pass this field as a query parameter to get the next page.",
        "required": false,
        "schema": {
          "type": "string",
          "maxLength": 2000
        }
      },
      "authHeader": {
        "name": "Authorization",
        "in": "header",
        "schema": {
          "type": "string"
        },
        "description": "Account token - access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message\n",
        "required": true
      },
      "beginDateQuery": {
        "name": "beginDate",
        "in": "query",
        "description": "Return records created on or after this date/time (RFC3339).",
        "required": false,
        "schema": {
          "type": "string",
          "maxLength": 40,
          "example": "2026-08-01T00:00:00Z"
        }
      },
      "endDateQuery": {
        "name": "endDate",
        "in": "query",
        "description": "Return records created on or before this date/time (RFC3339).",
        "required": false,
        "schema": {
          "type": "string",
          "maxLength": 40,
          "example": "2026-08-31T23:59:59Z"
        }
      },
      "idQuery": {
        "name": "id",
        "in": "query",
        "description": "Transaction or mandate ID filter",
        "required": false,
        "schema": {
          "type": "string",
          "maxLength": 36
        }
      },
      "claimStatusQuery": {
        "name": "status",
        "in": "query",
        "description": "DDIC claim status filter",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "CREATED",
            "PROCESSING",
            "CONFIRMED",
            "FAILED"
          ]
        }
      },
      "pageSizeQuery": {
        "name": "pageSize",
        "in": "query",
        "description": "Maximum number of items to return per page. Default is `10`.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int64",
          "minimum": 1,
          "maximum": 100,
          "default": 10,
          "example": 50
        }
      },
      "reqTrackingIdHeader": {
        "name": "x-cid",
        "in": "header",
        "schema": {
          "type": "string"
        },
        "description": "Request tracking ID. If not provided, a random UUID is generated.\n",
        "required": false
      }
    },
    "schemas": {
      "accountId": {
        "type": "integer",
        "description": "Account ID",
        "example": 12345678
      },
      "afterId": {
        "type": "string",
        "description": "Pagination cursor to pass as query parameter to get the next page\n",
        "example": "019e92ec-3362-7c54-9d17-89f5542a06e4"
      },
      "createdAtDateTime": {
        "type": "string",
        "format": "date-time",
        "description": "Created at date-time. RFC 3339 format",
        "example": "2026-08-05T10:15:00Z"
      },
      "customer.DetailMessage": {
        "type": "object",
        "properties": {
          "external": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/customer.ExternalMessage"
            }
          },
          "parameters": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/customer.ParameterMessage"
            }
          },
          "payload": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/customer.PayloadMessage"
            }
          }
        }
      },
      "customer.Error": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error's code.",
            "example": "EPT0001"
          },
          "details": {
            "$ref": "#/components/schemas/customer.DetailMessage"
          },
          "message": {
            "type": "string",
            "description": "Error's message.",
            "example": "User not found"
          }
        }
      },
      "customer.ExternalMessage": {
        "type": "object",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Code",
            "example": "PBE315"
          },
          "message": {
            "type": "string",
            "description": "Message",
            "example": "Generic error"
          }
        }
      },
      "customer.ParameterMessage": {
        "type": "object",
        "required": [
          "field",
          "message"
        ],
        "properties": {
          "field": {
            "type": "string",
            "description": "Field",
            "example": "Query parameter"
          },
          "message": {
            "type": "string",
            "description": "Message",
            "example": "Generic error"
          }
        }
      },
      "customer.PayloadMessage": {
        "type": "object",
        "required": [
          "field",
          "message"
        ],
        "properties": {
          "field": {
            "type": "string",
            "description": "Field",
            "example": "Entity.field"
          },
          "message": {
            "type": "string",
            "description": "Message",
            "example": "Generic error"
          }
        }
      },
      "mandateClearingId": {
        "type": "string",
        "pattern": "^[0-9]{6}$",
        "description": "Six-digit clearing ID for the mandate",
        "example": "123456"
      },
      "nextPage": {
        "type": "boolean",
        "description": "Are there more results?",
        "example": true
      },
      "orgId": {
        "type": "string",
        "description": "Organization/tenant ID",
        "example": "TN-KGIOODJD...1000"
      },
      "claim.id": {
        "type": "string",
        "description": "Pismo-assigned local claim ID",
        "example": "019e92ec-3362-7c54-9d17-89f5542a06e4"
      },
      "claim.reference": {
        "type": "string",
        "maxLength": 18,
        "pattern": "^DDIC[A-Za-z0-9]{2,14}$",
        "description": "Claim reference. Must begin with `DDIC` followed by 2-6 alphanumeric characters (maximum length 18). \n\nBACS reserves the `DDIC` prefix for indemnity-claim references.\n",
        "example": "DDIC0001AB"
      },
      "claim.reasonCode": {
        "type": "string",
        "description": "Direct Debit Indemnity Claim (DDIC) reason code. BACS DDIC scheme rules that indicate why the indemnity claim is being raised:\n\n  * `1`— The amount and/or date collected differs from the advance notice.\n\n  * `2`— No advance notice was received (or the payment was collected earlier than notified).\n\n  * `3`— The Direct Debit Instruction (DDI) is disputed / no valid mandate is held.\n\n  * `4`— The payer canceled the DDI directly with the service user.\n\n  * `5`— The account holder is deceased.\n\n  * `6`— The payer canceled the DDI with their bank.\n\n  * `7`— Claim raised at the service user's request.\n\n  * `8`— Service user name disputed / the payer does not recognise the collecting service user.\n\nConditional fields:\n\n  * `3`—`processing_date` is **REQUIRED**.\n\n  * `7`—`contact_name` and `request_date` are **REQUIRED**.\n",
        "enum": [
          "1",
          "2",
          "3",
          "4",
          "5",
          "6",
          "7",
          "8"
        ],
        "example": "1"
      },
      "claim.status": {
        "type": "string",
        "description": "DDIC claim / claim-reversal lifecycle status_reason:\n\n  * `CREATED`—Claim persisted, pending submission to the scheme via Form3.\n\n  * `PROCESSING`—Claim submitted and in flight through Form3 / the scheme.\n\n  * `CONFIRMED`—Claim delivery confirmed by the scheme. Terminal state.\n\n  * `FAILED`—Claim rejected or failed validation/submission. Terminal state.\n",
        "enum": [
          "CREATED",
          "PROCESSING",
          "CONFIRMED",
          "FAILED"
        ],
        "example": "CREATED"
      },
      "claim.OriginalInstruction": {
        "type": "object",
        "description": "Original Direct Debit Instruction (DDI) the claim relates to",
        "required": [
          "clearing_id",
          "reference"
        ],
        "properties": {
          "clearing_id": {
            "$ref": "#/components/schemas/mandateClearingId"
          },
          "reference": {
            "type": "string",
            "maxLength": 18,
            "description": "Original Direct Debit Instruction reference",
            "example": "MANDATE-REF-001"
          }
        }
      },
      "claim.DisputedTransaction": {
        "type": "object",
        "description": "Single disputed Direct Debit collection included in the claim",
        "required": [
          "amount",
          "date"
        ],
        "properties": {
          "amount": {
            "type": "string",
            "maxLength": 20,
            "description": "Disputed transaction amount",
            "example": "125.00"
          },
          "date": {
            "type": "string",
            "format": "date",
            "description": "Disputed transaction date. Format = YYYY-MM-DD.",
            "example": "2026-08-15"
          }
        }
      },
      "listing.Claim": {
        "type": "object",
        "description": "DDIC claim record returned by the claim list endpoint",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/claim.id"
          },
          "org_id": {
            "$ref": "#/components/schemas/orgId"
          },
          "account_id": {
            "$ref": "#/components/schemas/accountId"
          },
          "claim_id": {
            "type": "string",
            "description": "Form3-assigned claim ID. (Scheme reference. Omitted until the claim is submitted.)",
            "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          },
          "status": {
            "$ref": "#/components/schemas/claim.status"
          },
          "reason_code": {
            "$ref": "#/components/schemas/claim.reasonCode"
          },
          "reference": {
            "$ref": "#/components/schemas/claim.reference"
          },
          "clearing_id": {
            "$ref": "#/components/schemas/mandateClearingId"
          },
          "original_instruction": {
            "$ref": "#/components/schemas/claim.OriginalInstruction"
          },
          "disputed_transactions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/claim.DisputedTransaction"
            }
          },
          "number_of_transactions": {
            "type": "integer",
            "format": "int32",
            "description": "Number of transactions",
            "example": 1
          },
          "processing_date": {
            "type": "string",
            "format": "date",
            "description": "Processing date. Format = YYYY-MM-DD.",
            "example": "2026-08-20"
          },
          "contact_name": {
            "type": "string",
            "maxLength": 51,
            "description": "Contact name",
            "example": "Jane Smith"
          },
          "request_date": {
            "type": "string",
            "format": "date",
            "description": "Request date. Format = YYYY-MM-DD.",
            "example": "2026-08-18"
          },
          "reason": {
            "$ref": "#/components/schemas/reversalReason"
          },
          "created_at": {
            "$ref": "#/components/schemas/createdAtDateTime"
          },
          "updated_at": {
            "$ref": "#/components/schemas/updatedAtDateTime"
          }
        }
      },
      "listing.ClaimListResponse": {
        "type": "object",
        "description": "Paginated list of DDIC claims",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/listing.Claim"
            }
          },
          "next_page": {
            "$ref": "#/components/schemas/nextPage"
          },
          "after_id": {
            "$ref": "#/components/schemas/afterId"
          }
        }
      },
      "reversalReason": {
        "type": "string",
        "maxLength": 255,
        "description": "Free-text reason for reversal",
        "example": "Claim raised in error"
      },
      "updatedAtDateTime": {
        "type": "string",
        "format": "date-time",
        "description": "Updated at date-time. RFC 3339 format",
        "example": "2026-08-05T10:15:00Z"
      }
    }
  },
  "paths": {
    "/v1/payments/bacs/directdebit/claims": {
      "get": {
        "summary": "List BACS Direct Debit indemnity claims [beta]",
        "description": "List DDIC claims for an account. \n\nThis endpoint takes an account token - an access token encoded with a Pismo account ID.  The account is parsed from the token. \n\nThis endpoint does not return claim reversals.\n",
        "operationId": "get-bacs-claim-list",
        "tags": [
          "BACS direct debit"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/authHeader"
          },
          {
            "$ref": "#/components/parameters/reqTrackingIdHeader"
          },
          {
            "$ref": "#/components/parameters/idQuery"
          },
          {
            "$ref": "#/components/parameters/claimStatusQuery"
          },
          {
            "$ref": "#/components/parameters/beginDateQuery"
          },
          {
            "$ref": "#/components/parameters/endDateQuery"
          },
          {
            "$ref": "#/components/parameters/afterIdQuery"
          },
          {
            "$ref": "#/components/parameters/pageSizeQuery"
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of DDIC claims",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/listing.ClaimListResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer.Error"
                },
                "examples": {
                  "EBACS0004": {
                    "summary": "Validation Error",
                    "value": {
                      "code": "EBACS0004",
                      "message": "Validation error"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer.Error"
                },
                "examples": {
                  "EBACS0002": {
                    "summary": "Missing Tenant Header",
                    "value": {
                      "code": "EBACS0002",
                      "message": "Missing required header: 'x-tenant'"
                    }
                  },
                  "EBACS0085": {
                    "summary": "Missing Account Id",
                    "value": {
                      "code": "EBACS0085",
                      "message": "Missing required account-id"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer.Error"
                },
                "examples": {
                  "EBACS0003": {
                    "summary": "Internal Error",
                    "value": {
                      "code": "EBACS0003",
                      "message": "Internal error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```