Consents
Create
The API allows the TPP to ask an ASPSP to create a new payment-access-consent resource.
CURL
curl -i \ -H "Authorization: Bearer authorization" \ -H "Content-Type: application/json" \ -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ -H "Accept: application/json" \ -H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \ -H "Idempotency-Key: da7c525d-9ec0-4b28-aae5-e97f6f39dfbd" \ -H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \ -H "x-fapi-customer-ip-address: 104.25.212.99" \ -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkF1dGhvcmlzYXRpb24iOnsiQXV0aG9yaXNhdGlvblR5cGUiOiJBdXRoIiwiQ29tcGxldGlvbkRhdGVUaW1lIjoiMjAxNy0wNi0wNVQxNToxNToxMyswMDowMCJ9LCJTQ0FTdXBwb3J0RGF0YSI6eyJBcHBsaWVkQXV0aGVudGljYXRpb25BcHByb2FjaCI6IkFwcGxpZWRBdXRoZW50aWNhdGlvbkFwcHJvYWNoIiwiUmVmZXJlbmNlUGF5bWVudE9yZGVySWQiOiIxNTY0NTIiLCJSZXF1ZXN0ZWRTQ0FFeGVtcHRpb25UeXBlIjoiUmVxdWVzdGVkU0NBRXhlbXB0aW9uVHlwZSJ9LCJJbml0aWF0aW9uIjp7Ikluc3RydWN0aW9uSWRlbnRpZmljYXRpb24iOiJBTlNNMDIzIiwiRW5kVG9FbmRJZGVudGlmaWNhdGlvbiI6IkZSRVNDTy4yMTMwMi5HRlguMzciLCJMb2NhbEluc3RydW1lbnQiOiJVSy5PQklFLkZQUyIsIkluc3RydWN0ZWRBbW91bnQiOnsiQW1vdW50IjoiMjAuMDAiLCJDdXJyZW5jeSI6IkdCUCJ9LCJEZWJ0b3JBY2NvdW50Ijp7IlNjaGVtZU5hbWUiOiJVSy5PQklFLlNvcnRDb2RlQWNjb3VudE51bWJlciIsIklkZW50aWZpY2F0aW9uIjoiMTEyODAwMDEyMzQ1NjciLCJOYW1lIjoiQW5kcmVhIFNtaXRoIiwiU2Vjb25kYXJ5SWRlbnRpZmljYXRpb24iOiIwMDAyIn0sIkNyZWRpdG9yQWNjb3VudCI6eyJTY2hlbWVOYW1lIjoiVUsuT0JJRS5Tb3J0Q29kZUFjY291bnROdW1iZXIiLCJJZGVudGlmaWNhdGlvbiI6IjA4MDgwMDIxMzI1Njk4IiwiTmFtZSI6IkJvYiBDbGVtZW50cyIsIlNlY29uZGFyeUlkZW50aWZpY2F0aW9uIjoiMDAwMyJ9LCJDcmVkaXRvclBvc3RhbEFkZHJlc3MiOnsiQWRkcmVzc0xpbmUiOlsiMTAgRG93bmluZyBTdCwgV2VzdG1pbnN0ZXIsIExvbmRvbiBTVzFBIDJBQSwgVW5pdGVkIEtpbmdkb20iXSwiQWRkcmVzc1R5cGUiOiJBZGRyZXNzIHdpdGggaG91c2UgbnVtYmVyIGFuZCBzdHJlZXQiLCJEZXBhcnRtZW50IjoiUHJpbWUgTWluaXN0ZXIncyBPZmZpY2UiLCJTdWJEZXBhcnRtZW50IjoiQ2FiaW5ldCBPZmZpY2UiLCJTdHJlZXROYW1lIjoiU2lyIEdlb3JnZSBEb3duaW5nIiwiQnVpbGRpbmdOdW1iZXIiOiIxMCIsIlBvc3RDb2RlIjoiU1cxQSAyQUEiLCJUb3duTmFtZSI6IkNpdHkgb2YgV2VzdG1pbnN0ZXIgTG9uZG9uLCIsIkNvdW50cnlTdWJEaXZpc2lvbiI6IkxvbmRvbiIsIkNvdW50cnkiOiJHQiJ9LCJSZW1pdHRhbmNlSW5mb3JtYXRpb24iOnsiUmVmZXJlbmNlIjoiRlJFU0NPLTAzNyIsIlVuc3RydWN0dXJlZCI6IkludGVybmFsIG9wcyBjb2RlIDUxMjAxMDMifSwiU3VwcGxlbWVudGFyeURhdGEiOnt9fX0sIlJpc2siOnsiUGF5bWVudENvbnRleHRDb2RlIjoiRWNvbW1lcmNlR29vZHMiLCJNZXJjaGFudENhdGVnb3J5Q29kZSI6IjU5NjciLCJNZXJjaGFudEN1c3RvbWVySWRlbnRpZmljYXRpb24iOiIwNTM1OTg2NTMyNTQiLCJEZWxpdmVyeUFkZHJlc3MiOnsiQWRkcmVzc0xpbmUiOlsiRmxhdCA3IiwiQWNhY2lhIExvZGdlIl0sIlN0cmVldE5hbWUiOiJBY2FjaWEgQXZlbnVlIiwiQnVpbGRpbmdOdW1iZXIiOiIyNyIsIlBvc3RDb2RlIjoiR1UzMSAyWloiLCJUb3duTmFtZSI6IlNwYXJzaG9sdCIsIkNvdW50cnlTdWJEaXZpc2lvbiI6Ildlc3NleCIsIkNvdW50cnkiOiJHQiJ9fX0.AWJ1_D42zrEyN_JlSufDUoDjsGYyTOGoHhByW5Nx5qC5c48huoaYMpip_pdnN7SYWRR4Avy2okNvZjYDZmkYjL-gLxANP2SVdBB9SDo-VE56Uxf3w3mDwuZ4Qo82FxN7CzUXI-2q6qcCzM2lWceVTTNOY_eU7YSnpTLL8ZdtZNQ2HkKdMyGCG51IZgP4lKdArqCj0OUA-2nmUX3JxtdkZsPPxagj3EqOlbkaGrtOg9J-8siCZKuly5e1SHlj_j51rcDe_0duNyX6ptD3tVpA_mH7riufW9TeHPgmdMv7RcfeJE4P6c6rRmG7rNxsf6KN2U68ivOjMdoveBsEqWgmUQ' \ -X POST "/api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product"
curl -i \
-H "Authorization: Bearer authorization" \
-H "Content-Type: application/json" \
-H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \
-H "Accept: application/json" \
-H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \
-H "Idempotency-Key: da7c525d-9ec0-4b28-aae5-e97f6f39dfbd" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkF1dGhvcmlzYXRpb24iOnsiQXV0aG9yaXNhdGlvblR5cGUiOiJBdXRoIiwiQ29tcGxldGlvbkRhdGVUaW1lIjoiMjAxNy0wNi0wNVQxNToxNToxMyswMDowMCJ9LCJTQ0FTdXBwb3J0RGF0YSI6eyJBcHBsaWVkQXV0aGVudGljYXRpb25BcHByb2FjaCI6IkFwcGxpZWRBdXRoZW50aWNhdGlvbkFwcHJvYWNoIiwiUmVmZXJlbmNlUGF5bWVudE9yZGVySWQiOiIxNTY0NTIiLCJSZXF1ZXN0ZWRTQ0FFeGVtcHRpb25UeXBlIjoiUmVxdWVzdGVkU0NBRXhlbXB0aW9uVHlwZSJ9LCJJbml0aWF0aW9uIjp7Ikluc3RydWN0aW9uSWRlbnRpZmljYXRpb24iOiJBTlNNMDIzIiwiRW5kVG9FbmRJZGVudGlmaWNhdGlvbiI6IkZSRVNDTy4yMTMwMi5HRlguMzciLCJMb2NhbEluc3RydW1lbnQiOiJVSy5PQklFLkZQUyIsIkluc3RydWN0ZWRBbW91bnQiOnsiQW1vdW50IjoiMjAuMDAiLCJDdXJyZW5jeSI6IkdCUCJ9LCJEZWJ0b3JBY2NvdW50Ijp7IlNjaGVtZU5hbWUiOiJVSy5PQklFLlNvcnRDb2RlQWNjb3VudE51bWJlciIsIklkZW50aWZpY2F0aW9uIjoiMTEyODAwMDEyMzQ1NjciLCJOYW1lIjoiQW5kcmVhIFNtaXRoIiwiU2Vjb25kYXJ5SWRlbnRpZmljYXRpb24iOiIwMDAyIn0sIkNyZWRpdG9yQWNjb3VudCI6eyJTY2hlbWVOYW1lIjoiVUsuT0JJRS5Tb3J0Q29kZUFjY291bnROdW1iZXIiLCJJZGVudGlmaWNhdGlvbiI6IjA4MDgwMDIxMzI1Njk4IiwiTmFtZSI6IkJvYiBDbGVtZW50cyIsIlNlY29uZGFyeUlkZW50aWZpY2F0aW9uIjoiMDAwMyJ9LCJDcmVkaXRvclBvc3RhbEFkZHJlc3MiOnsiQWRkcmVzc0xpbmUiOlsiMTAgRG93bmluZyBTdCwgV2VzdG1pbnN0ZXIsIExvbmRvbiBTVzFBIDJBQSwgVW5pdGVkIEtpbmdkb20iXSwiQWRkcmVzc1R5cGUiOiJBZGRyZXNzIHdpdGggaG91c2UgbnVtYmVyIGFuZCBzdHJlZXQiLCJEZXBhcnRtZW50IjoiUHJpbWUgTWluaXN0ZXIncyBPZmZpY2UiLCJTdWJEZXBhcnRtZW50IjoiQ2FiaW5ldCBPZmZpY2UiLCJTdHJlZXROYW1lIjoiU2lyIEdlb3JnZSBEb3duaW5nIiwiQnVpbGRpbmdOdW1iZXIiOiIxMCIsIlBvc3RDb2RlIjoiU1cxQSAyQUEiLCJUb3duTmFtZSI6IkNpdHkgb2YgV2VzdG1pbnN0ZXIgTG9uZG9uLCIsIkNvdW50cnlTdWJEaXZpc2lvbiI6IkxvbmRvbiIsIkNvdW50cnkiOiJHQiJ9LCJSZW1pdHRhbmNlSW5mb3JtYXRpb24iOnsiUmVmZXJlbmNlIjoiRlJFU0NPLTAzNyIsIlVuc3RydWN0dXJlZCI6IkludGVybmFsIG9wcyBjb2RlIDUxMjAxMDMifSwiU3VwcGxlbWVudGFyeURhdGEiOnt9fX0sIlJpc2siOnsiUGF5bWVudENvbnRleHRDb2RlIjoiRWNvbW1lcmNlR29vZHMiLCJNZXJjaGFudENhdGVnb3J5Q29kZSI6IjU5NjciLCJNZXJjaGFudEN1c3RvbWVySWRlbnRpZmljYXRpb24iOiIwNTM1OTg2NTMyNTQiLCJEZWxpdmVyeUFkZHJlc3MiOnsiQWRkcmVzc0xpbmUiOlsiRmxhdCA3IiwiQWNhY2lhIExvZGdlIl0sIlN0cmVldE5hbWUiOiJBY2FjaWEgQXZlbnVlIiwiQnVpbGRpbmdOdW1iZXIiOiIyNyIsIlBvc3RDb2RlIjoiR1UzMSAyWloiLCJUb3duTmFtZSI6IlNwYXJzaG9sdCIsIkNvdW50cnlTdWJEaXZpc2lvbiI6Ildlc3NleCIsIkNvdW50cnkiOiJHQiJ9fX0.AWJ1_D42zrEyN_JlSufDUoDjsGYyTOGoHhByW5Nx5qC5c48huoaYMpip_pdnN7SYWRR4Avy2okNvZjYDZmkYjL-gLxANP2SVdBB9SDo-VE56Uxf3w3mDwuZ4Qo82FxN7CzUXI-2q6qcCzM2lWceVTTNOY_eU7YSnpTLL8ZdtZNQ2HkKdMyGCG51IZgP4lKdArqCj0OUA-2nmUX3JxtdkZsPPxagj3EqOlbkaGrtOg9J-8siCZKuly5e1SHlj_j51rcDe_0duNyX6ptD3tVpA_mH7riufW9TeHPgmdMv7RcfeJE4P6c6rRmG7rNxsf6KN2U68ivOjMdoveBsEqWgmUQ' \
-X POST "/api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product"Example of request
{"Data":{"Authorisation":{"AuthorisationType":"Auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"156452","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}}}
{"Data":{"Authorisation":{"AuthorisationType":"Auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"156452","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}}}
{"Data":{"Permission":"Create","Authorisation":{"AuthorisationType":"Auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"156452","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}}}
{"Data":{"Permission":"Create","Authorisation":{"AuthorisationType":"Auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"156452","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}}}
{"Data":{"Permission":"Create","Authorisation":{"AuthorisationType":"Auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"156452","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"Frequency":"EvryDay","FirstPaymentDateTime":"2017-06-05T15:15:13+00:00","FirstPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"FinalPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"RecurringPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}}}
{"Data":{"Permission":"Create","Authorisation":{"AuthorisationType":"Auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"156452","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"Frequency":"EvryDay","FirstPaymentDateTime":"2017-06-05T15:15:13+00:00","FirstPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"FinalPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"RecurringPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}}}
{"Data":{"Authorisation":{"AuthorisationType":"TBD","CompletionDateTime":"TBD"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"TBD","ChargeBearer":"TBD","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}},"SCASupportData":{"AppliedAuthenticationApproach":"TBD","ReferencePaymentOrderId":"TBD","RequestedSCAExemptionType":"TBD"}},"Risk":{"PaymentContextCode":"PartyToParty","MerchantCategoryCode":"TBD","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB"}}}
{"Data":{"Authorisation":{"AuthorisationType":"TBD","CompletionDateTime":"TBD"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"TBD","ChargeBearer":"TBD","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}},"SCASupportData":{"AppliedAuthenticationApproach":"TBD","ReferencePaymentOrderId":"TBD","RequestedSCAExemptionType":"TBD"}},"Risk":{"PaymentContextCode":"PartyToParty","MerchantCategoryCode":"TBD","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB"}}}
{"Data":{"Permission":"Create","ReadRefundAccount":"Yes","Authorisation":{"AuthorisationType":"TBD","CompletionDateTime":"TBD"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"ABCD","ExtendedPurpose":"ExtendedPurpose","DestinationCountryCode":"RO","ChargeBearer":"TBD","CurrencyOfTransfer":"GBP","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}},"SCASupportData":{"AppliedAuthenticationApproach":"TBD","ReferencePaymentOrderId":"TBD","RequestedSCAExemptionType":"TBD"}},"Risk":{"PaymentContextCode":"PartyToParty","MerchantCategoryCode":"TBD","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB"}}}
{"Data":{"Permission":"Create","ReadRefundAccount":"Yes","Authorisation":{"AuthorisationType":"TBD","CompletionDateTime":"TBD"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"ABCD","ExtendedPurpose":"ExtendedPurpose","DestinationCountryCode":"RO","ChargeBearer":"TBD","CurrencyOfTransfer":"GBP","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}},"SCASupportData":{"AppliedAuthenticationApproach":"TBD","ReferencePaymentOrderId":"TBD","RequestedSCAExemptionType":"TBD"}},"Risk":{"PaymentContextCode":"PartyToParty","MerchantCategoryCode":"TBD","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB"}}}
Example of response
{"Data":{"ConsentId":"18463","Status":"AwaitingAuthorisation","CreationDateTime":"2017-06-05T15:15:13+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ReadRefundAccount":"Yes","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"21342","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-payment-consents/58923","First":"/open-banking/v3.1/pisp/domestic-payment-consents/58923","Last":"/open-banking/v3.1/pisp/domestic-payment-consents/58925","Next":"/open-banking/v3.1/pisp/domestic-payment-consents/58924","Prev":"/open-banking/v3.1/pisp/domestic-payment-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"18463","Status":"AwaitingAuthorisation","CreationDateTime":"2017-06-05T15:15:13+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ReadRefundAccount":"Yes","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"21342","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-payment-consents/58923","First":"/open-banking/v3.1/pisp/domestic-payment-consents/58923","Last":"/open-banking/v3.1/pisp/domestic-payment-consents/58925","Next":"/open-banking/v3.1/pisp/domestic-payment-consents/58924","Prev":"/open-banking/v3.1/pisp/domestic-payment-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"18463","Status":"AwaitingAuthorisation","CreationDateTime":"2017-06-05T15:15:13+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ReadRefundAccount":"Yes","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Permission":"Create","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"21342","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"New Test","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58923","First":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58923","Last":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58925","Next":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58924","Prev":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"18463","Status":"AwaitingAuthorisation","CreationDateTime":"2017-06-05T15:15:13+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ReadRefundAccount":"Yes","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Permission":"Create","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"21342","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"New Test","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58923","First":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58923","Last":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58925","Next":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58924","Prev":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"18463","Status":"AwaitingAuthorisation","CreationDateTime":"2017-06-05T15:15:13+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ReadRefundAccount":"Yes","Permission":"Create","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"21342","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"Frequency":"EvryDay","FirstPaymentDateTime":"2017-06-05T15:15:13+00:00","FirstPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"FinalPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"RecurringPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58923","First":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58923","Last":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58925","Next":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58924","Prev":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"18463","Status":"AwaitingAuthorisation","CreationDateTime":"2017-06-05T15:15:13+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ReadRefundAccount":"Yes","Permission":"Create","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"21342","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"Frequency":"EvryDay","FirstPaymentDateTime":"2017-06-05T15:15:13+00:00","FirstPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"FinalPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"RecurringPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58923","First":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58923","Last":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58925","Next":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58924","Prev":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"58923","CreationDateTime":"2017-06-05T15:15:13+00:00","Status":"AwaitingAuthorisation","ReadRefundAccount":"Yes","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"TBD","CompletionDateTime":"TBD"},"SCASupportData":{"AppliedAuthenticationApproach":"TBD","ReferencePaymentOrderId":"TBD","RequestedSCAExemptionType":"TBD"},"Charges":[{"ChargeBearer":"TBD","Type":"TBD","Amount":{"Amount":123,"Currency":"GBP"}}],"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","ContractIdentification":"TBD","RateType":"TBD","ExpirationDateTime":"TBD"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"TBD","ChargeBearer":"TBD","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/international-payment-consents/58923","First":"/open-banking/v3.1/pisp/international-payment-consents/58923","Last":"/open-banking/v3.1/pisp/international-payment-consents/58925","Next":"/open-banking/v3.1/pisp/international-payment-consents/58924","Prev":"/open-banking/v3.1/pisp/international-payment-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"58923","CreationDateTime":"2017-06-05T15:15:13+00:00","Status":"AwaitingAuthorisation","ReadRefundAccount":"Yes","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"TBD","CompletionDateTime":"TBD"},"SCASupportData":{"AppliedAuthenticationApproach":"TBD","ReferencePaymentOrderId":"TBD","RequestedSCAExemptionType":"TBD"},"Charges":[{"ChargeBearer":"TBD","Type":"TBD","Amount":{"Amount":123,"Currency":"GBP"}}],"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","ContractIdentification":"TBD","RateType":"TBD","ExpirationDateTime":"TBD"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"TBD","ChargeBearer":"TBD","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/international-payment-consents/58923","First":"/open-banking/v3.1/pisp/international-payment-consents/58923","Last":"/open-banking/v3.1/pisp/international-payment-consents/58925","Next":"/open-banking/v3.1/pisp/international-payment-consents/58924","Prev":"/open-banking/v3.1/pisp/international-payment-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"58924","CreationDateTime":"2017-06-05T15:15:13+00:00","Status":"AwaitingAuthorisation","Permission":"Create","ReadRefundAccount":"Yes","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"TBD","CompletionDateTime":"TBD"},"Charges":[{"ChargeBearer":"TBD","Type":"TBD","Amount":{"Amount":123,"Currency":"GBP"}}],"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","ContractIdentification":"TBD","RateType":"TBD","ExpirationDateTime":"TBD"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"ABCD","ExtendedPurpose":"ExtendedPurpose","DestinationCountryCode":"RO","ChargeBearer":"TBD","CurrencyOfTransfer":"GBP","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}},"SCASupportData":{"AppliedAuthenticationApproach":"TBD","ReferencePaymentOrderId":"TBD","RequestedSCAExemptionType":"TBD"}},"Risk":{"PaymentContextCode":"PartyToParty","MerchantCategoryCode":"TBD","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/international-scheduled-payment-consents/58924"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"58924","CreationDateTime":"2017-06-05T15:15:13+00:00","Status":"AwaitingAuthorisation","Permission":"Create","ReadRefundAccount":"Yes","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"TBD","CompletionDateTime":"TBD"},"Charges":[{"ChargeBearer":"TBD","Type":"TBD","Amount":{"Amount":123,"Currency":"GBP"}}],"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","ContractIdentification":"TBD","RateType":"TBD","ExpirationDateTime":"TBD"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"ABCD","ExtendedPurpose":"ExtendedPurpose","DestinationCountryCode":"RO","ChargeBearer":"TBD","CurrencyOfTransfer":"GBP","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}},"SCASupportData":{"AppliedAuthenticationApproach":"TBD","ReferencePaymentOrderId":"TBD","RequestedSCAExemptionType":"TBD"}},"Risk":{"PaymentContextCode":"PartyToParty","MerchantCategoryCode":"TBD","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/international-scheduled-payment-consents/58924"},"Meta":{"TotalPages":1}}
Request
POST
/api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product
Headers
| Header | Type | Description |
|---|---|---|
Content-Type
|
string, required | The media type of the body of the request. Default value: application/json Can raise: FieldInvalid |
x-fapi-interaction-id
|
string, optional | An RFC4122 UID used as a correlation Id. Can raise: FieldInvalid |
Accept
|
string, optional | Media type that is acceptable for the response. Can raise: FieldInvalid |
x-fapi-auth-date
|
string, optional | The time when the PSU last logged in with the TPP. Can raise: FieldInvalid |
x-fapi-customer-ip-address
|
string, optional | The PSU's IP address if the PSU is currently logged in with the TPP. Can raise: FieldInvalid |
Authorization
|
string, required | Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden |
x-jws-signature
|
string, optional | A detached JWS signature of the body of the payload. |
Idempotency-Key
|
string, optional | Unique uuid used to recognize subsequent retries of the same request valid for 24 hours. Allowed length: max: 40 characters |
Request parameters
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
consent_payment_product
(path)
string, required
The addressed consent payment resource.
Allowed values:
domestic-payment-consents, domestic-scheduled-payment-consents
Can raise:
FieldInvalid, ResourceNotFound
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Data
hash, required
Wrapper for the data.
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Allowed values:
Yes, No
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, required
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.FPS
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorPostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
consent_payment_product
(path)
string, required
The addressed consent payment resource.
Allowed values:
domestic-payment-consents, domestic-scheduled-payment-consents
Can raise:
FieldInvalid, ResourceNotFound
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Data
hash, required
Wrapper for the data.
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Allowed values:
Yes, No
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
Permission
string, required
Specifies the Open Banking service request types.
Allowed values:
Create
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, optional
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
RequestedExecutionDateTime
datetime, required
Date at which the initiating party requests the clearing agent to process the payment.
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.FPS
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorPostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
consent_payment_product
(path)
string, required
The addressed consent payment resource.
Allowed values:
domestic-payment-consents, domestic-scheduled-payment-consents
Can raise:
FieldInvalid, ResourceNotFound
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Data
hash, required
Wrapper for the data.
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Allowed values:
Yes, No
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
Permission
string, required
Specifies the Open Banking service request types.
Allowed values:
Create
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
Can raise:
InvalidFormat
FinalPaymentDateTime
datetime, optional
The date on which the final payment for a Standing Order schedule will be made.
FirstPaymentDateTime
datetime, required
The date on which the first payment for a Standing Order schedule will be made.
RecurringPaymentDateTime
datetime, optional
The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.
Frequency
string, required
This is a specific format of describing the rule for creating the payments of a standing order.
It should comply with one of the permitted patterns. Full pattern represented as a regular expression which can be used for validating the value provided in this field:
^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
Can raise:
UnsupportedFrequency
NumberOfPayments
string, optional
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
Can raise:
FieldInvalid
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
FinalPaymentAmount
hash, optional
The amount of the final Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
FirstPaymentAmount
hash, required
The amount of the first Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
RecurringPaymentAmount
hash, optional
The amount of the recurring Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
consent_payment_product
(path)
string, required
The addressed consent payment resource.
Allowed values:
domestic-payment-consents, domestic-scheduled-payment-consents
Can raise:
FieldInvalid, ResourceNotFound
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Data
hash, required
Wrapper for the data.
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Allowed values:
Yes, No
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
Can raise:
FieldMissing
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, required
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAgent
hash, optional
Financial institution servicing an account for the creditor.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
InstructionPriority
string, optional
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Allowed values:
Normal, Urgent
Can raise:
FieldInvalid
DestinationCountryCode
string, optional
Country in which Credit Account is domiciled. Nation with its own government. Should be in form of 2 character code.
Can raise:
FieldInvalid, CountryNameInvalid
Purpose
string, optional
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.
Can raise:
FieldInvalid
ExtendedPurpose
string, optional
Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
ChargeBearer
string, optional
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
CurrencyOfTransfer
string, required
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, optional
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.SWIFT
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
Creditor
hash, optional
Party to which an amount of money is due.
Name
string, optional
Creditor name
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
consent_payment_product
(path)
string, required
The addressed consent payment resource.
Allowed values:
domestic-payment-consents, domestic-scheduled-payment-consents
Can raise:
FieldInvalid, ResourceNotFound
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Data
hash, required
Wrapper for the data.
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Allowed values:
Yes, No
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
Permission
string, required
Specifies the Open Banking service request types.
Allowed values:
Create
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
Can raise:
FieldMissing
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, optional
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAgent
hash, optional
Financial institution servicing an account for the creditor.
SchemeName
string, optional
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
Identification
string, optional
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RequestedExecutionDateTime
datetime, required
Date at which the initiating party requests the clearing agent to process the payment.
InstructionPriority
string, optional
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Allowed values:
Normal, Urgent
Can raise:
FieldInvalid
DestinationCountryCode
string, optional
Country in which Credit Account is domiciled. Nation with its own government. Should be in form of 2 character code.
Can raise:
FieldInvalid, CountryNameInvalid
Purpose
string, optional
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.
Can raise:
FieldInvalid
ExtendedPurpose
string, optional
Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
ChargeBearer
string, optional
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
CurrencyOfTransfer
string, required
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, optional
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.SWIFT
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
Creditor
hash, optional
Party to which an amount of money is due.
Name
string, optional
Creditor name
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Response headers
| Header | Type | Description |
|---|---|---|
Content-Type
|
string, required | The media type of the body of the request. |
x-fapi-interaction-id
|
string, required | An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header. |
Retry-After
|
integer, optional | Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request. |
Response
Upon successful request, 201 status code will be returned. See ‘Related Errors’ table for other possibilities.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
CutOffDateTime
datetime, optional
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Can raise:
FieldInvalid
CreationDateTime
datetime, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, AwaitingAuthorisation, Authorised, Rejected, Consumed
Can raise:
FieldInvalid
StatusUpdateDateTime
datetime, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
datetime, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ExpectedSettlementDateTime
datetime, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, required
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.FPS
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorPostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
CutOffDateTime
datetime, optional
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Can raise:
FieldInvalid
CreationDateTime
datetime, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, AwaitingAuthorisation, Authorised, Rejected, Consumed
Can raise:
FieldInvalid
StatusUpdateDateTime
datetime, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
datetime, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ExpectedSettlementDateTime
datetime, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Permission
string, required
Specifies the Open Banking service request types.
Allowed values:
Create
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, optional
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
RequestedExecutionDateTime
datetime, required
Date at which the initiating party requests the clearing agent to process the payment.
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.FPS
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorPostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
CutOffDateTime
datetime, optional
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Can raise:
FieldInvalid
CreationDateTime
datetime, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, AwaitingAuthorisation, Authorised, Rejected, Consumed
Can raise:
FieldInvalid
StatusUpdateDateTime
datetime, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
Permission
string, required
Specifies the Open Banking service request types.
Allowed values:
Create
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
FinalPaymentDateTime
datetime, optional
The date on which the final payment for a Standing Order schedule will be made.
FirstPaymentDateTime
datetime, required
The date on which the first payment for a Standing Order schedule will be made.
RecurringPaymentDateTime
datetime, optional
The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.
Frequency
string, required
This is a specific format of describing the rule for creating the payments of a standing order.
It should comply with one of the permitted patterns. Full pattern represented as a regular expression which can be used for validating the value provided in this field:
^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
Can raise:
UnsupportedFrequency
NumberOfPayments
string, optional
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
Can raise:
FieldInvalid
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
FinalPaymentAmount
hash, optional
The amount of the final Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
FirstPaymentAmount
hash, required
The amount of the first Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
RecurringPaymentAmount
hash, optional
The amount of the recurring Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
CutOffDateTime
datetime, optional
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Can raise:
FieldInvalid
CreationDateTime
datetime, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, AwaitingAuthorisation, Authorised, Rejected, Consumed
Can raise:
FieldInvalid
StatusUpdateDateTime
datetime, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
datetime, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ExpectedSettlementDateTime
datetime, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, required
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ExpirationDateTime
datetime, optional
Specified date and time the exchange rate agreement will expire.
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, required
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAgent
hash, optional
Financial institution servicing an account for the creditor.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
InstructionPriority
string, optional
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Allowed values:
Normal, Urgent
Can raise:
FieldInvalid
DestinationCountryCode
string, optional
Country in which Credit Account is domiciled. Nation with its own government. Should be in form of 2 character code.
Can raise:
FieldInvalid, CountryNameInvalid
Purpose
string, optional
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.
Can raise:
FieldInvalid
ExtendedPurpose
string, optional
Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
ChargeBearer
string, optional
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
CurrencyOfTransfer
string, required
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, optional
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.SWIFT
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
Creditor
hash, optional
Party to which an amount of money is due.
Name
string, optional
Creditor name
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
CutOffDateTime
datetime, optional
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Can raise:
FieldInvalid
CreationDateTime
datetime, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, AwaitingAuthorisation, Authorised, Rejected, Consumed
Can raise:
FieldInvalid
StatusUpdateDateTime
datetime, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
datetime, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ExpectedSettlementDateTime
datetime, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, required
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ExpirationDateTime
datetime, optional
Specified date and time the exchange rate agreement will expire.
Permission
string, required
Specifies the Open Banking service request types.
Allowed values:
Create
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, optional
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAgent
hash, optional
Financial institution servicing an account for the creditor.
SchemeName
string, optional
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
Identification
string, optional
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RequestedExecutionDateTime
datetime, required
Date at which the initiating party requests the clearing agent to process the payment.
InstructionPriority
string, optional
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Allowed values:
Normal, Urgent
Can raise:
FieldInvalid
DestinationCountryCode
string, optional
Country in which Credit Account is domiciled. Nation with its own government. Should be in form of 2 character code.
Can raise:
FieldInvalid, CountryNameInvalid
Purpose
string, optional
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.
Can raise:
FieldInvalid
ExtendedPurpose
string, optional
Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
ChargeBearer
string, optional
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
CurrencyOfTransfer
string, required
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, optional
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.SWIFT
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
Creditor
hash, optional
Party to which an amount of money is due.
Name
string, optional
Creditor name
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Related Errors
| Class | Code | Description |
|---|---|---|
| FieldInvalid | 400 | An invalid value is supplied in the field. More details in error_message. |
| UnsupportedCurrency | 400 | The currency is not supported. |
| CountryNameInvalid | 400 | Country doesn't exist or is invalid. Expected alpha 2 ISO3166 format. |
| ResourceNotFound | 400 | Specified resource doesn't exist. |
| UnsupportedFrequency | 400 | Specified frequency is unsupported. |
| HeaderMissing | 400 | A required HTTP header has not been provided. |
| HeaderInvalid | 400 | An invalid value is supplied in the HTTP header. |
| Forbidden | 403 | Action is forbidden. More details in error_message. |
×
![]()
Show
The API allows the TPP to ask an ASPSP to show a payment-access-consent resource.
CURL
curl -i \ -H "Authorization: Bearer authorization" \ -H "Content-Type: application/json" \ -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ -H "Accept: application/json" \ -H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \ -H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \ -H "x-fapi-customer-ip-address: 104.25.212.99" \ -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.l0HBETgC4SHZIStaKVtyj-ZoPb8v8OkFk3-qfAl6HUqmK4uh3kVSJD9ZsbdNhTWc0spZSGVHo9TiFTEtjE3UijY89v_rk5nCeX7vgCALbIGeiBouzwJe1Tjhsppedf65EcMDgQBizLpUlgaEw01tFva-VqZSahYTwsOkckkYUFj6rv4pwdi0X7fTn75MZEWuSnOoEPP2keRJ_4-iwN8HdsdqkpE3IKgCLeMOK9f0aEYom7kJkUFVbHG1anVQVCj5JSuIsiMLQntLugNe22XrOj22muNgJwOPkzU-QYQeq37h8ROwKkoJ8MupZrrdO6rhf5zjOUcGcr1F4TIF8Lm1Ug' \ -X GET "/api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product/:consent_id"
curl -i \
-H "Authorization: Bearer authorization" \
-H "Content-Type: application/json" \
-H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \
-H "Accept: application/json" \
-H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.l0HBETgC4SHZIStaKVtyj-ZoPb8v8OkFk3-qfAl6HUqmK4uh3kVSJD9ZsbdNhTWc0spZSGVHo9TiFTEtjE3UijY89v_rk5nCeX7vgCALbIGeiBouzwJe1Tjhsppedf65EcMDgQBizLpUlgaEw01tFva-VqZSahYTwsOkckkYUFj6rv4pwdi0X7fTn75MZEWuSnOoEPP2keRJ_4-iwN8HdsdqkpE3IKgCLeMOK9f0aEYom7kJkUFVbHG1anVQVCj5JSuIsiMLQntLugNe22XrOj22muNgJwOPkzU-QYQeq37h8ROwKkoJ8MupZrrdO6rhf5zjOUcGcr1F4TIF8Lm1Ug' \
-X GET "/api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product/:consent_id"Example of response
{"Data":{"ConsentId":"18463","Status":"AwaitingAuthorisation","CreationDateTime":"2017-06-05T15:15:13+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ReadRefundAccount":"Yes","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"21342","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-payment-consents/58923","First":"/open-banking/v3.1/pisp/domestic-payment-consents/58923","Last":"/open-banking/v3.1/pisp/domestic-payment-consents/58925","Next":"/open-banking/v3.1/pisp/domestic-payment-consents/58924","Prev":"/open-banking/v3.1/pisp/domestic-payment-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"18463","Status":"AwaitingAuthorisation","CreationDateTime":"2017-06-05T15:15:13+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ReadRefundAccount":"Yes","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"21342","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-payment-consents/58923","First":"/open-banking/v3.1/pisp/domestic-payment-consents/58923","Last":"/open-banking/v3.1/pisp/domestic-payment-consents/58925","Next":"/open-banking/v3.1/pisp/domestic-payment-consents/58924","Prev":"/open-banking/v3.1/pisp/domestic-payment-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"18463","Status":"AwaitingAuthorisation","CreationDateTime":"2017-06-05T15:15:13+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ReadRefundAccount":"Yes","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Permission":"Create","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"21342","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58923","First":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58923","Last":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58925","Next":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58924","Prev":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"18463","Status":"AwaitingAuthorisation","CreationDateTime":"2017-06-05T15:15:13+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ReadRefundAccount":"Yes","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Permission":"Create","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"21342","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58923","First":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58923","Last":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58925","Next":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58924","Prev":"/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"18463","Status":"AwaitingAuthorisation","CreationDateTime":"2017-06-05T15:15:13+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ReadRefundAccount":"Yes","Permission":"Create","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"21342","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"Frequency":"EvryDay","FirstPaymentDateTime":"2017-06-05T15:15:13+00:00","FirstPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"FinalPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"RecurringPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58923","First":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58923","Last":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58925","Next":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58924","Prev":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"18463","Status":"AwaitingAuthorisation","CreationDateTime":"2017-06-05T15:15:13+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","ReadRefundAccount":"Yes","Permission":"Create","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"SCASupportData":{"AppliedAuthenticationApproach":"AppliedAuthenticationApproach","ReferencePaymentOrderId":"21342","RequestedSCAExemptionType":"RequestedSCAExemptionType"},"Initiation":{"Frequency":"EvryDay","FirstPaymentDateTime":"2017-06-05T15:15:13+00:00","FirstPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"FinalPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"RecurringPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58923","First":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58923","Last":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58925","Next":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58924","Prev":"/open-banking/v3.1/pisp/domestic-standing-order-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"58923","CreationDateTime":"2017-06-05T15:15:13+00:00","Status":"AwaitingAuthorisation","ReadRefundAccount":"Yes","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"TBD","CompletionDateTime":"TBD"},"SCASupportData":{"AppliedAuthenticationApproach":"TBD","ReferencePaymentOrderId":"TBD","RequestedSCAExemptionType":"TBD"},"Charges":[{"ChargeBearer":"TBD","Type":"TBD","Amount":{"Amount":123,"Currency":"GBP"}}],"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","ContractIdentification":"TBD","RateType":"TBD","ExpirationDateTime":"TBD"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Normal","Purpose":"TBD","ChargeBearer":"TBD","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/international-payment-consents/58923","First":"/open-banking/v3.1/pisp/international-payment-consents/58923","Last":"/open-banking/v3.1/pisp/international-payment-consents/58925","Next":"/open-banking/v3.1/pisp/international-payment-consents/58924","Prev":"/open-banking/v3.1/pisp/international-payment-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"58923","CreationDateTime":"2017-06-05T15:15:13+00:00","Status":"AwaitingAuthorisation","ReadRefundAccount":"Yes","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"TBD","CompletionDateTime":"TBD"},"SCASupportData":{"AppliedAuthenticationApproach":"TBD","ReferencePaymentOrderId":"TBD","RequestedSCAExemptionType":"TBD"},"Charges":[{"ChargeBearer":"TBD","Type":"TBD","Amount":{"Amount":123,"Currency":"GBP"}}],"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","ContractIdentification":"TBD","RateType":"TBD","ExpirationDateTime":"TBD"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Normal","Purpose":"TBD","ChargeBearer":"TBD","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/international-payment-consents/58923","First":"/open-banking/v3.1/pisp/international-payment-consents/58923","Last":"/open-banking/v3.1/pisp/international-payment-consents/58925","Next":"/open-banking/v3.1/pisp/international-payment-consents/58924","Prev":"/open-banking/v3.1/pisp/international-payment-consents/58922"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"58924","CreationDateTime":"2017-06-05T15:15:13+00:00","Status":"AwaitingAuthorisation","Permission":"Create","ReadRefundAccount":"Yes","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"TBD","CompletionDateTime":"TBD"},"Charges":[{"ChargeBearer":"TBD","Type":"TBD","Amount":{"Amount":123,"Currency":"GBP"}}],"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","ContractIdentification":"TBD","RateType":"TBD","ExpirationDateTime":"TBD"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"ABCD","ExtendedPurpose":"ExtendedPurpose","DestinationCountryCode":"RO","ChargeBearer":"TBD","CurrencyOfTransfer":"GBP","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}},"SCASupportData":{"AppliedAuthenticationApproach":"TBD","ReferencePaymentOrderId":"TBD","RequestedSCAExemptionType":"TBD"}},"Risk":{"PaymentContextCode":"PartyToParty","MerchantCategoryCode":"TBD","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/international-scheduled-payment-consents/58924"},"Meta":{"TotalPages":1}}
{"Data":{"ConsentId":"58924","CreationDateTime":"2017-06-05T15:15:13+00:00","Status":"AwaitingAuthorisation","Permission":"Create","ReadRefundAccount":"Yes","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","CutOffDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"TBD","CompletionDateTime":"TBD"},"Charges":[{"ChargeBearer":"TBD","Type":"TBD","Amount":{"Amount":123,"Currency":"GBP"}}],"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","ContractIdentification":"TBD","RateType":"TBD","ExpirationDateTime":"TBD"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"ABCD","ExtendedPurpose":"ExtendedPurpose","DestinationCountryCode":"RO","ChargeBearer":"TBD","CurrencyOfTransfer":"GBP","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}},"SCASupportData":{"AppliedAuthenticationApproach":"TBD","ReferencePaymentOrderId":"TBD","RequestedSCAExemptionType":"TBD"}},"Risk":{"PaymentContextCode":"PartyToParty","MerchantCategoryCode":"TBD","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB"}},"Links":{"Self":"/open-banking/v3.1/pisp/international-scheduled-payment-consents/58924"},"Meta":{"TotalPages":1}}
Request
GET
/api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product/:consent_id
Headers
| Header | Type | Description |
|---|---|---|
Content-Type
|
string, required | The media type of the body of the request. Default value: application/json Can raise: FieldInvalid |
x-fapi-interaction-id
|
string, optional | An RFC4122 UID used as a correlation Id. Can raise: FieldInvalid |
Accept
|
string, optional | Media type that is acceptable for the response. Can raise: FieldInvalid |
x-fapi-auth-date
|
string, optional | The time when the PSU last logged in with the TPP. Can raise: FieldInvalid |
x-fapi-customer-ip-address
|
string, optional | The PSU's IP address if the PSU is currently logged in with the TPP. Can raise: FieldInvalid |
Authorization
|
string, required | Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden |
Request parameters
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
consent_payment_product
(path)
string, required
The addressed consent payment resource.
Allowed values:
domestic-payment-consents, domestic-scheduled-payment-consents
Can raise:
FieldInvalid, ResourceNotFound
consent_id
(path)
string, required
The consent identifier assigned to the created resource.
Can raise:
FieldInvalid, ResourceNotFound
Response headers
| Header | Type | Description |
|---|---|---|
Content-Type
|
string, required | The media type of the body of the request. |
x-fapi-interaction-id
|
string, required | An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header. |
Retry-After
|
integer, optional | Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request. |
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, AwaitingAuthorisation, Authorised, Rejected, Consumed
Can raise:
FieldInvalid
CreationDateTime
datetime, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
StatusUpdateDateTime
datetime, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
CutOffDateTime
datetime, optional
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
datetime, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ExpectedSettlementDateTime
datetime, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, required
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.FPS
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorPostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Risk
hash, optional
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, AwaitingAuthorisation, Authorised, Rejected, Consumed
Can raise:
FieldInvalid
CreationDateTime
datetime, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
StatusUpdateDateTime
datetime, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
CutOffDateTime
datetime, optional
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
datetime, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ExpectedSettlementDateTime
datetime, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Permission
string, required
Specifies the Open Banking service request types.
Allowed values:
Create
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, optional
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
RequestedExecutionDateTime
datetime, required
Date at which the initiating party requests the clearing agent to process the payment.
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.FPS
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorPostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Risk
hash, optional
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, AwaitingAuthorisation, Authorised, Rejected, Consumed
Can raise:
FieldInvalid
CreationDateTime
datetime, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
StatusUpdateDateTime
datetime, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
CutOffDateTime
datetime, optional
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
Permission
string, required
Specifies the Open Banking service request types.
Allowed values:
Create
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
FinalPaymentDateTime
datetime, optional
The date on which the final payment for a Standing Order schedule will be made.
FirstPaymentDateTime
datetime, required
The date on which the first payment for a Standing Order schedule will be made.
RecurringPaymentDateTime
datetime, optional
The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.
Frequency
string, required
This is a specific format of describing the rule for creating the payments of a standing order.
It should comply with one of the permitted patterns. Full pattern represented as a regular expression which can be used for validating the value provided in this field:
^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
Can raise:
UnsupportedFrequency
NumberOfPayments
string, optional
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
Can raise:
FieldInvalid
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
FinalPaymentAmount
hash, optional
The amount of the final Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
FirstPaymentAmount
hash, required
The amount of the first Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
RecurringPaymentAmount
hash, optional
The amount of the recurring Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Risk
hash, optional
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, AwaitingAuthorisation, Authorised, Rejected, Consumed
Can raise:
FieldInvalid
CreationDateTime
datetime, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
StatusUpdateDateTime
datetime, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
CutOffDateTime
datetime, optional
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
datetime, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ExpectedSettlementDateTime
datetime, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, required
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ExpirationDateTime
datetime, optional
Specified date and time the exchange rate agreement will expire.
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, required
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAgent
hash, optional
Financial institution servicing an account for the creditor.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
InstructionPriority
string, optional
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Allowed values:
Normal, Urgent
Can raise:
FieldInvalid
DestinationCountryCode
string, optional
Country in which Credit Account is domiciled. Nation with its own government. Should be in form of 2 character code.
Can raise:
FieldInvalid, CountryNameInvalid
Purpose
string, optional
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.
Can raise:
FieldInvalid
ExtendedPurpose
string, optional
Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
ChargeBearer
string, optional
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
CurrencyOfTransfer
string, required
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, optional
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.SWIFT
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
Creditor
hash, optional
Party to which an amount of money is due.
Name
string, optional
Creditor name
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Risk
hash, optional
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, AwaitingAuthorisation, Authorised, Rejected, Consumed
Can raise:
FieldInvalid
CreationDateTime
datetime, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
StatusUpdateDateTime
datetime, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
CutOffDateTime
datetime, optional
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ReadRefundAccount
string, optional
Specifies to share the refund account details with PISP
Can raise:
FieldInvalid
Authorisation
hash, optional
The authorisation type request from the TPP.
Default value:
{}
AuthorisationType
string, optional
Type of authorisation flow requested.
Can raise:
FieldInvalid
CompletionDateTime
string, optional
Date and time at which the requested authorisation flow must be completed.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SCASupportData
hash, optional
Supporting Data provided by TPP, when requesting SCA Exemption.
AppliedAuthenticationApproach
string, optional
This field indicates whether the PSU was subject to SCA performed by the TPP.
Can raise:
FieldInvalid
ReferencePaymentOrderId
string, optional
If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
Allowed length:
max: 128 characters
Can raise:
FieldInvalid
RequestedSCAExemptionType
string, optional
This field allows a PISP to request specific SCA Exemption for a Payment Initiation.
Can raise:
FieldInvalid
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
datetime, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ExpectedSettlementDateTime
datetime, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Permission
string, required
Specifies the Open Banking service request types.
Allowed values:
Create
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, required
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ExpirationDateTime
datetime, optional
Specified date and time the exchange rate agreement will expire.
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, optional
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAgent
hash, optional
Financial institution servicing an account for the creditor.
SchemeName
string, optional
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
Identification
string, optional
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RequestedExecutionDateTime
datetime, required
Date at which the initiating party requests the clearing agent to process the payment.
InstructionPriority
string, optional
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Allowed values:
Normal, Urgent
Can raise:
FieldInvalid
DestinationCountryCode
string, optional
Country in which Credit Account is domiciled. Nation with its own government. Should be in form of 2 character code.
Can raise:
FieldInvalid, CountryNameInvalid
Purpose
string, optional
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.
Can raise:
FieldInvalid
ExtendedPurpose
string, optional
Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
ChargeBearer
string, optional
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
CurrencyOfTransfer
string, required
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, optional
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.SWIFT
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
Creditor
hash, optional
Party to which an amount of money is due.
Name
string, optional
Creditor name
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Risk
hash, optional
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Related Errors
| Class | Code | Description |
|---|---|---|
| FieldInvalid | 400 | An invalid value is supplied in the field. More details in error_message. |
| ResourceNotFound | 400 | Specified resource doesn't exist. |
| HeaderMissing | 400 | A required HTTP header has not been provided. |
| HeaderInvalid | 400 | An invalid value is supplied in the HTTP header. |
| Forbidden | 403 | Action is forbidden. More details in error_message. |
×
![]()
Funds Confirmation
The API allows the TPP to ask an ASPSP to check funds on a payment-access-consent resource.
CURL
curl -i \ -H "Authorization: Bearer authorization" \ -H "Content-Type: application/json" \ -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ -H "Accept: application/json" \ -H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \ -H "Idempotency-Key: da7c525d-9ec0-4b28-aae5-e97f6f39dfbd" \ -H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \ -H "x-fapi-customer-ip-address: 104.25.212.99" \ -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.nun1lq_YKsli6dUWZnm-Rl3HH_f4r1m9du8YZkoqs9cSxGB-wBLS8c3rNXP0Co9vIhOxbv8S-ZsaY8HgSX2Rr6aRlwfGlVVOocg08CMbNZ9DWyk1Iep6Ixgk2uss6EhlHfJDvLKaeWkPjC3ppOPcc8rcJJgW3Bnim9sof1EIl6-muyzHG2A7zFDplqu0KIqiXmHSw9MMca1EtHT3p7ehbqVF-XzDj1Jlx2bAaJLjJomLLGPhvEj43d_8iVFtoj_RE9ypuusBKA46HIkGPfzpn0QhN3Yeuh9VxLE1BqwmhthhzeCltzlE1UaLWqlTss1ezqQjO3eQh4AEaB_HLUcFhw' \ -X GET "/api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product/:consent_id/funds-confirmation"
curl -i \
-H "Authorization: Bearer authorization" \
-H "Content-Type: application/json" \
-H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \
-H "Accept: application/json" \
-H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \
-H "Idempotency-Key: da7c525d-9ec0-4b28-aae5-e97f6f39dfbd" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.nun1lq_YKsli6dUWZnm-Rl3HH_f4r1m9du8YZkoqs9cSxGB-wBLS8c3rNXP0Co9vIhOxbv8S-ZsaY8HgSX2Rr6aRlwfGlVVOocg08CMbNZ9DWyk1Iep6Ixgk2uss6EhlHfJDvLKaeWkPjC3ppOPcc8rcJJgW3Bnim9sof1EIl6-muyzHG2A7zFDplqu0KIqiXmHSw9MMca1EtHT3p7ehbqVF-XzDj1Jlx2bAaJLjJomLLGPhvEj43d_8iVFtoj_RE9ypuusBKA46HIkGPfzpn0QhN3Yeuh9VxLE1BqwmhthhzeCltzlE1UaLWqlTss1ezqQjO3eQh4AEaB_HLUcFhw' \
-X GET "/api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product/:consent_id/funds-confirmation"Example of response
{"Data":{"FundsAvailableResult":{"FundsAvailable":"true","FundsAvailableDateTime":"2017-06-05T15:15:13+00:00"},"SupplementaryData":{}}}
{"Data":{"FundsAvailableResult":{"FundsAvailable":"true","FundsAvailableDateTime":"2017-06-05T15:15:13+00:00"},"SupplementaryData":{}}}
Request
GET
/api/:provider_code/open-banking/v3.1/pisp/:consent_payment_product/:consent_id/funds-confirmation
Headers
| Header | Type | Description |
|---|---|---|
Content-Type
|
string, required | The media type of the body of the request. Default value: application/json Can raise: FieldInvalid |
x-fapi-interaction-id
|
string, optional | An RFC4122 UID used as a correlation Id. Can raise: FieldInvalid |
Accept
|
string, optional | Media type that is acceptable for the response. Can raise: FieldInvalid |
x-fapi-auth-date
|
string, optional | The time when the PSU last logged in with the TPP. Can raise: FieldInvalid |
x-fapi-customer-ip-address
|
string, optional | The PSU's IP address if the PSU is currently logged in with the TPP. Can raise: FieldInvalid |
Authorization
|
string, required | Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden |
Request parameters
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
consent_payment_product
(path)
string, required
The addressed consent payment resource.
Allowed values:
domestic-payment-consents
Can raise:
FieldInvalid, ResourceNotFound
consent_id
(path)
string, required
The consent identifier assigned to the created resource.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus
Response headers
| Header | Type | Description |
|---|---|---|
Content-Type
|
string, required | The media type of the body of the request. |
x-fapi-interaction-id
|
string, required | An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header. |
Retry-After
|
integer, optional | Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request. |
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
Data
hash, required
Wrapper for the data.
FundsAvailableResult
hash, optional
Result of a funds availability check.
FundsAvailableDateTime
datetime, required
Date and time at which the funds availability check was generated.
FundsAvailable
boolean, required
Flag to indicate the availability of funds given the Amount in the consent request.
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Default value:
{}
Related Errors
| Class | Code | Description |
|---|---|---|
| FieldInvalid | 400 | An invalid value is supplied in the field. More details in error_message. |
| ResourceNotFound | 400 | Specified resource doesn't exist. |
| ResourceInvalidConsentStatus | 400 | The action can't be performed with current status of consent. |
| HeaderMissing | 400 | A required HTTP header has not been provided. |
| HeaderInvalid | 400 | An invalid value is supplied in the HTTP header. |
| Unauthorized | 401 | Unauthorized access. |
| Forbidden | 403 | Action is forbidden. More details in error_message. |
×
![]()
Payments
Create
The API allows the TPP to ask an ASPSP to create a new payment.
CURL
curl -i \ -H "Authorization: Bearer authorization" \ -H "Content-Type: application/json" \ -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ -H "Accept: application/json" \ -H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \ -H "Idempotency-Key: da7c525d-9ec0-4b28-aae5-e97f6f39dfbd" \ -H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \ -H "x-fapi-customer-ip-address: 104.25.212.99" \ -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkNvbnNlbnRJZCI6InN0cmluZyIsIkluaXRpYXRpb24iOnsiSW5zdHJ1Y3Rpb25JZGVudGlmaWNhdGlvbiI6IkFOU00wMjMiLCJFbmRUb0VuZElkZW50aWZpY2F0aW9uIjoiRlJFU0NPLjIxMzAyLkdGWC4zNyIsIkxvY2FsSW5zdHJ1bWVudCI6IlVLLk9CSUUuRlBTIiwiSW5zdHJ1Y3RlZEFtb3VudCI6eyJBbW91bnQiOiIyMC4wMCIsIkN1cnJlbmN5IjoiR0JQIn0sIkRlYnRvckFjY291bnQiOnsiU2NoZW1lTmFtZSI6IlVLLk9CSUUuU29ydENvZGVBY2NvdW50TnVtYmVyIiwiSWRlbnRpZmljYXRpb24iOiIxMTI4MDAwMTIzNDU2NyIsIk5hbWUiOiJBbmRyZWEgU21pdGgiLCJTZWNvbmRhcnlJZGVudGlmaWNhdGlvbiI6IjAwMDIifSwiQ3JlZGl0b3JBY2NvdW50Ijp7IlNjaGVtZU5hbWUiOiJVSy5PQklFLlNvcnRDb2RlQWNjb3VudE51bWJlciIsIklkZW50aWZpY2F0aW9uIjoiMDgwODAwMjEzMjU2OTgiLCJOYW1lIjoiQm9iIENsZW1lbnRzIiwiU2Vjb25kYXJ5SWRlbnRpZmljYXRpb24iOiIwMDAzIn0sIkNyZWRpdG9yUG9zdGFsQWRkcmVzcyI6eyJBZGRyZXNzTGluZSI6WyIxMCBEb3duaW5nIFN0LCBXZXN0bWluc3RlciwgTG9uZG9uIFNXMUEgMkFBLCBVbml0ZWQgS2luZ2RvbSJdLCJBZGRyZXNzVHlwZSI6IkFkZHJlc3Mgd2l0aCBob3VzZSBudW1iZXIgYW5kIHN0cmVldCIsIkRlcGFydG1lbnQiOiJQcmltZSBNaW5pc3RlcidzIE9mZmljZSIsIlN1YkRlcGFydG1lbnQiOiJDYWJpbmV0IE9mZmljZSIsIlN0cmVldE5hbWUiOiJTaXIgR2VvcmdlIERvd25pbmciLCJCdWlsZGluZ051bWJlciI6IjEwIiwiUG9zdENvZGUiOiJTVzFBIDJBQSIsIlRvd25OYW1lIjoiQ2l0eSBvZiBXZXN0bWluc3RlciBMb25kb24sIiwiQ291bnRyeVN1YkRpdmlzaW9uIjoiTG9uZG9uIiwiQ291bnRyeSI6IkdCIn0sIlJlbWl0dGFuY2VJbmZvcm1hdGlvbiI6eyJSZWZlcmVuY2UiOiJGUkVTQ08tMDM3IiwiVW5zdHJ1Y3R1cmVkIjoiSW50ZXJuYWwgb3BzIGNvZGUgNTEyMDEwMyJ9LCJTdXBwbGVtZW50YXJ5RGF0YSI6e319fSwiUmlzayI6eyJQYXltZW50Q29udGV4dENvZGUiOiJzdHJpbmciLCJNZXJjaGFudENhdGVnb3J5Q29kZSI6InN0cmluZyIsIk1lcmNoYW50Q3VzdG9tZXJJZGVudGlmaWNhdGlvbiI6InN0cmluZyIsIkRlbGl2ZXJ5QWRkcmVzcyI6eyJBZGRyZXNzTGluZSI6InN0cmluZyIsIlN0cmVldE5hbWUiOiJzdHJpbmciLCJCdWlsZGluZ051bWJlciI6InN0cmluZyIsIlBvc3RDb2RlIjoic3RyaW5nIiwiVG93bk5hbWUiOiJzdHJpbmciLCJDb3VudHJ5U3ViRGl2aXNpb24iOiJzdHJpbmciLCJDb3VudHJ5IjoiR0IifX19.YpMCaFrY6vMSAqm0V9PaRyg1OP7jchj6W_5CmdhcxYgUsEyz1wV0Iu9v9BVJN8TDZk9hdGWsfH0qnr-43jyv-z4JCqfFAJkRRR2lzQLqtkeB_KMSnOT6A0Tim1y24r1ELKJD4NGiMcnKgPtcGjVBT9fayP6oEBLVX1luH7PDenOgElJoKXk30yn70lgRuG-sSBEpB-ZTKzuMwKpjGKHsGrZYclcdNiCnryNSN303h6fJKR2V86G5hFl7VYIXBdLiaeCPZLiV7pXgziRYNKDoy1dwg0EDr0Z5v7UwJh7akJdlPJCiY5JSFV3Bnibxk9VwL5SZrvgLKAWn58C86JbwGw' \ -X POST "/api/:provider_code/open-banking/v3.1/pisp/:payment_product"
curl -i \
-H "Authorization: Bearer authorization" \
-H "Content-Type: application/json" \
-H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \
-H "Accept: application/json" \
-H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \
-H "Idempotency-Key: da7c525d-9ec0-4b28-aae5-e97f6f39dfbd" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJEYXRhIjp7IkNvbnNlbnRJZCI6InN0cmluZyIsIkluaXRpYXRpb24iOnsiSW5zdHJ1Y3Rpb25JZGVudGlmaWNhdGlvbiI6IkFOU00wMjMiLCJFbmRUb0VuZElkZW50aWZpY2F0aW9uIjoiRlJFU0NPLjIxMzAyLkdGWC4zNyIsIkxvY2FsSW5zdHJ1bWVudCI6IlVLLk9CSUUuRlBTIiwiSW5zdHJ1Y3RlZEFtb3VudCI6eyJBbW91bnQiOiIyMC4wMCIsIkN1cnJlbmN5IjoiR0JQIn0sIkRlYnRvckFjY291bnQiOnsiU2NoZW1lTmFtZSI6IlVLLk9CSUUuU29ydENvZGVBY2NvdW50TnVtYmVyIiwiSWRlbnRpZmljYXRpb24iOiIxMTI4MDAwMTIzNDU2NyIsIk5hbWUiOiJBbmRyZWEgU21pdGgiLCJTZWNvbmRhcnlJZGVudGlmaWNhdGlvbiI6IjAwMDIifSwiQ3JlZGl0b3JBY2NvdW50Ijp7IlNjaGVtZU5hbWUiOiJVSy5PQklFLlNvcnRDb2RlQWNjb3VudE51bWJlciIsIklkZW50aWZpY2F0aW9uIjoiMDgwODAwMjEzMjU2OTgiLCJOYW1lIjoiQm9iIENsZW1lbnRzIiwiU2Vjb25kYXJ5SWRlbnRpZmljYXRpb24iOiIwMDAzIn0sIkNyZWRpdG9yUG9zdGFsQWRkcmVzcyI6eyJBZGRyZXNzTGluZSI6WyIxMCBEb3duaW5nIFN0LCBXZXN0bWluc3RlciwgTG9uZG9uIFNXMUEgMkFBLCBVbml0ZWQgS2luZ2RvbSJdLCJBZGRyZXNzVHlwZSI6IkFkZHJlc3Mgd2l0aCBob3VzZSBudW1iZXIgYW5kIHN0cmVldCIsIkRlcGFydG1lbnQiOiJQcmltZSBNaW5pc3RlcidzIE9mZmljZSIsIlN1YkRlcGFydG1lbnQiOiJDYWJpbmV0IE9mZmljZSIsIlN0cmVldE5hbWUiOiJTaXIgR2VvcmdlIERvd25pbmciLCJCdWlsZGluZ051bWJlciI6IjEwIiwiUG9zdENvZGUiOiJTVzFBIDJBQSIsIlRvd25OYW1lIjoiQ2l0eSBvZiBXZXN0bWluc3RlciBMb25kb24sIiwiQ291bnRyeVN1YkRpdmlzaW9uIjoiTG9uZG9uIiwiQ291bnRyeSI6IkdCIn0sIlJlbWl0dGFuY2VJbmZvcm1hdGlvbiI6eyJSZWZlcmVuY2UiOiJGUkVTQ08tMDM3IiwiVW5zdHJ1Y3R1cmVkIjoiSW50ZXJuYWwgb3BzIGNvZGUgNTEyMDEwMyJ9LCJTdXBwbGVtZW50YXJ5RGF0YSI6e319fSwiUmlzayI6eyJQYXltZW50Q29udGV4dENvZGUiOiJzdHJpbmciLCJNZXJjaGFudENhdGVnb3J5Q29kZSI6InN0cmluZyIsIk1lcmNoYW50Q3VzdG9tZXJJZGVudGlmaWNhdGlvbiI6InN0cmluZyIsIkRlbGl2ZXJ5QWRkcmVzcyI6eyJBZGRyZXNzTGluZSI6InN0cmluZyIsIlN0cmVldE5hbWUiOiJzdHJpbmciLCJCdWlsZGluZ051bWJlciI6InN0cmluZyIsIlBvc3RDb2RlIjoic3RyaW5nIiwiVG93bk5hbWUiOiJzdHJpbmciLCJDb3VudHJ5U3ViRGl2aXNpb24iOiJzdHJpbmciLCJDb3VudHJ5IjoiR0IifX19.YpMCaFrY6vMSAqm0V9PaRyg1OP7jchj6W_5CmdhcxYgUsEyz1wV0Iu9v9BVJN8TDZk9hdGWsfH0qnr-43jyv-z4JCqfFAJkRRR2lzQLqtkeB_KMSnOT6A0Tim1y24r1ELKJD4NGiMcnKgPtcGjVBT9fayP6oEBLVX1luH7PDenOgElJoKXk30yn70lgRuG-sSBEpB-ZTKzuMwKpjGKHsGrZYclcdNiCnryNSN303h6fJKR2V86G5hFl7VYIXBdLiaeCPZLiV7pXgziRYNKDoy1dwg0EDr0Z5v7UwJh7akJdlPJCiY5JSFV3Bnibxk9VwL5SZrvgLKAWn58C86JbwGw' \
-X POST "/api/:provider_code/open-banking/v3.1/pisp/:payment_product"Example of request
{"Data":{"ConsentId":"string","Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"string","MerchantCategoryCode":"string","MerchantCustomerIdentification":"string","DeliveryAddress":{"AddressLine":"string","StreetName":"string","BuildingNumber":"string","PostCode":"string","TownName":"string","CountrySubDivision":"string","Country":"GB"}}}
{"Data":{"ConsentId":"string","Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"string","MerchantCategoryCode":"string","MerchantCustomerIdentification":"string","DeliveryAddress":{"AddressLine":"string","StreetName":"string","BuildingNumber":"string","PostCode":"string","TownName":"string","CountrySubDivision":"string","Country":"GB"}}}
{"Data":{"ConsentId":"string","Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"string","MerchantCategoryCode":"string","MerchantCustomerIdentification":"string","DeliveryAddress":{"AddressLine":"string","StreetName":"string","BuildingNumber":"string","PostCode":"string","TownName":"string","CountrySubDivision":"string","Country":"GB"}}}
{"Data":{"ConsentId":"string","Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"string","MerchantCategoryCode":"string","MerchantCustomerIdentification":"string","DeliveryAddress":{"AddressLine":"string","StreetName":"string","BuildingNumber":"string","PostCode":"string","TownName":"string","CountrySubDivision":"string","Country":"GB"}}}
{"Data":{"ConsentId":"string","Initiation":{"Frequency":"EvryDay:02:03","FirstPaymentDateTime":"2017-06-05T15:15:13+00:00","FirstPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"FinalPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"RecurringPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}}}
{"Data":{"ConsentId":"string","Initiation":{"Frequency":"EvryDay:02:03","FirstPaymentDateTime":"2017-06-05T15:15:13+00:00","FirstPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"FinalPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"RecurringPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"EcommerceGoods","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"Acacia Avenue","BuildingNumber":"27","PostCode":"GU31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}}}
{"Data":{"ConsentId":"58923","Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Normal","Purpose":"string","ChargeBearer":"string","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"string","ContractIdentification":"string"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"string","MerchantCategoryCode":"string","MerchantCustomerIdentification":"string","DeliveryAddress":{"AddressLine":"string","StreetName":"string","BuildingNumber":"string","PostCode":"string","TownName":"string","CountrySubDivision":"string","Country":"GB"}}}
{"Data":{"ConsentId":"58923","Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Normal","Purpose":"string","ChargeBearer":"string","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"string","ContractIdentification":"string"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"string","MerchantCategoryCode":"string","MerchantCustomerIdentification":"string","DeliveryAddress":{"AddressLine":"string","StreetName":"string","BuildingNumber":"string","PostCode":"string","TownName":"string","CountrySubDivision":"string","Country":"GB"}}}
{"Data":{"ConsentId":"58924","Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"ABCD","ExtendedPurpose":"ExtendedPurpose","DestinationCountryCode":"RO","ChargeBearer":"TBD","CurrencyOfTransfer":"GBP","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"PartyToParty","MerchantCategoryCode":"TBD","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB"}}}
{"Data":{"ConsentId":"58924","Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"ABCD","ExtendedPurpose":"ExtendedPurpose","DestinationCountryCode":"RO","ChargeBearer":"TBD","CurrencyOfTransfer":"GBP","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"TBD","ContractIdentification":"TBD"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Risk":{"PaymentContextCode":"PartyToParty","MerchantCategoryCode":"TBD","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB"}}}
Example of response
{"Data":{"DomesticPaymentId":"string","ConsentId":"string","Status":"string","ReadRefundAccount":"string","CreationDateTime":"string","StatusUpdateDateTime":"string","CutOffDateTime":"string","ExpectedExecutionDateTime":"string","ExpectedSettlementDateTime":"string","Authorisation":{"AuthorisationType":"string","CompletionDateTime":"string"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"DomesticPaymentId":"string","ConsentId":"string","Status":"string","ReadRefundAccount":"string","CreationDateTime":"string","StatusUpdateDateTime":"string","CutOffDateTime":"string","ExpectedExecutionDateTime":"string","ExpectedSettlementDateTime":"string","Authorisation":{"AuthorisationType":"string","CompletionDateTime":"string"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"DomesticScheduledPaymentId":"string","ConsentId":"string","Status":"string","CreationDateTime":"string","StatusUpdateDateTime":"string","Initiation":{"InstructionIdentification":"89f0a53a91ee47f6a383536f851d6b5a","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","InstructedAmount":{"Amount":"200.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Frost"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Tom Kirkman"},"RemittanceInformation":{"Reference":"DSR-037","Unstructured":"Internal ops code 5120103"}},"MultiAuthorisation":{"ExpirationDateTime":"2017-06-05T15:15:15+00:00","LastUpdateDateTime":"2017-06-05T15:15:15+00:00","NumberReceived":1,"NumberRequired":2,"Status":"AwaitingFurtherAuthorisation"}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"DomesticScheduledPaymentId":"string","ConsentId":"string","Status":"string","CreationDateTime":"string","StatusUpdateDateTime":"string","Initiation":{"InstructionIdentification":"89f0a53a91ee47f6a383536f851d6b5a","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","InstructedAmount":{"Amount":"200.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Frost"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Tom Kirkman"},"RemittanceInformation":{"Reference":"DSR-037","Unstructured":"Internal ops code 5120103"}},"MultiAuthorisation":{"ExpirationDateTime":"2017-06-05T15:15:15+00:00","LastUpdateDateTime":"2017-06-05T15:15:15+00:00","NumberReceived":1,"NumberRequired":2,"Status":"AwaitingFurtherAuthorisation"}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"DomesticStandingOrderId":"58923","ConsentId":"18463","Status":"InitiationPending","CreationDateTime":"string","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"Initiation":{"Frequency":"EvryDay:02:03","FirstPaymentDateTime":"2017-06-05T15:15:13+00:00","FirstPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"FinalPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"RecurringPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-standing-order/58923","First":"/open-banking/v3.1/pisp/domestic-standing-order/58923","Last":"/open-banking/v3.1/pisp/domestic-standing-order/58925","Next":"/open-banking/v3.1/pisp/domestic-standing-order/58924","Prev":"/open-banking/v3.1/pisp/domestic-standing-order/58922"},"Meta":{"TotalPages":1}}
{"Data":{"DomesticStandingOrderId":"58923","ConsentId":"18463","Status":"InitiationPending","CreationDateTime":"string","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"Initiation":{"Frequency":"EvryDay:02:03","FirstPaymentDateTime":"2017-06-05T15:15:13+00:00","FirstPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"FinalPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"RecurringPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-standing-order/58923","First":"/open-banking/v3.1/pisp/domestic-standing-order/58923","Last":"/open-banking/v3.1/pisp/domestic-standing-order/58925","Next":"/open-banking/v3.1/pisp/domestic-standing-order/58924","Prev":"/open-banking/v3.1/pisp/domestic-standing-order/58922"},"Meta":{"TotalPages":1}}
{"Data":{"InternationalPaymentId":"58923-001","ConsentId":"58923","Status":"AcceptedSettlementInProcess","ReadRefundAccount":"Yes","CreationDateTime":"2017-06-05T15:15:22+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","CompletionDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"string","CompletionDateTime":"string"},"Charges":[{"ChargeBearer":"string","Type":"string","Amount":{"Amount":123,"Currency":"GBP"}}],"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"string","ChargeBearer":"string","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"string","ContractIdentification":"string"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"},"SupplementaryData":{},"MultiAuthorisation":{"ExpirationDateTime":"2017-06-05T15:15:15+00:00","LastUpdateDateTime":"2017-06-05T15:15:15+00:00","NumberReceived":1,"NumberRequired":2,"Status":"AwaitingFurtherAuthorisation"}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"InternationalPaymentId":"58923-001","ConsentId":"58923","Status":"AcceptedSettlementInProcess","ReadRefundAccount":"Yes","CreationDateTime":"2017-06-05T15:15:22+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","CompletionDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"string","CompletionDateTime":"string"},"Charges":[{"ChargeBearer":"string","Type":"string","Amount":{"Amount":123,"Currency":"GBP"}}],"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"string","ChargeBearer":"string","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"string","ContractIdentification":"string"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"},"SupplementaryData":{},"MultiAuthorisation":{"ExpirationDateTime":"2017-06-05T15:15:15+00:00","LastUpdateDateTime":"2017-06-05T15:15:15+00:00","NumberReceived":1,"NumberRequired":2,"Status":"AwaitingFurtherAuthorisation"}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"InternationalScheduledPaymentId":"58924-001","ConsentId":"58924","Status":"AcceptedSettlementInProcess","ReadRefundAccount":"Yes","CreationDateTime":"2023-06-05T15:15:22+00:00","StatusUpdateDateTime":"2023-06-05T15:15:13+00:00","CompletionDateTime":"2023-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2023-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2023-06-05T15:15:13+00:00","Charges":[{"ChargeBearer":"string","Type":"string","Amount":{"Amount":123,"Currency":"GBP"}}],"Debtor":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"string","ChargeBearer":"string","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"string","ContractIdentification":"string"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"},"SupplementaryData":{},"MultiAuthorisation":{"ExpirationDateTime":"2017-06-05T15:15:15+00:00","LastUpdateDateTime":"2017-06-05T15:15:15+00:00","NumberReceived":1,"NumberRequired":2,"Status":"AwaitingFurtherAuthorisation"}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"InternationalScheduledPaymentId":"58924-001","ConsentId":"58924","Status":"AcceptedSettlementInProcess","ReadRefundAccount":"Yes","CreationDateTime":"2023-06-05T15:15:22+00:00","StatusUpdateDateTime":"2023-06-05T15:15:13+00:00","CompletionDateTime":"2023-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2023-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2023-06-05T15:15:13+00:00","Charges":[{"ChargeBearer":"string","Type":"string","Amount":{"Amount":123,"Currency":"GBP"}}],"Debtor":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"string","ChargeBearer":"string","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"string","ContractIdentification":"string"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"},"SupplementaryData":{},"MultiAuthorisation":{"ExpirationDateTime":"2017-06-05T15:15:15+00:00","LastUpdateDateTime":"2017-06-05T15:15:15+00:00","NumberReceived":1,"NumberRequired":2,"Status":"AwaitingFurtherAuthorisation"}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
Request
POST
/api/:provider_code/open-banking/v3.1/pisp/:payment_product
Headers
| Header | Type | Description |
|---|---|---|
Content-Type
|
string, required | The media type of the body of the request. Default value: application/json Can raise: FieldInvalid |
x-fapi-interaction-id
|
string, optional | An RFC4122 UID used as a correlation Id. |
Accept
|
string, optional | Media type that is acceptable for the response. |
x-fapi-auth-date
|
string, optional | The time when the PSU last logged in with the TPP. |
x-fapi-customer-ip-address
|
string, optional | The PSU's IP address if the PSU is currently logged in with the TPP. |
Authorization
|
string, required | Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden |
x-jws-signature
|
string, optional | A detached JWS signature of the body of the payload. |
Idempotency-Key
|
string, optional | Unique uuid used to recognize subsequent retries of the same request valid for 24 hours. Allowed length: max: 40 characters |
Request parameters
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
payment_product
(path)
string, required
The addressed payment resource.
Allowed values:
domestic-payments, domestic-scheduled-payments
Can raise:
FieldInvalid, ResourceNotFound
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
Can raise:
ResourceConsentMismatch
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
Can raise:
ResourceConsentMismatch
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, required
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.FPS
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorPostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
payment_product
(path)
string, required
The addressed payment resource.
Allowed values:
domestic-payments, domestic-scheduled-payments
Can raise:
FieldInvalid, ResourceNotFound
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
Can raise:
ResourceConsentMismatch
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
Can raise:
ResourceConsentMismatch
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, optional
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
RequestedExecutionDateTime
datetime, required
Date at which the initiating party requests the clearing agent to process the payment.
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.FPS
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorPostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
payment_product
(path)
string, required
The addressed payment resource.
Allowed values:
domestic-payments, domestic-scheduled-payments
Can raise:
FieldInvalid, ResourceNotFound
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
Can raise:
ResourceConsentMismatch
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
Can raise:
ResourceConsentMismatch
FinalPaymentDateTime
datetime, optional
The date on which the final payment for a Standing Order schedule will be made.
FirstPaymentDateTime
datetime, required
The date on which the first payment for a Standing Order schedule will be made.
RecurringPaymentDateTime
datetime, optional
The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.
Frequency
string, required
This is a specific format of describing the rule for creating the payments of a standing order.
It should comply with one of the permitted patterns. Full pattern represented as a regular expression which can be used for validating the value provided in this field:
^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
Can raise:
UnsupportedFrequency
NumberOfPayments
string, optional
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
Can raise:
FieldInvalid
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
FinalPaymentAmount
hash, optional
The amount of the final Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
FirstPaymentAmount
hash, required
The amount of the first Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
RecurringPaymentAmount
hash, optional
The amount of the recurring Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
payment_product
(path)
string, required
The addressed payment resource.
Allowed values:
domestic-payments, domestic-scheduled-payments
Can raise:
FieldInvalid, ResourceNotFound
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
Can raise:
ResourceConsentMismatch
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
Can raise:
ResourceConsentMismatch
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, required
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAgent
hash, optional
Financial institution servicing an account for the creditor.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
InstructionPriority
string, optional
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Allowed values:
Normal, Urgent
Can raise:
FieldInvalid
DestinationCountryCode
string, optional
Country in which Credit Account is domiciled. Nation with its own government. Should be in form of 2 character code.
Can raise:
FieldInvalid, CountryNameInvalid
Purpose
string, optional
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.
Can raise:
FieldInvalid
ExtendedPurpose
string, optional
Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
ChargeBearer
string, optional
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
CurrencyOfTransfer
string, required
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, optional
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.SWIFT
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
Creditor
hash, optional
Party to which an amount of money is due.
Name
string, optional
Creditor name
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
payment_product
(path)
string, required
The addressed payment resource.
Allowed values:
domestic-payments, domestic-scheduled-payments
Can raise:
FieldInvalid, ResourceNotFound
Risk
hash, required
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
Default value:
{}
Can raise:
ResourceConsentMismatch
MerchantCategoryCode
string, optional
Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
Allowed length:
min: 3, max: 4 characters
Can raise:
FieldInvalid
MerchantCustomerIdentification
string, optional
The unique customer identifier of the PSU with the merchant.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
PaymentContextCode
string, optional
Specifies the payment context
Can raise:
FieldInvalid
DeliveryAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine
array, optional
Identifies the lines of the postal address.
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government, occupying a particular territory (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid, ResourceNotFound, Unauthorized, ResourceInvalidConsentStatus
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
Can raise:
ResourceConsentMismatch
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, optional
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAgent
hash, optional
Financial institution servicing an account for the creditor.
SchemeName
string, optional
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
Identification
string, optional
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RequestedExecutionDateTime
datetime, required
Date at which the initiating party requests the clearing agent to process the payment.
InstructionPriority
string, optional
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Allowed values:
Normal, Urgent
Can raise:
FieldInvalid
DestinationCountryCode
string, optional
Country in which Credit Account is domiciled. Nation with its own government. Should be in form of 2 character code.
Can raise:
FieldInvalid, CountryNameInvalid
Purpose
string, optional
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.
Can raise:
FieldInvalid
ExtendedPurpose
string, optional
Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
ChargeBearer
string, optional
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
CurrencyOfTransfer
string, required
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, optional
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.SWIFT
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
Creditor
hash, optional
Party to which an amount of money is due.
Name
string, optional
Creditor name
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Response headers
| Header | Type | Description |
|---|---|---|
Content-Type
|
string, required | The media type of the body of the request. |
x-fapi-interaction-id
|
string, optional | An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header. |
Retry-After
|
integer, optional | Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request. |
x-jws-signature
|
string, optional | A detached JWS signature of the body of the payload. |
Response
Upon successful request, 201 status code will be returned. See ‘Related Errors’ table for other possibilities.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, Rejected, AcceptedSettlementInProcess, AcceptedSettlementCompleted, AcceptedWithoutPosting, AcceptedCreditSettlementCompleted
Can raise:
FieldInvalid
CreationDateTime
string, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
StatusUpdateDateTime
string, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
Refund
hash, optional
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
Account
hash, required
Provides the details to identify an account.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
MultiAuthorisation
hash, optional
The multiple authorisation flow response from the ASPSP.
Status
string, required
Specifies the status of the authorisation flow in code form.
Allowed values:
AwaitingFurtherAuthorisation, Authorised, Rejected
Can raise:
FieldInvalid
NumberReceived
integer, optional
Number of authorisations received.
NumberRequired
integer, optional
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
LastUpdateDateTime
datetime, optional
Last date and time at which the authorisation flow was updated.
ExpirationDateTime
datetime, optional
Date and time at which the requested authorisation flow must be completed.
DomesticPaymentId
string, required
Unique identification as assigned by the ASPSP to identify the domestic payment resource.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
string, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
ExpectedSettlementDateTime
string, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, required
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.FPS
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorPostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
InitiationPending, InitiationFailed, InitiationCompleted, Cancelled
Can raise:
FieldInvalid
CreationDateTime
string, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
StatusUpdateDateTime
string, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
Refund
hash, optional
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
Account
hash, required
Provides the details to identify an account.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
MultiAuthorisation
hash, optional
The multiple authorisation flow response from the ASPSP.
Status
string, required
Specifies the status of the authorisation flow in code form.
Allowed values:
AwaitingFurtherAuthorisation, Authorised, Rejected
Can raise:
FieldInvalid
NumberReceived
integer, optional
Number of authorisations received.
NumberRequired
integer, optional
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
LastUpdateDateTime
datetime, optional
Last date and time at which the authorisation flow was updated.
ExpirationDateTime
datetime, optional
Date and time at which the requested authorisation flow must be completed.
DomesticScheduledPaymentId
string, required
Unique identification as assigned by the ASPSP to identify the domestic scheduled payment resource.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
string, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
ExpectedSettlementDateTime
string, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, optional
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
RequestedExecutionDateTime
datetime, required
Date at which the initiating party requests the clearing agent to process the payment.
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.FPS
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorPostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
InitiationPending, InitiationFailed, InitiationCompleted, Cancelled
Can raise:
FieldInvalid
CreationDateTime
string, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
StatusUpdateDateTime
string, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
Refund
hash, optional
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
Account
hash, required
Provides the details to identify an account.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
MultiAuthorisation
hash, optional
The multiple authorisation flow response from the ASPSP.
Status
string, required
Specifies the status of the authorisation flow in code form.
Allowed values:
AwaitingFurtherAuthorisation, Authorised, Rejected
Can raise:
FieldInvalid
NumberReceived
integer, optional
Number of authorisations received.
NumberRequired
integer, optional
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
LastUpdateDateTime
datetime, optional
Last date and time at which the authorisation flow was updated.
ExpirationDateTime
datetime, optional
Date and time at which the requested authorisation flow must be completed.
DomesticStandingOrderId
string, required
Unique identification as assigned by the ASPSP to identify the domestic standing order payment resource.
Can raise:
FieldInvalid
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
Can raise:
InvalidFormat
FinalPaymentDateTime
datetime, optional
The date on which the final payment for a Standing Order schedule will be made.
FirstPaymentDateTime
datetime, required
The date on which the first payment for a Standing Order schedule will be made.
RecurringPaymentDateTime
datetime, optional
The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.
Frequency
string, required
This is a specific format of describing the rule for creating the payments of a standing order.
It should comply with one of the permitted patterns. Full pattern represented as a regular expression which can be used for validating the value provided in this field:
^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
Can raise:
UnsupportedFrequency
NumberOfPayments
string, optional
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
Can raise:
FieldInvalid
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
FinalPaymentAmount
hash, optional
The amount of the final Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
FirstPaymentAmount
hash, required
The amount of the first Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
RecurringPaymentAmount
hash, optional
The amount of the recurring Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, Rejected, AcceptedSettlementInProcess, AcceptedSettlementCompleted, AcceptedWithoutPosting, AcceptedCreditSettlementCompleted
Can raise:
FieldInvalid
CreationDateTime
string, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
StatusUpdateDateTime
string, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
Refund
hash, optional
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
Account
hash, required
Provides the details to identify an account.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
MultiAuthorisation
hash, optional
The multiple authorisation flow response from the ASPSP.
Status
string, required
Specifies the status of the authorisation flow in code form.
Allowed values:
AwaitingFurtherAuthorisation, Authorised, Rejected
Can raise:
FieldInvalid
NumberReceived
integer, optional
Number of authorisations received.
NumberRequired
integer, optional
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
LastUpdateDateTime
datetime, optional
Last date and time at which the authorisation flow was updated.
ExpirationDateTime
datetime, optional
Date and time at which the requested authorisation flow must be completed.
InternationalPaymentId
string, required
Unique identification as assigned by the ASPSP to identify the international payment resource.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
string, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
ExpectedSettlementDateTime
string, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, required
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ExpirationDateTime
datetime, optional
Specified date and time the exchange rate agreement will expire.
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, required
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAgent
hash, optional
Financial institution servicing an account for the creditor.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
InstructionPriority
string, optional
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Allowed values:
Normal, Urgent
Can raise:
FieldInvalid
DestinationCountryCode
string, optional
Country in which Credit Account is domiciled. Nation with its own government. Should be in form of 2 character code.
Can raise:
FieldInvalid, CountryNameInvalid
Purpose
string, optional
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.
Can raise:
FieldInvalid
ExtendedPurpose
string, optional
Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
ChargeBearer
string, optional
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
CurrencyOfTransfer
string, required
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, optional
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.SWIFT
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
Creditor
hash, optional
Party to which an amount of money is due.
Name
string, optional
Creditor name
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, Rejected, AcceptedSettlementInProcess, AcceptedSettlementCompleted, AcceptedWithoutPosting, AcceptedCreditSettlementCompleted
Can raise:
FieldInvalid
CreationDateTime
string, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
StatusUpdateDateTime
string, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
Refund
hash, optional
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
Account
hash, required
Provides the details to identify an account.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
MultiAuthorisation
hash, optional
The multiple authorisation flow response from the ASPSP.
Status
string, required
Specifies the status of the authorisation flow in code form.
Allowed values:
AwaitingFurtherAuthorisation, Authorised, Rejected
Can raise:
FieldInvalid
NumberReceived
integer, optional
Number of authorisations received.
NumberRequired
integer, optional
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
LastUpdateDateTime
datetime, optional
Last date and time at which the authorisation flow was updated.
ExpirationDateTime
datetime, optional
Date and time at which the requested authorisation flow must be completed.
InternationalScheduledPaymentId
string, required
Unique identification as assigned by the ASPSP to identify the international scheduled payment resource.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
string, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
ExpectedSettlementDateTime
string, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, required
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ExpirationDateTime
datetime, optional
Specified date and time the exchange rate agreement will expire.
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, optional
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAgent
hash, optional
Financial institution servicing an account for the creditor.
SchemeName
string, optional
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
Identification
string, optional
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RequestedExecutionDateTime
datetime, required
Date at which the initiating party requests the clearing agent to process the payment.
InstructionPriority
string, optional
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Allowed values:
Normal, Urgent
Can raise:
FieldInvalid
DestinationCountryCode
string, optional
Country in which Credit Account is domiciled. Nation with its own government. Should be in form of 2 character code.
Can raise:
FieldInvalid, CountryNameInvalid
Purpose
string, optional
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.
Can raise:
FieldInvalid
ExtendedPurpose
string, optional
Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
ChargeBearer
string, optional
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
CurrencyOfTransfer
string, required
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, optional
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.SWIFT
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
Creditor
hash, optional
Party to which an amount of money is due.
Name
string, optional
Creditor name
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Related Errors
| Class | Code | Description |
|---|---|---|
| FieldInvalid | 400 | An invalid value is supplied in the field. More details in error_message. |
| ResourceNotFound | 400 | Specified resource doesn't exist. |
| ResourceInvalidConsentStatus | 400 | The action can't be performed with current status of consent. |
| UnsupportedCurrency | 400 | The currency is not supported. |
| CountryNameInvalid | 400 | Country doesn't exist or is invalid. Expected alpha 2 ISO3166 format. |
| UnsupportedFrequency | 400 | Specified frequency is unsupported. |
| HeaderMissing | 400 | A required HTTP header has not been provided. |
| HeaderInvalid | 400 | An invalid value is supplied in the HTTP header. |
| Unauthorized | 401 | Unauthorized access. |
| Forbidden | 403 | Action is forbidden. More details in error_message. |
×
![]()
Show
The API allows the TPP to ask an ASPSP to show a payment.
CURL
curl -i \ -H "Authorization: Bearer authorization" \ -H "Content-Type: application/json" \ -H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \ -H "Accept: application/json" \ -H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \ -H "Idempotency-Key: da7c525d-9ec0-4b28-aae5-e97f6f39dfbd" \ -H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \ -H "x-fapi-customer-ip-address: 104.25.212.99" \ -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.mjGjf3oAAmQvM5lO9EZT7MPPdSJ5s1lxywFbAyTtXw77Y-9GINBFAO_UsoTfoE6UboBc8LLvIwIILExdePSqxMirrKUii0HbKNE10iyHxtbx_aXNg1JZm4JLrZsYl1A6JWey0AuMSNvmo5UmWurwRkEt57Nlc__tBlgakQ1XpihVe4Fy2_Dv92Qy0Vfeu0B2fDOhh3E9iHPx23jqculcFaBBjUsbgxVB5RQ5hyYq6_R_0TdMGQ5Hpt39gJhlPbPyrOawDlH8nU4Wv_U3ZwPO7CSYWjTP4XQJHkFPCRaYkmPIBl6WJD2jvwGRgEERKSlTq7U3hR1iJbAo_sf766fR7w' \ -X GET "/api/:provider_code/open-banking/v3.1/pisp/:payment_product/:payment_id"
curl -i \
-H "Authorization: Bearer authorization" \
-H "Content-Type: application/json" \
-H "x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d" \
-H "Accept: application/json" \
-H "x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K" \
-H "Idempotency-Key: da7c525d-9ec0-4b28-aae5-e97f6f39dfbd" \
-H "x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT" \
-H "x-fapi-customer-ip-address: 104.25.212.99" \
-d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.mjGjf3oAAmQvM5lO9EZT7MPPdSJ5s1lxywFbAyTtXw77Y-9GINBFAO_UsoTfoE6UboBc8LLvIwIILExdePSqxMirrKUii0HbKNE10iyHxtbx_aXNg1JZm4JLrZsYl1A6JWey0AuMSNvmo5UmWurwRkEt57Nlc__tBlgakQ1XpihVe4Fy2_Dv92Qy0Vfeu0B2fDOhh3E9iHPx23jqculcFaBBjUsbgxVB5RQ5hyYq6_R_0TdMGQ5Hpt39gJhlPbPyrOawDlH8nU4Wv_U3ZwPO7CSYWjTP4XQJHkFPCRaYkmPIBl6WJD2jvwGRgEERKSlTq7U3hR1iJbAo_sf766fR7w' \
-X GET "/api/:provider_code/open-banking/v3.1/pisp/:payment_product/:payment_id"Example of response
{"Data":{"DomesticPaymentId":"string","ConsentId":"string","Status":"string","CreationDateTime":"string","StatusUpdateDateTime":"string","ReadRefundAccount":"string","CutOffDateTime":"string","ExpectedExecutionDateTime":"string","ExpectedSettlementDateTime":"string","Authorisation":{"AuthorisationType":"string","CompletionDateTime":"string"},"Charges":[{"ChargeBearer":"string","Type":"string","Amount":{"Amount":"string","Currency":"string"}}],"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"DomesticPaymentId":"string","ConsentId":"string","Status":"string","CreationDateTime":"string","StatusUpdateDateTime":"string","ReadRefundAccount":"string","CutOffDateTime":"string","ExpectedExecutionDateTime":"string","ExpectedSettlementDateTime":"string","Authorisation":{"AuthorisationType":"string","CompletionDateTime":"string"},"Charges":[{"ChargeBearer":"string","Type":"string","Amount":{"Amount":"string","Currency":"string"}}],"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"DomesticPaymentId":"string","ConsentId":"string","Status":"string","CreationDateTime":"string","StatusUpdateDateTime":"string","ReadRefundAccount":"string","CutOffDateTime":"string","ExpectedExecutionDateTime":"string","ExpectedSettlementDateTime":"string","Authorisation":{"AuthorisationType":"string","CompletionDateTime":"string"},"Charges":[{"ChargeBearer":"string","Type":"string","Amount":{"Amount":"string","Currency":"string"}}],"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"DomesticPaymentId":"string","ConsentId":"string","Status":"string","CreationDateTime":"string","StatusUpdateDateTime":"string","ReadRefundAccount":"string","CutOffDateTime":"string","ExpectedExecutionDateTime":"string","ExpectedSettlementDateTime":"string","Authorisation":{"AuthorisationType":"string","CompletionDateTime":"string"},"Charges":[{"ChargeBearer":"string","Type":"string","Amount":{"Amount":"string","Currency":"string"}}],"Initiation":{"InstructionIdentification":"ANSM023","EndToEndIdentification":"FRESCO.21302.GFX.37","RequestedExecutionDateTime":"2033-08-06T00:00:00+00:00","LocalInstrument":"UK.OBIE.FPS","InstructedAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"CreditorPostalAddress":{"AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"],"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"DomesticStandingOrderId":"58923","ConsentId":"18463","Status":"InitiationPending","CreationDateTime":"string","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"Initiation":{"Frequency":"EvryDay","FirstPaymentDateTime":"2017-06-05T15:15:13+00:00","FirstPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"FinalPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"RecurringPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-standing-order/58923","First":"/open-banking/v3.1/pisp/domestic-standing-order/58923","Last":"/open-banking/v3.1/pisp/domestic-standing-order/58925","Next":"/open-banking/v3.1/pisp/domestic-standing-order/58924","Prev":"/open-banking/v3.1/pisp/domestic-standing-order/58922"},"Meta":{"TotalPages":1}}
{"Data":{"DomesticStandingOrderId":"58923","ConsentId":"18463","Status":"InitiationPending","CreationDateTime":"string","Authorisation":{"AuthorisationType":"auth","CompletionDateTime":"2017-06-05T15:15:13+00:00"},"Charges":[{"ChargeBearer":"ChargeBearer","Type":"Type","Amount":{"Amount":"123","Currency":"GBP"}}],"Initiation":{"Frequency":"EvryDay","FirstPaymentDateTime":"2017-06-05T15:15:13+00:00","FirstPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"FinalPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"RecurringPaymentAmount":{"Amount":"20.00","Currency":"GBP"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"11280001234567","Name":"Andrea Smith","SecondaryIdentification":"0002"},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"Bob Clements","SecondaryIdentification":"0003"},"RemittanceInformation":{"Reference":"FRESCO-037","Unstructured":"Internal ops code 5120103"},"SupplementaryData":{}}},"Links":{"Self":"/open-banking/v3.1/pisp/domestic-standing-order/58923","First":"/open-banking/v3.1/pisp/domestic-standing-order/58923","Last":"/open-banking/v3.1/pisp/domestic-standing-order/58925","Next":"/open-banking/v3.1/pisp/domestic-standing-order/58924","Prev":"/open-banking/v3.1/pisp/domestic-standing-order/58922"},"Meta":{"TotalPages":1}}
{"Data":{"InternationalPaymentId":"58923-001","ConsentId":"58923","Status":"AcceptedSettlementInProcess","ReadRefundAccount":"Yes","CreationDateTime":"2017-06-05T15:15:22+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","CompletionDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"string","CompletionDateTime":"string"},"Charges":[{"ChargeBearer":"string","Type":"string","Amount":{"Amount":123,"Currency":"GBP"}}],"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Normal","Purpose":"string","ChargeBearer":"string","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"string","ContractIdentification":"string"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"},"SupplementaryData":{},"MultiAuthorisation":{"ExpirationDateTime":"2017-06-05T15:15:15+00:00","LastUpdateDateTime":"2017-06-05T15:15:15+00:00","NumberReceived":1,"NumberRequired":2,"Status":"AwaitingFurtherAuthorisation"}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"InternationalPaymentId":"58923-001","ConsentId":"58923","Status":"AcceptedSettlementInProcess","ReadRefundAccount":"Yes","CreationDateTime":"2017-06-05T15:15:22+00:00","StatusUpdateDateTime":"2017-06-05T15:15:13+00:00","CompletionDateTime":"2017-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2017-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2017-06-05T15:15:13+00:00","Authorisation":{"AuthorisationType":"string","CompletionDateTime":"string"},"Charges":[{"ChargeBearer":"string","Type":"string","Amount":{"Amount":123,"Currency":"GBP"}}],"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Normal","Purpose":"string","ChargeBearer":"string","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"string","ContractIdentification":"string"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"},"SupplementaryData":{},"MultiAuthorisation":{"ExpirationDateTime":"2017-06-05T15:15:15+00:00","LastUpdateDateTime":"2017-06-05T15:15:15+00:00","NumberReceived":1,"NumberRequired":2,"Status":"AwaitingFurtherAuthorisation"}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"InternationalScheduledPaymentId":"58924-001","ConsentId":"58924","Status":"AcceptedSettlementInProcess","ReadRefundAccount":"Yes","CreationDateTime":"2023-06-05T15:15:22+00:00","StatusUpdateDateTime":"2023-06-05T15:15:13+00:00","CompletionDateTime":"2023-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2023-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2023-06-05T15:15:13+00:00","Charges":[{"ChargeBearer":"string","Type":"string","Amount":{"Amount":123,"Currency":"GBP"}}],"Debtor":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"string","ChargeBearer":"string","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"string","ContractIdentification":"string"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"},"SupplementaryData":{},"MultiAuthorisation":{"ExpirationDateTime":"2017-06-05T15:15:15+00:00","LastUpdateDateTime":"2017-06-05T15:15:15+00:00","NumberReceived":1,"NumberRequired":2,"Status":"AwaitingFurtherAuthorisation"}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
{"Data":{"InternationalScheduledPaymentId":"58924-001","ConsentId":"58924","Status":"AcceptedSettlementInProcess","ReadRefundAccount":"Yes","CreationDateTime":"2023-06-05T15:15:22+00:00","StatusUpdateDateTime":"2023-06-05T15:15:13+00:00","CompletionDateTime":"2023-06-05T15:15:13+00:00","ExpectedExecutionDateTime":"2023-06-05T15:15:13+00:00","ExpectedSettlementDateTime":"2023-06-05T15:15:13+00:00","Charges":[{"ChargeBearer":"string","Type":"string","Amount":{"Amount":123,"Currency":"GBP"}}],"Debtor":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Initiation":{"InstructionIdentification":"ACME412","EndToEndIdentification":"FRESCO.21302.GFX.20","LocalInstrument":"UK.OBIE.SWIFT","InstructionPriority":"Urgent","Purpose":"string","ChargeBearer":"string","CurrencyOfTransfer":"EUR","InstructedAmount":{"Amount":"165.88","Currency":"GBP"},"ExchangeRateInformation":{"UnitCurrency":"EUR","ExchangeRate":"0.99","RateType":"string","ContractIdentification":"string"},"DebtorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"Creditor":{"Name":"John Smith","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":"London","Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAgent":{"Name":"John Smith","SchemeName":"UK.OBIE.BICFI","Identification":"08080021325698","PostalAddress":{"AddressType":"Address with house number and street","Department":"Prime Minister's Office","SubDepartment":"Cabinet Office","StreetName":"Sir George Downing","BuildingNumber":"10","PostCode":"SW1A 2AA","TownName":"City of Westminster London,","CountrySubDivision":["London"],"Country":"GB","AddressLine":["10 Downing St, Westminster, London SW1A 2AA, United Kingdom"]}},"CreditorAccount":{"SchemeName":"UK.OBIE.SortCodeAccountNumber","Identification":"08080021325698","Name":"ACME Inc","SecondaryIdentification":"0002"},"RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"},"SupplementaryData":{},"MultiAuthorisation":{"ExpirationDateTime":"2017-06-05T15:15:15+00:00","LastUpdateDateTime":"2017-06-05T15:15:15+00:00","NumberReceived":1,"NumberRequired":2,"Status":"AwaitingFurtherAuthorisation"}}},"Links":{"Self":"string","First":"string","Last":"string","Next":"string","Prev":"string"},"Meta":{"TotalPages":1}}
Request
GET
/api/:provider_code/open-banking/v3.1/pisp/:payment_product/:payment_id
Headers
| Header | Type | Description |
|---|---|---|
Content-Type
|
string, required | The media type of the body of the request. Default value: application/json Can raise: FieldInvalid |
x-fapi-interaction-id
|
string, optional | An RFC4122 UID used as a correlation Id. Can raise: FieldInvalid |
Accept
|
string, optional | Media type that is acceptable for the response. Can raise: FieldInvalid |
x-fapi-auth-date
|
string, optional | The time when the PSU last logged in with the TPP. Can raise: FieldInvalid |
x-fapi-customer-ip-address
|
string, optional | The PSU's IP address if the PSU is currently logged in with the TPP. Can raise: FieldInvalid |
Authorization
|
string, required | Standard HTTP Header; Allows Credentials to be provided to the Authorisation / Resource Server depending on the type of resource being requested. For OAuth 2.0 / OIDC, this comprises of either the Basic / Bearer Authentication Schemes. Can raise: HeaderMissing, HeaderInvalid, ResourceNotFound, Forbidden |
Request parameters
provider_code
(path)
string, required
Human readable Provider identifier.
Can raise:
FieldInvalid, ResourceNotFound
payment_product
(path)
string, required
The addressed payment resource.
Allowed values:
domestic-payments, domestic-scheduled-payments
Can raise:
FieldInvalid, ResourceNotFound
payment_id
(path)
string, required
Unique identification as assigned by the ASPSP to identify the domestic payment resource.
Can raise:
FieldInvalid, ResourceNotFound
Response headers
| Header | Type | Description |
|---|---|---|
Content-Type
|
string, required | The media type of the body of the request. |
x-fapi-interaction-id
|
string, required | An RFC4122 UID used as a correlation Id. If provided, the ASPSP must "play back" this value in the x-fapi-interaction-id response header. |
Retry-After
|
integer, optional | Amount of time in seconds after which Salt Edge PSD2 Compliance Solution resends the previously failed request. |
Response
Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, Rejected, AcceptedSettlementInProcess, AcceptedSettlementCompleted, AcceptedWithoutPosting, AcceptedCreditSettlementCompleted
Can raise:
FieldInvalid
CreationDateTime
string, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
StatusUpdateDateTime
string, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
MultiAuthorisation
hash, optional
The multiple authorisation flow response from the ASPSP.
Status
string, required
Specifies the status of the authorisation flow in code form.
Allowed values:
AwaitingFurtherAuthorisation, Authorised, Rejected
Can raise:
FieldInvalid
NumberReceived
integer, optional
Number of authorisations received.
NumberRequired
integer, optional
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
LastUpdateDateTime
datetime, optional
Last date and time at which the authorisation flow was updated.
ExpirationDateTime
datetime, optional
Date and time at which the requested authorisation flow must be completed.
Refund
hash, optional
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
Account
hash, required
Provides the details to identify an account.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
DomesticPaymentId
string, required
Unique identification as assigned by the ASPSP to identify the domestic payment resource.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
string, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
ExpectedSettlementDateTime
string, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, required
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.FPS
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorPostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
InitiationPending, InitiationFailed, InitiationCompleted, Cancelled
Can raise:
FieldInvalid
CreationDateTime
string, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
StatusUpdateDateTime
string, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
MultiAuthorisation
hash, optional
The multiple authorisation flow response from the ASPSP.
Status
string, required
Specifies the status of the authorisation flow in code form.
Allowed values:
AwaitingFurtherAuthorisation, Authorised, Rejected
Can raise:
FieldInvalid
NumberReceived
integer, optional
Number of authorisations received.
NumberRequired
integer, optional
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
LastUpdateDateTime
datetime, optional
Last date and time at which the authorisation flow was updated.
ExpirationDateTime
datetime, optional
Date and time at which the requested authorisation flow must be completed.
Refund
hash, optional
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
Account
hash, required
Provides the details to identify an account.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
DomesticScheduledPaymentId
string, required
Unique identification as assigned by the ASPSP to identify the domestic scheduled payment resource.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
string, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
ExpectedSettlementDateTime
string, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, optional
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
RequestedExecutionDateTime
datetime, required
Date at which the initiating party requests the clearing agent to process the payment.
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.FPS
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
CreditorPostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
InitiationPending, InitiationFailed, InitiationCompleted, Cancelled
Can raise:
FieldInvalid
CreationDateTime
string, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
StatusUpdateDateTime
string, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
MultiAuthorisation
hash, optional
The multiple authorisation flow response from the ASPSP.
Status
string, required
Specifies the status of the authorisation flow in code form.
Allowed values:
AwaitingFurtherAuthorisation, Authorised, Rejected
Can raise:
FieldInvalid
NumberReceived
integer, optional
Number of authorisations received.
NumberRequired
integer, optional
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
LastUpdateDateTime
datetime, optional
Last date and time at which the authorisation flow was updated.
ExpirationDateTime
datetime, optional
Date and time at which the requested authorisation flow must be completed.
Refund
hash, optional
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
Account
hash, required
Provides the details to identify an account.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
DomesticStandingOrderId
string, required
Unique identification as assigned by the ASPSP to identify the domestic standing order payment resource.
Can raise:
FieldInvalid
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
FinalPaymentDateTime
datetime, optional
The date on which the final payment for a Standing Order schedule will be made.
FirstPaymentDateTime
datetime, required
The date on which the first payment for a Standing Order schedule will be made.
RecurringPaymentDateTime
datetime, optional
The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.
Frequency
string, required
This is a specific format of describing the rule for creating the payments of a standing order.
It should comply with one of the permitted patterns. Full pattern represented as a regular expression which can be used for validating the value provided in this field:
^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
Can raise:
UnsupportedFrequency
NumberOfPayments
string, optional
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
Can raise:
FieldInvalid
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
FinalPaymentAmount
hash, optional
The amount of the final Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
FirstPaymentAmount
hash, required
The amount of the first Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
RecurringPaymentAmount
hash, optional
The amount of the recurring Standing Order.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, Rejected, AcceptedSettlementInProcess, AcceptedSettlementCompleted, AcceptedWithoutPosting, AcceptedCreditSettlementCompleted
Can raise:
FieldInvalid
CreationDateTime
string, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
StatusUpdateDateTime
string, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
MultiAuthorisation
hash, optional
The multiple authorisation flow response from the ASPSP.
Status
string, required
Specifies the status of the authorisation flow in code form.
Allowed values:
AwaitingFurtherAuthorisation, Authorised, Rejected
Can raise:
FieldInvalid
NumberReceived
integer, optional
Number of authorisations received.
NumberRequired
integer, optional
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
LastUpdateDateTime
datetime, optional
Last date and time at which the authorisation flow was updated.
ExpirationDateTime
datetime, optional
Date and time at which the requested authorisation flow must be completed.
Refund
hash, optional
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
Account
hash, required
Provides the details to identify an account.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
InternationalPaymentId
string, required
Unique identification as assigned by the ASPSP to identify the international payment resource.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
string, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
ExpectedSettlementDateTime
string, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, required
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ExpirationDateTime
datetime, optional
Specified date and time the exchange rate agreement will expire.
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, required
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAgent
hash, optional
Financial institution servicing an account for the creditor.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
InstructionPriority
string, optional
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Allowed values:
Normal, Urgent
Can raise:
FieldInvalid
DestinationCountryCode
string, optional
Country in which Credit Account is domiciled. Nation with its own government. Should be in form of 2 character code.
Can raise:
FieldInvalid, CountryNameInvalid
Purpose
string, optional
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.
Can raise:
FieldInvalid
ExtendedPurpose
string, optional
Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
ChargeBearer
string, optional
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
CurrencyOfTransfer
string, required
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, optional
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.SWIFT
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
Creditor
hash, optional
Party to which an amount of money is due.
Name
string, optional
Creditor name
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, required
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, required
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Data
hash, required
Wrapper for the data.
ConsentId
string, required
Unique identification as assigned by the ASPSP to identify the consent resource.
Can raise:
FieldInvalid
Status
string, required
Specifies the status of consent resource in code form.
Allowed values:
Pending, Rejected, AcceptedSettlementInProcess, AcceptedSettlementCompleted, AcceptedWithoutPosting, AcceptedCreditSettlementCompleted
Can raise:
FieldInvalid
CreationDateTime
string, required
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
StatusUpdateDateTime
string, required
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
Charges
array, optional
Wrapper for processing of the payment transaction.
ChargeBearer
string, required
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
Type
string, required
Charge type, in a coded form.
Can raise:
FieldInvalid
Amount
hash, required
Amount of money associated with the charge type.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
Debtor
hash, optional
Set of elements used to identify a person or an organisation.
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Can raise:
FieldInvalid
MultiAuthorisation
hash, optional
The multiple authorisation flow response from the ASPSP.
Status
string, required
Specifies the status of the authorisation flow in code form.
Allowed values:
AwaitingFurtherAuthorisation, Authorised, Rejected
Can raise:
FieldInvalid
NumberReceived
integer, optional
Number of authorisations received.
NumberRequired
integer, optional
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
LastUpdateDateTime
datetime, optional
Last date and time at which the authorisation flow was updated.
ExpirationDateTime
datetime, optional
Date and time at which the requested authorisation flow must be completed.
Refund
hash, optional
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
Account
hash, required
Provides the details to identify an account.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
InternationalScheduledPaymentId
string, required
Unique identification as assigned by the ASPSP to identify the international scheduled payment resource.
Can raise:
FieldInvalid
ExpectedExecutionDateTime
string, optional
Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
ExpectedSettlementDateTime
string, optional
Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Can raise:
FieldInvalid
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, required
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ExpirationDateTime
datetime, optional
Specified date and time the exchange rate agreement will expire.
Initiation
hash, required
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
string, required
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
EndToEndIdentification
string, optional
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
CreditorAgent
hash, optional
Financial institution servicing an account for the creditor.
SchemeName
string, optional
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.BICFI
Can raise:
FieldInvalid
Identification
string, optional
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
RequestedExecutionDateTime
datetime, required
Date at which the initiating party requests the clearing agent to process the payment.
InstructionPriority
string, optional
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
Allowed values:
Normal, Urgent
Can raise:
FieldInvalid
DestinationCountryCode
string, optional
Country in which Credit Account is domiciled. Nation with its own government. Should be in form of 2 character code.
Can raise:
FieldInvalid, CountryNameInvalid
Purpose
string, optional
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.
Can raise:
FieldInvalid
ExtendedPurpose
string, optional
Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
ChargeBearer
string, optional
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Allowed values:
BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared
Can raise:
FieldInvalid
CurrencyOfTransfer
string, required
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
Can raise:
FieldInvalid
InstructedAmount
hash, required
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Amount
string, required
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Can raise:
FieldInvalid
Currency
string, required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Can raise:
FieldInvalid, UnsupportedCurrency
ExchangeRateInformation
hash, optional
Provides details on the currency exchange rate and contract.
UnitCurrency
string, required
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Can raise:
FieldInvalid
ExchangeRate
string, optional
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
Can raise:
FieldInvalid
RateType
string, required
Specifies the type used to complete the currency exchange.
Allowed values:
Actual, Agreed, Indicative
Can raise:
FieldInvalid
ContractIdentification
string, optional
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Can raise:
FieldInvalid
DebtorAccount
hash, optional
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, optional
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
RemittanceInformation
hash, optional
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Reference
string, optional
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Unstructured
string, optional
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
Allowed length:
max: 140 characters
Can raise:
FieldInvalid
LocalInstrument
string, optional
User community specific instrument.
Allowed values:
UK.OBIE.SWIFT
Can raise:
FieldInvalid
CreditorAccount
hash, required
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName
string, required
Name of the identification scheme, in a coded form as published in an external list.
Allowed values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.BBAN
Can raise:
FieldInvalid
Identification
string, required
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Allowed length:
max: 256 characters
Can raise:
FieldInvalid
Name
string, required
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Allowed length:
max: 350 characters
Can raise:
FieldInvalid
SecondaryIdentification
string, optional
This is secondary identification of the account, as assigned by the account servicing institution.
Allowed length:
max: 34 characters
Can raise:
FieldInvalid
Creditor
hash, optional
Party to which an amount of money is due.
Name
string, optional
Creditor name
Can raise:
FieldInvalid
PostalAddress
hash, optional
Information that locates and identifies a specific address, as defined by postal services.
AddressLine
array, optional
Identifies the lines of the postal address.
AddressType
string, optional
Identifies the nature of the postal address.
Can raise:
FieldInvalid
Department
string, optional
Identification of a division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
SubDepartment
string, optional
Identification of a sub-division of a large organisation or building.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
StreetName
string, optional
Name of a street or thoroughfare.
Allowed length:
max: 70 characters
Can raise:
FieldInvalid
BuildingNumber
string, optional
Number that identifies the position of a building on a street.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
PostCode
string, optional
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Allowed length:
max: 16 characters
Can raise:
FieldInvalid
CountrySubDivision
string, optional
Identifies a subdivision of a country such as state, region, county.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
TownName
string, optional
Name of a built-up area, with defined boundaries, and a local government.
Allowed length:
max: 35 characters
Can raise:
FieldInvalid
Country
string, optional
Nation with its own government (ISO 3166-1 alpha-2 code).
Can raise:
FieldInvalid, CountryNameInvalid
SupplementaryData
hash, optional
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
hash, required
A list of hyperlinks to be recognized by the TPP.
Self
string, required
The link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
First
string, optional
The first link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Last
string, optional
The last link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Next
string, optional
The next link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Prev
string, optional
The preview link to the resource initiation created by this request. This link can be used to retrieve the resource data.
Can raise:
FieldInvalid
Meta
hash, required
Wrapper for the meta.
Default value:
{}
TotalPages
integer, optional
The total number of pages.
Related Errors
| Class | Code | Description |
|---|---|---|
| FieldInvalid | 400 | An invalid value is supplied in the field. More details in error_message. |
| ResourceNotFound | 400 | Specified resource doesn't exist. |
| HeaderMissing | 400 | A required HTTP header has not been provided. |
| HeaderInvalid | 400 | An invalid value is supplied in the HTTP header. |
| Forbidden | 403 | Action is forbidden. More details in error_message. |
×
![]()