OPopenbankinguk
Domestic Standing Orders

Submit a Domestic Standing Order

Changed on

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

post/domestic-standing-orders

Request

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

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

  • 59fa1131ff96Revision changes
    • info

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

    • info

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

    • info

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

  • b3abc87b280cRevision 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)

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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