STstarlingbank
Payees

Get scheduled payments

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

Request

  • Base URL
    https://api.starlingbank.com
  • Auth
    HTTP bearer

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"
    }
  ]
}

Changes

  • 10e2d804aaabRevision changes
    • warning

      added the new ACCOUNTANCY_FEES enum value to the // response property for the response status

    • warning

      added the new ADVERTISING enum value to the // response property for the response status

    • warning

      added the new AGENT_MANAGEMENT_AND_LEGAL_FEES enum value to the // response property for the response status

    • warning

      added the new BUILDINGS enum value to the // response property for the response status

    • warning

      added the new CAPITALISED_COSTS enum value to the // response property for the response status

    • warning

      added the new CAPITAL_INTRODUCED enum value to the // response property for the response status

    • warning

      added the new CATEGORISE_LATER enum value to the // response property for the response status

    • warning

      added the new CHARITABLE_DONATIONS enum value to the // response property for the response status

    • warning

      added the new COMPUTER_HARDWARE enum value to the // response property for the response status

    • warning

      added the new CONSULTANCY_FEES enum value to the // response property for the response status

    • warning

      added the new CORPORATION_TAX_OWED enum value to the // response property for the response status

    • warning

      added the new COST_OF_SALES enum value to the // response property for the response status

    • warning

      added the new COUNCIL_TAX_PAID_BY_YOU enum value to the // response property for the response status

    • warning

      added the new CREDIT_CARD_REPAYMENTS enum value to the // response property for the response status

    • warning

      added the new DIRECTORS_LOAN enum value to the // response property for the response status

    • warning

      added the new DISPOSAL_OF_ASSETS enum value to the // response property for the response status

    • warning

      added the new DONATIONS enum value to the // response property for the response status

    • warning

      added the new EMPLOYEE_AND_EMPLOYER_PENSIONS enum value to the // response property for the response status

    • warning

      added the new EMPLOYEE_BENEFITS enum value to the // response property for the response status

    • warning

      added the new EMPLOYEE_ENTERTAINING enum value to the // response property for the response status

    • warning

      added the new EMPLOYEE_PENSIONS enum value to the // response property for the response status

    • warning

      added the new EQUIPMENT_HIRE enum value to the // response property for the response status

    • warning

      added the new EXCHANGE_RATE_CHANGES enum value to the // response property for the response status

    • warning

      added the new FURNITURE_AND_EQUIPMENT enum value to the // response property for the response status

    • warning

      added the new GARDENING_CLEANING_AND_OTHER_SERVICES enum value to the // response property for the response status

    • warning

      added the new GRANTS enum value to the // response property for the response status

    • warning

      added the new IMPORT_VAT enum value to the // response property for the response status

    • warning

      added the new INTANGIBLE_ASSETS enum value to the // response property for the response status

    • warning

      added the new INTEREST_GAINED enum value to the // response property for the response status

    • warning

      added the new MILEAGE_AND_OTHER_TRAVEL_COSTS enum value to the // response property for the response status

    • warning

      added the new MONEY_OWED_FROM_CLIENTS enum value to the // response property for the response status

    • warning

      added the new MONEY_OWED_TO_EMPLOYEES enum value to the // response property for the response status

    • warning

      added the new MONEY_OWED_TO_OTHERS enum value to the // response property for the response status

    • warning

      added the new MONEY_OWED_TO_SUPPLIERS enum value to the // response property for the response status

    • warning

      added the new MONEY_OWED_TO_THE_BUSINESS enum value to the // response property for the response status

    • warning

      added the new MORTGAGE_CAPITAL_REPAYMENTS enum value to the // response property for the response status

    • warning

      added the new MULTIPLE enum value to the // response property for the response status

    • warning

      added the new NON_RESIDENTIAL_PROPERTY_FINANCE_COSTS enum value to the // response property for the response status

    • warning

      added the new OFFICE_AND_POSTAGE_COSTS enum value to the // response property for the response status

    • warning

      added the new OTHER_ALLOWABLE_COSTS enum value to the // response property for the response status

    • warning

      added the new OTHER_RATES_PAID_BY_YOU enum value to the // response property for the response status

    • warning

      added the new OWED_TO_PAYE_AND_NI enum value to the // response property for the response status

    • warning

      added the new PAYE_AND_NI enum value to the // response property for the response status

    • warning

      added the new PENALTIES_AND_FINES enum value to the // response property for the response status

    • warning

      added the new PENSION_CONTRIBUTIONS enum value to the // response property for the response status

    • warning

      added the new PENSION_CONTRIBUTIONS_OWED enum value to the // response property for the response status

    • warning

      added the new PERSONAL_WITHDRAWALS enum value to the // response property for the response status

    • warning

      added the new PLATFORM_FEES enum value to the // response property for the response status

    • warning

      added the new PROPERTY_UPGRADES enum value to the // response property for the response status

    • warning

      added the new REIMBURSED_EXPENSES enum value to the // response property for the response status

    • warning

      added the new RENTAL_INCOME enum value to the // response property for the response status

    • warning

      added the new RENTAL_INSURANCE enum value to the // response property for the response status

    • warning

      added the new RENTAL_REPAIRS_AND_MAINTENANCE enum value to the // response property for the response status

    • warning

      added the new RENTAL_SERVICES enum value to the // response property for the response status

    • warning

      added the new RENT_PAID_BY_YOU enum value to the // response property for the response status

    • warning

      added the new REPLACING_DAMAGED_FURNISHINGS_AND_APPLIANCES enum value to the // response property for the response status

    • warning

      added the new RESIDENTIAL_PROPERTY_FINANCE_COSTS enum value to the // response property for the response status

    • warning

      added the new SHARE_CAPITAL_OUTSTANDING enum value to the // response property for the response status

    • warning

      added the new SHARE_PREMIUM enum value to the // response property for the response status

    • warning

      added the new SOFTWARE enum value to the // response property for the response status

    • warning

      added the new SOFTWARE_AND_SUBSCRIPTIONS enum value to the // response property for the response status

    • warning

      added the new STAFF_TAXES enum value to the // response property for the response status

    • warning

      added the new STOCK enum value to the // response property for the response status

    • warning

      added the new TAX_POT_SAVINGS enum value to the // response property for the response status

    • warning

      added the new TRAINING enum value to the // response property for the response status

    • warning

      added the new UTILITIES enum value to the // response property for the response status

    • warning

      added the new UTILITIES_PAID_BY_YOU enum value to the // response property for the response status

    • warning

      added the new VEHICLE_AND_FUEL_COSTS enum value to the // response property for the response status

    • warning

      added the new VEHICLE_PURCHASES enum value to the // response property for the response status