Get scheduled payments

get/api/v2/payees/{payeeUid}/account/{accountUid}/scheduled-payments

Path parameters

payeeUidstring uuid required

Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Unique identifier of the payee

accountUidstring uuid required

Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Unique identifier of the payee account

Response

Successful operation

Example response

{
  "scheduledPayments": [
    {
      "accountHolderUid": "33443344-3344-3344-3344-334433443344",
      "paymentOrderUid": "7879c4f0-8dde-11ea-bc55-0242ac130003",
      "categoryUid": "8f72aaaa-8dde-11ea-bc55-0242ac130003",
      "nextPaymentAmount": {
        "currency": "GBP",
        "minorUnits": 123456
      },
      "payeeUid": "2dcf1551-0b96-4656-9ca5-1195b09d4fb6",
      "payeeAccountUid": "288299fd-2428-42b3-8056-afff573b7d9f",
      "recurrenceRule": {
        "startDate": "2023-01-01",
        "untilDate": "2023-01-01"
      },
      "startDate": "2023-01-01",
      "nextDate": "2023-01-01",
      "endDate": "2023-01-01",
      "paymentType": "DIRECT_DEBIT",
      "spendingCategory": "GENERAL"
    }
  ]
}