International Standing Orders

Get an International Standing Order

Enables a PISP to retrieve the status of an International Standing Order payment.

get/international-standing-orders/{InternationalStandingOrderPaymentId}

Path parameters

InternationalStandingOrderPaymentIdstring required

InternationalStandingOrderPaymentId

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

International Standing Orders Read

Example response

{
  "Data": {
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN"
      }
    ],
    "Initiation": {
      "RemittanceInformation": {
        "Structured": [
          {
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562"
          }
        ]
      },
      "Creditor": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "CreditorAgent": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "UltimateCreditor": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "UltimateDebtor": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "MandateRelatedInformation": {
        "Frequency": {
          "CountPerPeriod": 1,
          "PointInTime": "00"
        }
      }
    },
    "Debtor": {
      "LEI": "IZ9Q00LZEVUKWCQY6X15"
    }
  }
}

Changes

Changed in 20 of the 50 revisions of this API.378494

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

    • added the new optional header request parameter x-client-id

      new-optional-request-parameter

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

  • 2e4e040f09e033See the full diff
    • the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/json; charset=utf-8)

      response-property-type-changed

    • the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/json)

      response-property-type-changed

    • the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/jose+jwe)

      response-property-type-changed

    • the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/json; charset=utf-8)

      response-property-pattern-added

    • the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/json)

      response-property-pattern-added

    • the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/jose+jwe)

      response-property-pattern-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4ac465cd8df563See the full diff
    • removed the optional property // from the response with the status (media type: application/json; charset=utf-8)

      response-optional-property-removed

    • removed the optional property // from the response with the status (media type: application/json)

      response-optional-property-removed

    • removed the optional property // from the response with the status (media type: application/jose+jwe)

      response-optional-property-removed

    • removed the optional property // from the response with the status (media type: application/json; charset=utf-8)

      response-optional-property-removed

    • removed the optional property // from the response with the status (media type: application/json)

      response-optional-property-removed

    • removed the optional property // from the response with the status (media type: application/jose+jwe)

      response-optional-property-removed

    • the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json; charset=utf-8)

      response-property-pattern-changed

    • the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json)

      response-property-pattern-changed

    • the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/jose+jwe)

      response-property-pattern-changed

  • e083c4ef6d2469See the full diff
    • the //////// response property's maxLength was unset from 2048 for the response status (media type: application/json; charset=utf-8)

      response-property-max-length-unset

    • the //////// response property's maxLength was unset from 2048 for the response status (media type: application/json)

      response-property-max-length-unset

    • the //////// response property's maxLength was unset from 2048 for the response status (media type: application/jose+jwe)

      response-property-max-length-unset

    • the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/json; charset=utf-8)

      response-property-min-length-decreased

    • the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/json)

      response-property-min-length-decreased

    • the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/jose+jwe)

      response-property-min-length-decreased

    • added the optional property // to the response with the status (media type: application/json; charset=utf-8)

      response-optional-property-added

    • added the optional property // to the response with the status (media type: application/json)

      response-optional-property-added

    • added the optional property // to the response with the status (media type: application/jose+jwe)

      response-optional-property-added

    • added the optional property // to the response with the status (media type: application/json; charset=utf-8)

      response-optional-property-added

    • added the optional property // to the response with the status (media type: application/json)

      response-optional-property-added

    • added the optional property // to the response with the status (media type: application/jose+jwe)

      response-optional-property-added

    • the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/json; charset=utf-8)

      response-property-pattern-changed

    • the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/json)

      response-property-pattern-changed

    • the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/jose+jwe)

      response-property-pattern-changed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json; charset=utf-8)

      response-property-pattern-changed

    • the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json)

      response-property-pattern-changed

    • the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/jose+jwe)

      response-property-pattern-changed

    • the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/json; charset=utf-8)

      response-property-pattern-changed

    • the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/json)

      response-property-pattern-changed

    • the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/jose+jwe)

      response-property-pattern-changed

    • the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json; charset=utf-8)

      response-property-pattern-changed

    • the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json)

      response-property-pattern-changed

    • the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/jose+jwe)

      response-property-pattern-changed

    • removed the ACCC enum value from the / response property for the response status (media type: application/json; charset=utf-8)

      response-property-enum-value-removed

    • removed the ACCC enum value from the / response property for the response status (media type: application/json)

      response-property-enum-value-removed

    • removed the ACCC enum value from the / response property for the response status (media type: application/jose+jwe)

      response-property-enum-value-removed

    • removed the ACCP enum value from the / response property for the response status (media type: application/json; charset=utf-8)

      response-property-enum-value-removed

    • removed the ACCP enum value from the / response property for the response status (media type: application/json)

      response-property-enum-value-removed

    • removed the ACCP enum value from the / response property for the response status (media type: application/jose+jwe)

      response-property-enum-value-removed

    • removed the ACFC enum value from the / response property for the response status (media type: application/json; charset=utf-8)

      response-property-enum-value-removed

    • removed the ACFC enum value from the / response property for the response status (media type: application/json)

      response-property-enum-value-removed

    • removed the ACFC enum value from the / response property for the response status (media type: application/jose+jwe)

      response-property-enum-value-removed

    • removed the ACSC enum value from the / response property for the response status (media type: application/json; charset=utf-8)

      response-property-enum-value-removed

    • removed the ACSC enum value from the / response property for the response status (media type: application/json)

      response-property-enum-value-removed

    • removed the ACSC enum value from the / response property for the response status (media type: application/jose+jwe)

      response-property-enum-value-removed

    • removed the ACSP enum value from the / response property for the response status (media type: application/json; charset=utf-8)

      response-property-enum-value-removed

    • removed the ACSP enum value from the / response property for the response status (media type: application/json)

      response-property-enum-value-removed

    • removed the ACSP enum value from the / response property for the response status (media type: application/jose+jwe)

      response-property-enum-value-removed

    • removed the ACWC enum value from the / response property for the response status (media type: application/json; charset=utf-8)

      response-property-enum-value-removed

    • removed the ACWC enum value from the / response property for the response status (media type: application/json)

      response-property-enum-value-removed

    • removed the ACWC enum value from the / response property for the response status (media type: application/jose+jwe)

      response-property-enum-value-removed

    • removed the ACWP enum value from the / response property for the response status (media type: application/json; charset=utf-8)

      response-property-enum-value-removed

    • removed the ACWP enum value from the / response property for the response status (media type: application/json)

      response-property-enum-value-removed

    • removed the ACWP enum value from the / response property for the response status (media type: application/jose+jwe)

      response-property-enum-value-removed

    • removed the BLCK enum value from the / response property for the response status (media type: application/json; charset=utf-8)

      response-property-enum-value-removed

    • removed the BLCK enum value from the / response property for the response status (media type: application/json)

      response-property-enum-value-removed

    • removed the BLCK enum value from the / response property for the response status (media type: application/jose+jwe)

      response-property-enum-value-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog