Submit a Domestic Standing Order
Enables a PISP to submit a Domestic Standing Order payment under an already PSU-approved Domestic Standing Order arrangement.
Headers
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
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
A detached JWS signature of the body of the payload.
Indicates the user-agent that the PSU is using.
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
Otherenum value to the request propertyRisk/PaymentContextCode(media type: application/json; charset=utf-8)request-property-enum-value-added
- ○
added the new
Otherenum value to the request propertyRisk/PaymentContextCode(media type: application/json)request-property-enum-value-added
- ○
added the new
Otherenum value to the request propertyRisk/PaymentContextCode(media type: application/jose+jwe)request-property-enum-value-added
- ○
- ●
added the new
LWMHenum value to theData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/response property for the response status201(media type: application/json; charset=utf-8)response-property-enum-value-added
- ●
added the new
LWMHenum value to theData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/response property for the response status201(media type: application/json)response-property-enum-value-added
- ●
added the new
LWMHenum value to theData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/response property for the response status201(media type: application/jose+jwe)response-property-enum-value-added
- ●
added the new
LXMHenum value to theData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/response property for the response status201(media type: application/json; charset=utf-8)response-property-enum-value-added
- ●
added the new
LXMHenum value to theData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/response property for the response status201(media type: application/json)response-property-enum-value-added
- ●
added the new
LXMHenum value to theData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/response property for the response status201(media type: application/jose+jwe)response-property-enum-value-added
- ●
added the new
TWYRenum value to theData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/response property for the response status201(media type: application/json; charset=utf-8)response-property-enum-value-added
- ●
added the new
TWYRenum value to theData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/response property for the response status201(media type: application/json)response-property-enum-value-added
- ●
added the new
TWYRenum value to theData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/response property for the response status201(media type: application/jose+jwe)response-property-enum-value-added
- ○
added the new
LWMHenum value to the request propertyData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/(media type: application/json; charset=utf-8)request-property-enum-value-added
- ○
added the new
LWMHenum value to the request propertyData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/(media type: application/json)request-property-enum-value-added
- ○
added the new
LWMHenum value to the request propertyData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/(media type: application/jose+jwe)request-property-enum-value-added
- ○
added the new
LXMHenum value to the request propertyData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/(media type: application/json; charset=utf-8)request-property-enum-value-added
- ○
added the new
LXMHenum value to the request propertyData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/(media type: application/json)request-property-enum-value-added
- ○
added the new
LXMHenum value to the request propertyData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/(media type: application/jose+jwe)request-property-enum-value-added
- ○
added the new
TWYRenum value to the request propertyData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/(media type: application/json; charset=utf-8)request-property-enum-value-added
- ○
added the new
TWYRenum value to the request propertyData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/(media type: application/json)request-property-enum-value-added
- ○
added the new
TWYRenum value to the request propertyData/Initiation/MandateRelatedInformation/Frequency/Type/oneOf[OBFrequency6Code]/(media type: application/jose+jwe)request-property-enum-value-added
- ●
- ○
added the new
CRYPenum value to the request propertyRisk/PaymentPurposeCode(media type: application/json; charset=utf-8)request-property-enum-value-added
- ○
added the new
CRYPenum value to the request propertyRisk/PaymentPurposeCode(media type: application/json)request-property-enum-value-added
- ○
added the new
CRYPenum value to the request propertyRisk/PaymentPurposeCode(media type: application/jose+jwe)request-property-enum-value-added
- ○
- ▲
removed the enum value
CRYPof the request propertyRisk/PaymentPurposeCode(media type: application/json; charset=utf-8)request-property-enum-value-removed
- ▲
removed the enum value
CRYPof the request propertyRisk/PaymentPurposeCode(media type: application/json)request-property-enum-value-removed
- ▲
removed the enum value
CRYPof the request propertyRisk/PaymentPurposeCode(media type: application/jose+jwe)request-property-enum-value-removed
- ○
added the new optional
headerrequest parameterx-client-idnew-optional-request-parameter
- ▲
- ○
added the new
CRYPenum value to the request propertyRisk/PaymentPurposeCode(media type: application/json; charset=utf-8)request-property-enum-value-added
- ○
added the new
CRYPenum value to the request propertyRisk/PaymentPurposeCode(media type: application/json)request-property-enum-value-added
- ○
added the new
CRYPenum value to the request propertyRisk/PaymentPurposeCode(media type: application/jose+jwe)request-property-enum-value-added
- ○
- ●
added the new
ACCCenum value to theData/Statusresponse property for the response status201(media type: application/json; charset=utf-8)response-property-enum-value-added
- ●
added the new
ACCCenum value to theData/Statusresponse property for the response status201(media type: application/json)response-property-enum-value-added
- ●
added the new
ACCCenum value to theData/Statusresponse property for the response status201(media type: application/jose+jwe)response-property-enum-value-added
- ●
added the new
ACCPenum value to theData/Statusresponse property for the response status201(media type: application/json; charset=utf-8)response-property-enum-value-added
- ●
added the new
ACCPenum value to theData/Statusresponse property for the response status201(media type: application/json)response-property-enum-value-added
- ●
added the new
ACCPenum value to theData/Statusresponse property for the response status201(media type: application/jose+jwe)response-property-enum-value-added
- ●
added the new
ACFCenum value to theData/Statusresponse property for the response status201(media type: application/json; charset=utf-8)response-property-enum-value-added
- ●
added the new
ACFCenum value to theData/Statusresponse property for the response status201(media type: application/json)response-property-enum-value-added
- ●
added the new
ACFCenum value to theData/Statusresponse property for the response status201(media type: application/jose+jwe)response-property-enum-value-added
- ●
added the new
ACSCenum value to theData/Statusresponse property for the response status201(media type: application/json; charset=utf-8)response-property-enum-value-added
- ●
added the new
ACSCenum value to theData/Statusresponse property for the response status201(media type: application/json)response-property-enum-value-added
- ●
added the new
ACSCenum value to theData/Statusresponse property for the response status201(media type: application/jose+jwe)response-property-enum-value-added
- ●
added the new
ACSPenum value to theData/Statusresponse property for the response status201(media type: application/json; charset=utf-8)response-property-enum-value-added
- ●
added the new
ACSPenum value to theData/Statusresponse property for the response status201(media type: application/json)response-property-enum-value-added
- ●
added the new
ACSPenum value to theData/Statusresponse property for the response status201(media type: application/jose+jwe)response-property-enum-value-added
- ●
added the new
ACWCenum value to theData/Statusresponse property for the response status201(media type: application/json; charset=utf-8)response-property-enum-value-added
- ●
added the new
ACWCenum value to theData/Statusresponse property for the response status201(media type: application/json)response-property-enum-value-added
- ●
added the new
ACWCenum value to theData/Statusresponse property for the response status201(media type: application/jose+jwe)response-property-enum-value-added
- ●
added the new
ACWPenum value to theData/Statusresponse property for the response status201(media type: application/json; charset=utf-8)response-property-enum-value-added
- ●
added the new
ACWPenum value to theData/Statusresponse property for the response status201(media type: application/json)response-property-enum-value-added
- ●
added the new
ACWPenum value to theData/Statusresponse property for the response status201(media type: application/jose+jwe)response-property-enum-value-added
- ●
added the new
BLCKenum value to theData/Statusresponse property for the response status201(media type: application/json; charset=utf-8)response-property-enum-value-added
- ●
added the new
BLCKenum value to theData/Statusresponse property for the response status201(media type: application/json)response-property-enum-value-added
- ●
added the new
BLCKenum value to theData/Statusresponse property for the response status201(media type: application/jose+jwe)response-property-enum-value-added
- ●
- ○
added the non-success response with the status
422response-non-success-status-added
- ○
- ▲
added the pattern
^\d{1,13}$|^\d{1,13}\.\d{1,5}$to the request propertyData/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 propertyData/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 propertyData/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount(media type: application/jose+jwe)request-property-pattern-added
- ▲
the
Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmountrequest property type/format changed frominteger/int32tostring/(media type: application/json)request-property-type-changed
- ▲
the
Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmountresponse's property type/format changed frominteger/int32tostring/for status201(media type: application/json; charset=utf-8)response-property-type-changed
- ▲
the
Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmountresponse's property type/format changed frominteger/int32tostring/for status201(media type: application/json)response-property-type-changed
- ▲
the
Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmountresponse's property type/format changed frominteger/int32tostring/for status201(media type: application/jose+jwe)response-property-type-changed
- ○
the
Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmountrequest property type/format was generalized frominteger/int32tostring/(media type: application/json; charset=utf-8)request-property-type-generalized
- ○
the
Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmountrequest property type/format was generalized frominteger/int32tostring/(media type: application/jose+jwe)request-property-type-generalized
- ○
the
Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmountresponse's property pattern^\d{1,13}$|^\d{1,13}\.\d{1,5}$was added for the status201(media type: application/json; charset=utf-8)response-property-pattern-added
- ○
the
Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmountresponse's property pattern^\d{1,13}$|^\d{1,13}\.\d{1,5}$was added for the status201(media type: application/json)response-property-pattern-added
- ○
the
Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmountresponse's property pattern^\d{1,13}$|^\d{1,13}\.\d{1,5}$was added for the status201(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
- ▲
- ▲
the
Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/request property's minLength was increased from0to1(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 from0to1(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 from0to1(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 to2048(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 to2048(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 to2048(media type: application/jose+jwe)request-property-max-length-set
- ○
added the new
BillPaymentenum value to the request propertyRisk/PaymentContextCode(media type: application/json; charset=utf-8)request-property-enum-value-added
- ○
added the new
BillPaymentenum value to the request propertyRisk/PaymentContextCode(media type: application/json)request-property-enum-value-added
- ○
added the new
BillPaymentenum value to the request propertyRisk/PaymentContextCode(media type: application/jose+jwe)request-property-enum-value-added
- ○
added the new
EcommerceGoodsenum value to the request propertyRisk/PaymentContextCode(media type: application/json; charset=utf-8)request-property-enum-value-added
- ○
added the new
EcommerceGoodsenum value to the request propertyRisk/PaymentContextCode(media type: application/json)request-property-enum-value-added
- ○
added the new
EcommerceGoodsenum value to the request propertyRisk/PaymentContextCode(media type: application/jose+jwe)request-property-enum-value-added
- ○
added the new
EcommerceServicesenum value to the request propertyRisk/PaymentContextCode(media type: application/json; charset=utf-8)request-property-enum-value-added
- ○
added the new
EcommerceServicesenum value to the request propertyRisk/PaymentContextCode(media type: application/json)request-property-enum-value-added
- ○
added the new
EcommerceServicesenum value to the request propertyRisk/PaymentContextCode(media type: application/jose+jwe)request-property-enum-value-added
- ○
added the new
PartyToPartyenum value to the request propertyRisk/PaymentContextCode(media type: application/json; charset=utf-8)request-property-enum-value-added
- ○
added the new
PartyToPartyenum value to the request propertyRisk/PaymentContextCode(media type: application/json)request-property-enum-value-added
- ○
added the new
PartyToPartyenum value to the request propertyRisk/PaymentContextCode(media type: application/jose+jwe)request-property-enum-value-added
- ○
added the new
PispPayeeenum value to the request propertyRisk/PaymentContextCode(media type: application/json; charset=utf-8)request-property-enum-value-added
- ○
added the new
PispPayeeenum value to the request propertyRisk/PaymentContextCode(media type: application/json)request-property-enum-value-added
- ○
added the new
PispPayeeenum value to the request propertyRisk/PaymentContextCode(media type: application/jose+jwe)request-property-enum-value-added
- ▲
- ▲
removed the enum value
BillPaymentof the request propertyRisk/PaymentContextCode(media type: application/json; charset=utf-8)request-property-enum-value-removed
- ▲
removed the enum value
BillPaymentof the request propertyRisk/PaymentContextCode(media type: application/json)request-property-enum-value-removed
- ▲
removed the enum value
BillPaymentof the request propertyRisk/PaymentContextCode(media type: application/jose+jwe)request-property-enum-value-removed
- ▲
removed the enum value
EcommerceGoodsof the request propertyRisk/PaymentContextCode(media type: application/json; charset=utf-8)request-property-enum-value-removed
- ▲
removed the enum value
EcommerceGoodsof the request propertyRisk/PaymentContextCode(media type: application/json)request-property-enum-value-removed
- ▲
removed the enum value
EcommerceGoodsof the request propertyRisk/PaymentContextCode(media type: application/jose+jwe)request-property-enum-value-removed
- ▲
removed the enum value
EcommerceServicesof the request propertyRisk/PaymentContextCode(media type: application/json; charset=utf-8)request-property-enum-value-removed
- ▲
removed the enum value
EcommerceServicesof the request propertyRisk/PaymentContextCode(media type: application/json)request-property-enum-value-removed
- ▲
removed the enum value
EcommerceServicesof the request propertyRisk/PaymentContextCode(media type: application/jose+jwe)request-property-enum-value-removed
- ▲
removed the enum value
PartyToPartyof the request propertyRisk/PaymentContextCode(media type: application/json; charset=utf-8)request-property-enum-value-removed
- ▲
removed the enum value
PartyToPartyof the request propertyRisk/PaymentContextCode(media type: application/json)request-property-enum-value-removed
- ▲
removed the enum value
PartyToPartyof the request propertyRisk/PaymentContextCode(media type: application/jose+jwe)request-property-enum-value-removed
- ▲
removed the enum value
PispPayeeof the request propertyRisk/PaymentContextCode(media type: application/json; charset=utf-8)request-property-enum-value-removed
- ▲
removed the enum value
PispPayeeof the request propertyRisk/PaymentContextCode(media type: application/json)request-property-enum-value-removed
- ▲
removed the enum value
PispPayeeof the request propertyRisk/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 from2048for the response status201(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 from2048for the response status201(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 from2048for the response status201(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 from1to0for the response status201(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 from1to0for the response status201(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 from1to0for the response status201(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 from1to0(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 from1to0(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 from1to0(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
- ▲