Sign in
Standing Orders

Get Standing Orders

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.

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 memebership"
        },
        "RemittanceInformation": {
          "Structured": [
            {
              "Invoicer": "80200112344562",
              "Invoicee": "80200112344562"
            }
          ]
        }
      }
    ]
  }
}

Changes