---
title: "Retrieve all standing orders created by an API client"
method: GET
path: "/standing-orders"
tags: ["payments"]
---

# Retrieve all standing orders created by an API client

`GET /standing-orders`

## Request

- Base URL: `https://identity.moneyhub.co.uk`
- URL: `https://identity.moneyhub.co.uk/standing-orders`
- Auth: API key in header `Authorization`

Requires **payment:read** scope.

## Query parameters

- `limit` integer
- `offset` integer
- `userId` string

## Response `200`

Successful Standing Order Response

- object
  - `data` StandingOrderRequest[]
    - `id` string, uuid, required: The id of the standing order request
    - `status` 'InProgress' | 'InitiationPending' | 'InitiationFailed' | 'InitiationCompleted' | 'Cancelled'
    - `createdAt` string, date-time, required: The date that the standing order was created
    - `updatedAt` string, date-time: The date that the standing order was last updated
    - `standingOrder` object, required
      - `id` string, uuid, required: The unique identity of the standing order
      - `status` 'Active' | 'Inactive'
      - `reference` string: The name or description given to the standing order
      - `frequency` object, required
        - `repeat` 'Daily' | 'Weekly' | 'Monthly' | 'Quarterly' | 'Yearly', required
        - `day` number: The number of the day on which to repeat the payment
        - `week` number: The number of the week on which to repeat the payment
        - `month` number: The number of the month on which to repeat the payment
        - `onlyWorkDays` boolean: Specifies whether the payment should only be made on working days
        - `region` 'ENGLISH' | 'SCOTTISH' | 'RECEIVED': The region for dates of quarterly payments
      - `numberOfPayments` integer: The number of reucrring payments to complete the standing order
      - `firstPaymentDate` string, date-time
      - `recurringPaymentDate` string, date-time
      - `finalPaymentDate` string, date-time
      - `firstPaymentAmount` integer: The value of the first payment in minor units of the currency, eg. pennies for GBP.
      - `recurringPaymentAmount` integer: The value of the next payment in minor units of the currency, eg. pennies for GBP.
      - `finalPaymentAmount` integer: The value of the final payment in minor units of the currency, eg. pennies for GBP.
      - `currency` string: The currency of the standing order
      - `payee` object: The details to identify the beneficiary account. It requires the **standing_orders_detail:read** scope.
        - `name` string: The name or names of the account owner(s)
        - `sortCodeAccountNumber` string: For cash accounts. Populated with the 6 digit Sort Code and 8 digit Account Number.
        - `iban` string: For cash accounts. Populated with the full IBAN number.
        - `pan` string: For card accounts. Populated with the Primary Account Number.
  - `meta` Meta
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

- `401`: Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403`: Unsuccessful Response - Forbidden - Invalid scopes

## Changes

- **2026-11-03** `e004d9ee1fdb`: 4 warning
  - removed the optional property `id` from the response with the `401` status
  - removed the optional property `id` from the response with the `403` status
  - removed the optional property `userId` from the response with the `401` status
  - removed the optional property `userId` from the response with the `403` status

[Operation history](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service/changes/standing-orders/get.md)

---

[API](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service.md) - [All operations](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service/llms.txt) - [OpenAPI document](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service/revisions/e004d9ee1fdb?raw)
