PIpismo
BACS direct debit

List BACS direct debit transactions [beta]

List BACS direct debit transactions.

get/v1/payments/bacs/directdebit

Request

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

Query parameters

idstring

Transaction or mandate ID filter

status'CREATED' | 'PROCESSING' | 'SETTLED' | 'CANCELLED' | 'HOLD'

Transaction status filter

transactionType'DIRECTDEBIT_INBOUND' | 'DIRECTDEBIT_OUTBOUND' | 'DIRECTDEBIT_IN_RETURN' | 'DIRECTDEBIT_OUT_RETURN' | 'DIRECTDEBIT_IN_REVERSAL' | 'DIRECTDEBIT_OUT_REVERSAL'

Direct debit transaction type filter

mandateIDstring

Associated mandate ID 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 direct debit transactions

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,
      "transaction_type": "DIRECTCREDIT_OUTBOUND",
      "reference": "Weekly money for Mom",
      "mandate_id": "b254bb5e-6f1a-4c2b-9c1e-2f0a6d3e8c11",
      "payment_scheme": "BACS",
      "transaction_status": "PROCESSING",
      "amount": 600,
      "currency_code": 826,
      "processing_date": "2026-08-10",
      "return_reason": "account_closed",
      "return_code": "A",
      "return_origin": "SYSTEM",
      "original_transaction_id": "08ec4cf7-2d74-5453-80e0-e940ac8fc219",
      "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.