---
updatedAt: 2025-08-27T15:59:52.000Z
agentTools:
  projectIndex: https://docs.moneyhubenterprise.com/v2.5/llms.txt
---

# Retrieve all standing orders created by an API client

Requires **payment:read** scope.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger 2.0 docs for the authentication/authorization Moneyhub API",
    "title": "Moneyhub Identity Service",
    "version": "2.0.0"
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "paths": {
    "/standing-orders": {
      "get": {
        "summary": "Retrieve all standing orders created by an API client",
        "description": "Requires **payment:read** scope.",
        "parameters": [
          {
            "description": "The total number of records to retrieve",
            "in": "query",
            "name": "limit",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000
            }
          },
          {
            "description": "The offset at which to start retrieving records",
            "in": "query",
            "name": "offset",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000000000
            }
          },
          {
            "description": "The ID of the user to filter transactions on",
            "in": "query",
            "name": "userId",
            "schema": {
              "type": "string",
              "minLength": 24,
              "maxLength": 24
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Standing Order Response",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/StandingOrderRequest"
                      },
                      "type": "array"
                    },
                    "meta": {
                      "$ref": "#/components/schemas/Meta"
                    }
                  },
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Unsuccessful Response - Forbidden - Invalid scopes",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "tags": [
          "payments"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://identity.moneyhub.co.uk"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "StandingOrderRequest": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "id": {
            "description": "The id of the standing order request",
            "example": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
            "type": "string",
            "format": "uuid"
          },
          "status": {
            "enum": [
              "InProgress",
              "InitiationPending",
              "InitiationFailed",
              "InitiationCompleted",
              "Cancelled"
            ],
            "type": "string"
          },
          "createdAt": {
            "description": "The date that the standing order was created",
            "example": "2020-07-10T12:00:00+00:00",
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "description": "The date that the standing order was last updated",
            "example": "2020-07-10T12:00:00+00:00",
            "format": "date-time",
            "type": "string"
          },
          "standingOrder": {
            "additionalProperties": false,
            "type": "object",
            "properties": {
              "id": {
                "description": "The unique identity of the standing order",
                "example": "d4c69cda-cd58-4bd3-b950-b085d97cc629",
                "type": "string",
                "format": "uuid"
              },
              "status": {
                "enum": [
                  "Active",
                  "Inactive"
                ],
                "type": "string"
              },
              "reference": {
                "description": "The name or description given to the standing order",
                "type": "string"
              },
              "frequency": {
                "additionalProperties": false,
                "properties": {
                  "repeat": {
                    "enum": [
                      "Daily",
                      "Weekly",
                      "Monthly",
                      "Quarterly",
                      "Yearly"
                    ],
                    "example": "Daily",
                    "type": "string"
                  },
                  "day": {
                    "description": "The number of the day on which to repeat the payment",
                    "type": "number",
                    "example": 1
                  },
                  "week": {
                    "description": "The number of the week on which to repeat the payment",
                    "type": "number",
                    "example": 1
                  },
                  "month": {
                    "description": "The number of the month on which to repeat the payment",
                    "type": "number",
                    "example": 1
                  },
                  "onlyWorkDays": {
                    "description": "Specifies whether the payment should only be made on working days",
                    "type": "boolean",
                    "example": false
                  },
                  "region": {
                    "description": "The region for dates of quarterly payments",
                    "enum": [
                      "ENGLISH",
                      "SCOTTISH",
                      "RECEIVED"
                    ],
                    "type": "string"
                  }
                },
                "required": [
                  "repeat"
                ],
                "type": "object"
              },
              "numberOfPayments": {
                "description": "The number of reucrring payments to complete the standing order",
                "example": 5,
                "type": "integer"
              },
              "firstPaymentDate": {
                "example": "2020-11-02T00:00:00.000Z",
                "format": "date-time",
                "type": "string"
              },
              "recurringPaymentDate": {
                "example": "2020-12-02T00:00:00.000Z",
                "format": "date-time",
                "type": "string"
              },
              "finalPaymentDate": {
                "example": "2021-01-02T00:00:00.000Z",
                "format": "date-time",
                "type": "string"
              },
              "firstPaymentAmount": {
                "description": "The value of the first payment in minor units of the currency, eg. pennies for GBP.",
                "example": 2000,
                "type": "integer"
              },
              "recurringPaymentAmount": {
                "description": "The value of the next payment in minor units of the currency, eg. pennies for GBP.",
                "example": 1000,
                "type": "integer"
              },
              "finalPaymentAmount": {
                "description": "The value of the final payment in minor units of the currency, eg. pennies for GBP.",
                "example": 999,
                "type": "integer"
              },
              "currency": {
                "description": "The currency of the standing order",
                "example": "GBP",
                "type": "string"
              },
              "payee": {
                "additionalProperties": false,
                "description": "The details to identify the beneficiary account. It requires the **standing_orders_detail:read** scope.",
                "properties": {
                  "name": {
                    "description": "The name or names of the account owner(s)",
                    "type": "string",
                    "example": "Payee Name"
                  },
                  "sortCodeAccountNumber": {
                    "description": "For cash accounts. Populated with the 6 digit Sort Code and 8 digit Account Number.",
                    "type": "string",
                    "maxLength": 20,
                    "minLength": 14,
                    "example": "60161331926819"
                  },
                  "iban": {
                    "description": "For cash accounts. Populated with the full IBAN number.",
                    "type": "string",
                    "maxLength": 34,
                    "minLength": 18,
                    "example": "GB2960161331926819"
                  },
                  "pan": {
                    "description": "For card accounts. Populated with the Primary Account Number.",
                    "type": "string",
                    "example": "1234567812345678"
                  }
                },
                "type": "object"
              }
            },
            "required": [
              "id",
              "frequency"
            ]
          }
        },
        "required": [
          "id",
          "createdAt",
          "standingOrder"
        ]
      },
      "Error": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "description": "The error code",
            "type": "string"
          },
          "message": {
            "description": "The error message",
            "type": "string"
          },
          "correlationId": {
            "description": "Id that identifies the request and can be used to ask for more details related to the error",
            "type": "string"
          }
        },
        "required": [
          "code"
        ],
        "type": "object"
      },
      "Meta": {
        "additionalProperties": false,
        "properties": {
          "limit": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1000
          },
          "offset": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1000000000
          },
          "total": {
            "type": "integer",
            "minimum": 0
          }
        },
        "type": "object"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```