Standing Orders

Get Standing Orders

Enables an AISP to retrieve Standing Order information for account(s) that the PSU has consented to.

get/standing-orders

Headers

x-fapi-auth-datestring

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-addressstring

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstring required

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

x-client-idstring

Only used if an ASPSP requires the client ID in order to return rate limit headers.

TPPs must refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements.

This header must not be used for client authentication

Response

Standing Orders Read

Example response

{
  "Data": {
    "StandingOrder": [
      {
        "AccountId": "22289",
        "StandingOrderId": "Ben5",
        "NextPaymentDateTime": "2017-07-12T00:00:00+00:00",
        "LastPaymentDateTime": "2017-07-12T00:00:00+00:00",
        "StandingOrderStatusCode": "ACTV",
        "FirstPaymentAmount": {
          "Amount": "1209.06",
          "Currency": "GBP"
        },
        "NextPaymentAmount": {
          "Amount": "1209.06",
          "Currency": "GBP"
        },
        "LastPaymentAmount": {
          "Amount": "1209.06",
          "Currency": "GBP"
        },
        "FinalPaymentAmount": {
          "Amount": "1209.06",
          "Currency": "GBP"
        },
        "CreditorAgent": {
          "SchemeName": "UK.OBIE.BICFI",
          "Identification": "80200112344562",
          "Name": "Agent Name",
          "PostalAddress": {
            "AddressType": "BIZZ",
            "Department": "Finance",
            "SubDepartment": "Payroll",
            "StreetName": "Bank Street",
            "BuildingNumber": "11",
            "Floor": "11",
            "UnitNumber": "A88",
            "Room": "Basement 03",
            "PostBox": "PO Box 123456",
            "TownLocationName": "London",
            "DistrictName": "Greater London",
            "CareOf": "Jane Smith",
            "PostCode": "EC2N 4AG",
            "TownName": "London"
          },
          "LEI": "IZ9Q00LZEVUKWCQY6X15"
        },
        "CreditorAccount": {
          "Name": "Jane Smith",
          "SecondaryIdentification": "87562298675897",
          "Proxy": {
            "Identification": "2360549017905188",
            "Code": "TELE"
          }
        },
        "MandateRelatedInformation": {
          "MandateIdentification": "Golfers",
          "Classification": "FIXE",
          "FirstPaymentDateTime": "2024-04-25T12:46:49.425Z",
          "RecurringPaymentDateTime": "2024-04-25T12:46:49.425Z",
          "FinalPaymentDateTime": "2024-04-25T12:46:49.425Z",
          "Frequency": {
            "Type": "MNTH",
            "CountPerPeriod": 1,
            "PointInTime": "00"
          },
          "Reason": "To pay monthly membership"
        },
        "RemittanceInformation": {
          "Structured": [
            {
              "ReferredDocumentAmount": "1209.06",
              "Invoicer": "80200112344562",
              "Invoicee": "80200112344562"
            }
          ]
        }
      }
    ]
  }
}

Changes

Changed in 6 of the 50 revisions of this API.73010

Mar 9, 20266be9b2ebb95521See the full diff
- ●
  added the new AROI enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new AROI enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new AROI enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new BOLD enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new BOLD enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new BOLD enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new CMCN enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new CMCN enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new CMCN enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new SOAC enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new SOAC enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new SOAC enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new TSUT enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new TSUT enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new TSUT enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new USAR enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new USAR enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new USAR enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new VCHR enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new VCHR enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new VCHR enum value to the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/Code response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
Jan 8, 20261cecf93961269See the full diff
- ●
  added the new LWMH enum value to the Data/StandingOrder/items/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new LWMH enum value to the Data/StandingOrder/items/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new LWMH enum value to the Data/StandingOrder/items/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new LXMH enum value to the Data/StandingOrder/items/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new LXMH enum value to the Data/StandingOrder/items/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new LXMH enum value to the Data/StandingOrder/items/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new TWYR enum value to the Data/StandingOrder/items/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new TWYR enum value to the Data/StandingOrder/items/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new TWYR enum value to the Data/StandingOrder/items/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
Nov 20, 2025a96a922860eb1See the full diff
- ○
  added the new optional header request parameter x-client-id
  new-optional-request-parameter
Nov 18, 20253d6892e8292f33See the full diff
- ▲
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 200 (media type: application/json; charset=utf-8)
  response-property-type-changed
- ▲
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 200 (media type: application/json)
  response-property-type-changed
- ▲
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 200 (media type: application/jose+jwe)
  response-property-type-changed
- ○
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 200 (media type: application/json; charset=utf-8)
  response-property-pattern-added
- ○
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 200 (media type: application/json)
  response-property-pattern-added
- ○
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 200 (media type: application/jose+jwe)
  response-property-pattern-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 14, 2025b3e46fd0ef8513See the full diff
- ▲
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from string/ to integer/int32 for status 200 (media type: application/json)
  response-property-type-changed
- ○
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was removed for the status 200 (media type: application/json; charset=utf-8)
  response-property-pattern-removed
- ○
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was removed for the status 200 (media type: application/json)
  response-property-pattern-removed
- ○
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was removed for the status 200 (media type: application/jose+jwe)
  response-property-pattern-removed
Nov 14, 20253a60c5831adf33See the full diff
- ▲
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 200 (media type: application/json; charset=utf-8)
  response-property-type-changed
- ▲
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 200 (media type: application/json)
  response-property-type-changed
- ▲
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 200 (media type: application/jose+jwe)
  response-property-type-changed
- ○
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 200 (media type: application/json; charset=utf-8)
  response-property-pattern-added
- ○
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 200 (media type: application/json)
  response-property-pattern-added
- ○
  the Data/StandingOrder/items/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 200 (media type: application/jose+jwe)
  response-property-pattern-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history