PIpismo
BACS direct debit

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.

get/v1/payments/bacs/directdebit/claims

Request

  • Base URL
    https://sandbox.pismolabs.io/bacs
  • URL
    https://sandbox.pismolabs.io/bacs/v1/payments/bacs/directdebit/claims
  • Auth
    none declared. Required headers: Authorization

Query parameters

idstring

Transaction or mandate ID filter

status'CREATED' | 'PROCESSING' | 'CONFIRMED' | 'FAILED'

DDIC claim status filter

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

next_pageboolean

Are there more results?

after_idstring

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

Example response

{
  "items": [
    {
      "id": "019e92ec-3362-7c54-9d17-89f5542a06e4",
      "org_id": "TN-KGIOODJD...1000",
      "account_id": 12345678,
      "claim_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "CREATED",
      "reason_code": "1",
      "reference": "DDIC0001AB",
      "clearing_id": "123456",
      "original_instruction": {
        "clearing_id": "123456",
        "reference": "MANDATE-REF-001"
      },
      "disputed_transactions": [
        {
          "amount": "125.00",
          "date": "2026-08-15"
        }
      ],
      "number_of_transactions": 1,
      "processing_date": "2026-08-20",
      "contact_name": "Jane Smith",
      "request_date": "2026-08-18",
      "reason": "Claim raised in error",
      "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.