---
title: "List all direct debits"
method: GET
path: "/v1/directdebits"
tags: ["Direct Debits"]
---

# List all direct debits

`GET /v1/directdebits`

This endpoint will retrieve all direct debit payments associated with a direct debit mandate. You will need to enable PERM_BUSINESS_GET_DIRECT_DEBITS to use this endpoint.

## Query parameters

- `mandateUuid` string, required

## Response `200`

Retrieve all direct debit payments associated with a direct debit mandate.

- object
  - `total` integer — Number of direct debits found
  - `directdebits` DirectDebit[]
    - `directDebitUuid` string — The UUID for the direct debit payment
    - `currency` Currency — The currency.
      - `code` string — The three letter code for the currency.
      - `description` string — The name of the currency
    - `status` 'RECIEVED' | 'REJECT_REQUESTED' | 'REJECT_READY_FOR_PROCESSING' | 'REJECT_RECORD_IN_PROGRESS' | 'REJECT_RECORDED' | 'REJECT_FILE_CREATED' | 'REJECT_FILE_SENT' | 'COLLECTED' | 'REFUND_REQUESTED' | 'REFUND_RECORD_IN_PROGRESS' | 'REFUND_RECORDED' | 'REFUND_FILE_CREATED' | 'REFUND_FILE_SENT' — The statuses of the direct debit payments associated with the mandate. * 'RECIEVED' - Direct Debit has been recieved * 'REJECT_REQUESTED' - The direct debit has a rejected request associated with it * 'REJECT_READY_FOR_PROCESSING' * 'REJECT_RECORD_IN_PROGRESS' * 'REJECT_RECORDED' * 'REJECT_FILE_CREATED' * 'REJECT_FILE_SENT' * 'COLLECTED' - Direct debit collected * 'REFUND_REQUESTED' - Refund requested on direct debit * 'REFUND_RECORD_IN_PROGRESS' - Refund in progress on direct debit * 'REFUND_RECORDED' * 'REFUND_FILE_CREATED' * 'REFUND_FILE_SENT'
    - `type` 'FIRST_COLLECTION' | 'ONGOING_COLLECTION' | 'REPRESENTED_COLLECTION' | 'FINAL_COLLECTION' — The type of the direct debit.
    - `mandateUUid` string — The UUID for the mandate
    - `originatorReference` string — Set by party who sets up the direct debit.
    - `originatorName` string — The creator of the party who sets up the direct debit.
    - `originatorAlias` string — The Alias of the party who sets up the direct debit.
    - `directDebitReference` string — The direct debit reference.
    - `targetIcan` integer — The ican of your fire account that the money was taken from
    - `targetPayeeId` integer — The payee that was created when the DD was processed
    - `isDDIC` boolean — DDIC is a Direct Debit Indemnity Claim (i.e.a refund). If if the DD is requested to be refunded it is marked isDDIC true.
    - `amount` integer — Value of the payment
    - `schemeRejectReason` string — Reason why rejected
    - `schemeRejectReasonCode` '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'A' | 'B' — The reject code returned by the bank indicating an issue with the direct debit. Each ARRUD code represents a rejection reason.
    - `lastUpdated` string, date-time — Date the direct debit was last updated. Milliseconds since the epoch (1970).
    - `dateCreated` string, date-time — Date the direct debit was created. Milliseconds since the epoch (1970).

## Other responses

- `400` — An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.
- `401` — An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.
- `403` — An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.

---

[API](https://skmtc.net/firefinancialservices/apis/fire-financial-services-business-api.md) · [All operations](https://skmtc.net/firefinancialservices/apis/fire-financial-services-business-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/firefinancialservices/fire-financial-services-business-api/revisions/1d19896d095c/schema)