EQequalsmoney
Direct Debits

List all direct debits

Returns a list of direct debit mandates for the specified account.

get/direct-debits

Request

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091
string
OR
string[]
searchstring

The term to search the records for.

Example:Cesar+Treutel
'active' | 'cancelled' | 'expired'
OR
string[]
limitinteger

The maximum number of results to return.

Example:200
offsetinteger

The number of items to skip before returning results.

Example:100

Response

OK

limitinteger

The maximum number of results to return.

offsetinteger

The number of items to skip before returning results.

countinteger required

The total amount of records matching the querying when "limit" is ignored.

Example response

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "775596ae-2624-40af-a9dc-9756110a4a03",
      "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
      "reference": "fre4r5tg",
      "status": "ACTIVE",
      "priority": 2,
      "originator": {
        "id": "123456",
        "accountName": "Netflix Inc",
        "address": {
          "addressType": "ADDR",
          "addressLine": "Vintners Place, 68, Upper Thames Street",
          "city": "London",
          "postcode": "EC4V 3BJ",
          "countryCode": "GB"
        }
      },
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Changes

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