OPopenbankinguk
Standing Orders

Get Standing Orders

Changed on

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

get/standing-orders

Request

  • Base URL
    /open-banking/v4.0/aisp (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /open-banking/v4.0/aisp/standing-orders
  • Auth
    OAuth 2
    Authorization code: https://authserver.example/authorization
    Token URL: https://authserver.example/token scopes: accounts

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

  • 6be9b2ebb955Revision changes
    • warning

      added the new AROI enum value to the //////// response property for the response status (media type: application/json; charset=utf-8)

    • warning

      added the new AROI enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new AROI enum value to the //////// response property for the response status (media type: application/jose+jwe)

    • warning

      added the new BOLD enum value to the //////// response property for the response status (media type: application/json; charset=utf-8)

    • warning

      added the new BOLD enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new BOLD enum value to the //////// response property for the response status (media type: application/jose+jwe)

    • warning

      added the new CMCN enum value to the //////// response property for the response status (media type: application/json; charset=utf-8)

    • warning

      added the new CMCN enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new CMCN enum value to the //////// response property for the response status (media type: application/jose+jwe)

    • warning

      added the new SOAC enum value to the //////// response property for the response status (media type: application/json; charset=utf-8)

    • warning

      added the new SOAC enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new SOAC enum value to the //////// response property for the response status (media type: application/jose+jwe)

    • warning

      added the new TSUT enum value to the //////// response property for the response status (media type: application/json; charset=utf-8)

    • warning

      added the new TSUT enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new TSUT enum value to the //////// response property for the response status (media type: application/jose+jwe)

    • warning

      added the new USAR enum value to the //////// response property for the response status (media type: application/json; charset=utf-8)

    • warning

      added the new USAR enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new USAR enum value to the //////// response property for the response status (media type: application/jose+jwe)

    • warning

      added the new VCHR enum value to the //////// response property for the response status (media type: application/json; charset=utf-8)

    • warning

      added the new VCHR enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new VCHR enum value to the //////// response property for the response status (media type: application/jose+jwe)

  • 1cecf9396126Revision changes
    • warning

      added the new LWMH enum value to the ///////// response property for the response status (media type: application/json; charset=utf-8)

    • warning

      added the new LWMH enum value to the ///////// response property for the response status (media type: application/json)

    • warning

      added the new LWMH enum value to the ///////// response property for the response status (media type: application/jose+jwe)

    • warning

      added the new LXMH enum value to the ///////// response property for the response status (media type: application/json; charset=utf-8)

    • warning

      added the new LXMH enum value to the ///////// response property for the response status (media type: application/json)

    • warning

      added the new LXMH enum value to the ///////// response property for the response status (media type: application/jose+jwe)

    • warning

      added the new TWYR enum value to the ///////// response property for the response status (media type: application/json; charset=utf-8)

    • warning

      added the new TWYR enum value to the ///////// response property for the response status (media type: application/json)

    • warning

      added the new TWYR enum value to the ///////// response property for the response status (media type: application/jose+jwe)