v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Direct Debits

List all direct debit payment requests

Returns a list of payment requests for a direct debit.

get/budgets/{budgetId}/direct-debits/{directDebitId}/payment-requests

Path parameters

budgetIdstring uuid required

The ID of the budget to work with.

Example:775596ae-2624-40af-a9dc-9756110a4a03
directDebitIdstring uuid required

The ID of the direct debit to work with.

Example:775596ae-2624-40af-a9dc-9756110a4a03

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091
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": "PENDING",
      "amount": "100",
      "currency": "USD",
      "originator": {
        "id": "123456",
        "accountName": "Netflix Inc",
        "bankIdentifier": "string",
        "accountIdentifier": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "processedAt": "2019-08-24T14:15:22Z"
    }
  ]
}