Domestic Standing Orders

Submit a Domestic Standing Order

Enables a PISP to submit a Domestic Standing Order payment under an already PSU-approved Domestic Standing Order arrangement.

post/domestic-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-idempotency-keystring required

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signaturestring required

A detached JWS signature of the body of the payload.

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

Request body

Example request

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

Response

Domestic Standing Orders Created

Example response

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

Changes

Changed in 22 of the 50 revisions of this API.12078156

    • added the new Other enum value to the request property Risk/PaymentContextCode (media type: application/json; charset=utf-8)

      request-property-enum-value-added

    • added the new Other enum value to the request property Risk/PaymentContextCode (media type: application/json)

      request-property-enum-value-added

    • added the new Other enum value to the request property Risk/PaymentContextCode (media type: application/jose+jwe)

      request-property-enum-value-added

    • added the new LWMH enum value to the Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 201 (media type: application/json; charset=utf-8)

      response-property-enum-value-added

    • added the new LWMH enum value to the Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 201 (media type: application/json)

      response-property-enum-value-added

    • added the new LWMH enum value to the Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 201 (media type: application/jose+jwe)

      response-property-enum-value-added

    • added the new LXMH enum value to the Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 201 (media type: application/json; charset=utf-8)

      response-property-enum-value-added

    • added the new LXMH enum value to the Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 201 (media type: application/json)

      response-property-enum-value-added

    • added the new LXMH enum value to the Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 201 (media type: application/jose+jwe)

      response-property-enum-value-added

    • added the new TWYR enum value to the Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 201 (media type: application/json; charset=utf-8)

      response-property-enum-value-added

    • added the new TWYR enum value to the Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 201 (media type: application/json)

      response-property-enum-value-added

    • added the new TWYR enum value to the Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ response property for the response status 201 (media type: application/jose+jwe)

      response-property-enum-value-added

    • added the new LWMH enum value to the request property Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ (media type: application/json; charset=utf-8)

      request-property-enum-value-added

    • added the new LWMH enum value to the request property Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ (media type: application/json)

      request-property-enum-value-added

    • added the new LWMH enum value to the request property Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ (media type: application/jose+jwe)

      request-property-enum-value-added

    • added the new LXMH enum value to the request property Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ (media type: application/json; charset=utf-8)

      request-property-enum-value-added

    • added the new LXMH enum value to the request property Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ (media type: application/json)

      request-property-enum-value-added

    • added the new LXMH enum value to the request property Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ (media type: application/jose+jwe)

      request-property-enum-value-added

    • added the new TWYR enum value to the request property Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ (media type: application/json; charset=utf-8)

      request-property-enum-value-added

    • added the new TWYR enum value to the request property Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ (media type: application/json)

      request-property-enum-value-added

    • added the new TWYR enum value to the request property Data/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/ (media type: application/jose+jwe)

      request-property-enum-value-added

    • added the new CRYP enum value to the request property Risk/PaymentPurposeCode (media type: application/json; charset=utf-8)

      request-property-enum-value-added

    • added the new CRYP enum value to the request property Risk/PaymentPurposeCode (media type: application/json)

      request-property-enum-value-added

    • added the new CRYP enum value to the request property Risk/PaymentPurposeCode (media type: application/jose+jwe)

      request-property-enum-value-added

  • 5dbf59c53db831See the full diff
    • removed the enum value CRYP of the request property Risk/PaymentPurposeCode (media type: application/json; charset=utf-8)

      request-property-enum-value-removed

    • removed the enum value CRYP of the request property Risk/PaymentPurposeCode (media type: application/json)

      request-property-enum-value-removed

    • removed the enum value CRYP of the request property Risk/PaymentPurposeCode (media type: application/jose+jwe)

      request-property-enum-value-removed

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

      new-optional-request-parameter

    • added the new CRYP enum value to the request property Risk/PaymentPurposeCode (media type: application/json; charset=utf-8)

      request-property-enum-value-added

    • added the new CRYP enum value to the request property Risk/PaymentPurposeCode (media type: application/json)

      request-property-enum-value-added

    • added the new CRYP enum value to the request property Risk/PaymentPurposeCode (media type: application/jose+jwe)

      request-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

    • added the non-success response with the status 422

      response-non-success-status-added

  • 2e4e040f09e075See the full diff
    • added the pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ to the request property Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount (media type: application/json; charset=utf-8)

      request-property-pattern-added

    • added the pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ to the request property Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount (media type: application/json)

      request-property-pattern-added

    • added the pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ to the request property Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount (media type: application/jose+jwe)

      request-property-pattern-added

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount request property type/format changed from integer/int32 to string/ (media type: application/json)

      request-property-type-changed

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 201 (media type: application/json; charset=utf-8)

      response-property-type-changed

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 201 (media type: application/json)

      response-property-type-changed

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 201 (media type: application/jose+jwe)

      response-property-type-changed

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount request property type/format was generalized from integer/int32 to string/ (media type: application/json; charset=utf-8)

      request-property-type-generalized

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount request property type/format was generalized from integer/int32 to string/ (media type: application/jose+jwe)

      request-property-type-generalized

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

      response-property-pattern-added

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

      response-property-pattern-added

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 201 (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

  • 4ac465cd8df53315See the full diff
    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ request property's minLength was increased from 0 to 1 (media type: application/json; charset=utf-8)

      request-property-min-length-increased

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ request property's minLength was increased from 0 to 1 (media type: application/json)

      request-property-min-length-increased

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ request property's minLength was increased from 0 to 1 (media type: application/jose+jwe)

      request-property-min-length-increased

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ request property's maxLength was set to 2048 (media type: application/json; charset=utf-8)

      request-property-max-length-set

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ request property's maxLength was set to 2048 (media type: application/json)

      request-property-max-length-set

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ request property's maxLength was set to 2048 (media type: application/jose+jwe)

      request-property-max-length-set

    • added the new BillPayment enum value to the request property Risk/PaymentContextCode (media type: application/json; charset=utf-8)

      request-property-enum-value-added

    • added the new BillPayment enum value to the request property Risk/PaymentContextCode (media type: application/json)

      request-property-enum-value-added

    • added the new BillPayment enum value to the request property Risk/PaymentContextCode (media type: application/jose+jwe)

      request-property-enum-value-added

    • added the new EcommerceGoods enum value to the request property Risk/PaymentContextCode (media type: application/json; charset=utf-8)

      request-property-enum-value-added

    • added the new EcommerceGoods enum value to the request property Risk/PaymentContextCode (media type: application/json)

      request-property-enum-value-added

    • added the new EcommerceGoods enum value to the request property Risk/PaymentContextCode (media type: application/jose+jwe)

      request-property-enum-value-added

    • added the new EcommerceServices enum value to the request property Risk/PaymentContextCode (media type: application/json; charset=utf-8)

      request-property-enum-value-added

    • added the new EcommerceServices enum value to the request property Risk/PaymentContextCode (media type: application/json)

      request-property-enum-value-added

    • added the new EcommerceServices enum value to the request property Risk/PaymentContextCode (media type: application/jose+jwe)

      request-property-enum-value-added

    • added the new PartyToParty enum value to the request property Risk/PaymentContextCode (media type: application/json; charset=utf-8)

      request-property-enum-value-added

    • added the new PartyToParty enum value to the request property Risk/PaymentContextCode (media type: application/json)

      request-property-enum-value-added

    • added the new PartyToParty enum value to the request property Risk/PaymentContextCode (media type: application/jose+jwe)

      request-property-enum-value-added

    • added the new PispPayee enum value to the request property Risk/PaymentContextCode (media type: application/json; charset=utf-8)

      request-property-enum-value-added

    • added the new PispPayee enum value to the request property Risk/PaymentContextCode (media type: application/json)

      request-property-enum-value-added

    • added the new PispPayee enum value to the request property Risk/PaymentContextCode (media type: application/jose+jwe)

      request-property-enum-value-added

  • e083c4ef6d24213See the full diff
    • removed the enum value BillPayment of the request property Risk/PaymentContextCode (media type: application/json; charset=utf-8)

      request-property-enum-value-removed

    • removed the enum value BillPayment of the request property Risk/PaymentContextCode (media type: application/json)

      request-property-enum-value-removed

    • removed the enum value BillPayment of the request property Risk/PaymentContextCode (media type: application/jose+jwe)

      request-property-enum-value-removed

    • removed the enum value EcommerceGoods of the request property Risk/PaymentContextCode (media type: application/json; charset=utf-8)

      request-property-enum-value-removed

    • removed the enum value EcommerceGoods of the request property Risk/PaymentContextCode (media type: application/json)

      request-property-enum-value-removed

    • removed the enum value EcommerceGoods of the request property Risk/PaymentContextCode (media type: application/jose+jwe)

      request-property-enum-value-removed

    • removed the enum value EcommerceServices of the request property Risk/PaymentContextCode (media type: application/json; charset=utf-8)

      request-property-enum-value-removed

    • removed the enum value EcommerceServices of the request property Risk/PaymentContextCode (media type: application/json)

      request-property-enum-value-removed

    • removed the enum value EcommerceServices of the request property Risk/PaymentContextCode (media type: application/jose+jwe)

      request-property-enum-value-removed

    • removed the enum value PartyToParty of the request property Risk/PaymentContextCode (media type: application/json; charset=utf-8)

      request-property-enum-value-removed

    • removed the enum value PartyToParty of the request property Risk/PaymentContextCode (media type: application/json)

      request-property-enum-value-removed

    • removed the enum value PartyToParty of the request property Risk/PaymentContextCode (media type: application/jose+jwe)

      request-property-enum-value-removed

    • removed the enum value PispPayee of the request property Risk/PaymentContextCode (media type: application/json; charset=utf-8)

      request-property-enum-value-removed

    • removed the enum value PispPayee of the request property Risk/PaymentContextCode (media type: application/json)

      request-property-enum-value-removed

    • removed the enum value PispPayee of the request property Risk/PaymentContextCode (media type: application/jose+jwe)

      request-property-enum-value-removed

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 201 (media type: application/json; charset=utf-8)

      response-property-max-length-unset

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 201 (media type: application/json)

      response-property-max-length-unset

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 201 (media type: application/jose+jwe)

      response-property-max-length-unset

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 201 (media type: application/json; charset=utf-8)

      response-property-min-length-decreased

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 201 (media type: application/json)

      response-property-min-length-decreased

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 201 (media type: application/jose+jwe)

      response-property-min-length-decreased

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ request property's minLength was decreased from 1 to 0 (media type: application/json; charset=utf-8)

      request-property-min-length-decreased

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ request property's minLength was decreased from 1 to 0 (media type: application/json)

      request-property-min-length-decreased

    • the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ request property's minLength was decreased from 1 to 0 (media type: application/jose+jwe)

      request-property-min-length-decreased

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