ASPSPs

Open Banking Providers

Used by TPP for obtaining the list of ASPSPs which support OpenBanking standard.

CURL

curl -i \ -H "Content-Type: application/json" \ -H "Client-Id: client_application_identifier" \ -H "x-fapi-interaction-id: some-uuid" \ -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.ATtOOfqMwqkjIFzIRU2wd6URPcQ8dn1XTrTcdt_9djsTHbESZY8OiMs41jWOOkLwgWAz2y-MLUX5QuRP_EYyM5fTB4xXekF3n_ypGtgQWcx3ocS-1U0W-RK_4IGBzTX-QAGw1XDKeD6hy1vWqCgZHs8kPhdCt5ILEXQI9BIU_hIEjq-vIcImik3NO2biEKulLauccy9FBrkU2k0lIgYQ3cjoY5xRyDOXtBA7Mpl_CUPgkl7zoD52jtNNZuVJDYnAofOltyUspA1zQC1q_5tlbnhO_nCuTB3wOzbSatH5py0kMLxnM6j9EcNgfNydMuf5EXQaSWqYVFUnKBm3HykzpQ' \ -X GET "/api/open-banking/v3.1/aspsps"

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: client_application_identifier" \ 
 -H "x-fapi-interaction-id: some-uuid" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.ATtOOfqMwqkjIFzIRU2wd6URPcQ8dn1XTrTcdt_9djsTHbESZY8OiMs41jWOOkLwgWAz2y-MLUX5QuRP_EYyM5fTB4xXekF3n_ypGtgQWcx3ocS-1U0W-RK_4IGBzTX-QAGw1XDKeD6hy1vWqCgZHs8kPhdCt5ILEXQI9BIU_hIEjq-vIcImik3NO2biEKulLauccy9FBrkU2k0lIgYQ3cjoY5xRyDOXtBA7Mpl_CUPgkl7zoD52jtNNZuVJDYnAofOltyUspA1zQC1q_5tlbnhO_nCuTB3wOzbSatH5py0kMLxnM6j9EcNgfNydMuf5EXQaSWqYVFUnKBm3HykzpQ' \ 
-X GET "/api/open-banking/v3.1/aspsps"

Example of response

{"Data":[{"AspspCode":"ob_demobank","Name":"Open Banking Demobank","Status":"live","LogoUrl":"https://priora.saltedge.com/images/demobank_logo.svg","CountryCode":"XF","SupportedFlows":["AIS","PIS"],"SandboxCredentials":[{"AuthorisationType":"oauth","RequiredFields":[{"Code":"required_field","Example":"reqField"}],"MfaFields":[{"Code":"mfa_field","Example":"mfaField"}]}],"PisParams":{"ObPaymentsProducts":["domestic-payments","international-payments"],"DomesticInstruments":["UK.OBIE.BACS","UK.OBIE.CHAPS","UK.OBIE.FPS"],"InternationalInstruments":["UK.OBIE.SWIFT"],"CreditorIdentificationSchemes":["UK.OBIE.SortCodeAccountNumber","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.BBAN"]}}]}

Request

GET /api/open-banking/v3.1/aspsps

Headers

Header	Type	Description
`Accept`	string, optional	Media type that is acceptable for the response. Default value: application/json
`x-fapi-interaction-id`	string, optional	An RFC4122 UID used as a correlation Id.
`Client-Id`	string, required	Client application identifier. Can raise: ResourceNotFound

Request parameters

SupportedFlows (path)

array, optional

ASPSP available flows. Default value: ["AIS", "PIS", "PIIS"] Allowed values: AIS, PIS, PIIS

Response headers

Header	Type	Description
`Content-Type`	string, required	The media type of the body of the request.
`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

array, required

Wrapper for the data.

AspspCode

string, required

ASPSP Code to use in the salt edge_endpoint. Can raise: FieldInvalid

Name

string, required

ASPSP business name. Can raise: FieldInvalid

Status

string, required

ASPSP status. Allowed values: live, test, sandbox Can raise: FieldInvalid

LogoUrl

string, required

ASPSP logo location. Can raise: FieldInvalid

SupportedFlows

array, required

ASPSP available flows. Allowed values: AIS, PIS, PIIS

CountryCode

string, required

ASPSP's country code. Can raise: FieldInvalid

CreditorAgentRequired

boolean, required

Equals 'true' if CreditorAgent parameter for International Payments is required

Data

object, optional

Wrapper for the data.

ObPaymentsProducts

array, required

Payment products supported by ASPSP Allowed values: domestic-payments, international-payments, domestic-scheduled-payments, international-scheduled-payments, domestic-standing-orders, international-standing-orders

DomesticInstruments

array, required

LocalInstruments for domestic payments supported by ASPSP

InternationalInstruments

array, required

LocalInstruments for international payments supported by ASPSP

CreditorIdentificationSchemes

array, required

Identification schemes of Creditor supported by ASPSP

Related Errors

Class	Code	Description
ResourceNotFound	400	Specified resource doesn't exist.

Open Banking Provider's Supported Permissions

Used by TPP for obtaining the list of ASPSP's supported permissions.

CURL

curl -i \ -H "Content-Type: application/json" \ -H "Client-Id: client_application_identifier" \ -H "x-fapi-interaction-id: some-uuid" \ -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.JMt0IAo98ZnDt40pcGkufKKMvwbABdjL1uX4JyrOy5SBzJD7d3dfw9X8ywELirqAlKkGWtGMqSjkwqfKYMs8a1JxAHMmCNr8v07B_eyY5y7XUGI5Jy3E9wwNpFjJl1CjkAggVMY5nYRXz-ecTQBAIwGvY_qjQmlCOEM0beqUEZrgL8GFCyQaNnRPEEiN7bCqINNSEq9ZS1xGZvCrfT26a0AyHyB3ZJL9CtzLdVfF8H0PxWxCkpgWvUPodG_tKEsAVNeLorokApAOzGwgGeEb6VB1A6-g8UBtDLKZN2qdyV-bQ0d5RHkY1BP0dFv-7fSRxDRiqY-DG-k5igdrkEwaBQ' \ -X GET "/api/open-banking/v3.1/aspsps/:provider_code/permissions"

curl -i  \ 
 -H "Content-Type: application/json" \ 
 -H "Client-Id: client_application_identifier" \ 
 -H "x-fapi-interaction-id: some-uuid" \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.e30.JMt0IAo98ZnDt40pcGkufKKMvwbABdjL1uX4JyrOy5SBzJD7d3dfw9X8ywELirqAlKkGWtGMqSjkwqfKYMs8a1JxAHMmCNr8v07B_eyY5y7XUGI5Jy3E9wwNpFjJl1CjkAggVMY5nYRXz-ecTQBAIwGvY_qjQmlCOEM0beqUEZrgL8GFCyQaNnRPEEiN7bCqINNSEq9ZS1xGZvCrfT26a0AyHyB3ZJL9CtzLdVfF8H0PxWxCkpgWvUPodG_tKEsAVNeLorokApAOzGwgGeEb6VB1A6-g8UBtDLKZN2qdyV-bQ0d5RHkY1BP0dFv-7fSRxDRiqY-DG-k5igdrkEwaBQ' \ 
-X GET "/api/open-banking/v3.1/aspsps/:provider_code/permissions"

Example of response

{"Data":[{"SupportedPermissions":["ReadAccountsBasic","ReadAccountsDetail","ReadBalances","ReadTransactionsBasic","ReadTransactionsCredits","ReadTransactionsDebits","ReadTransactionsDetail","ReadBeneficiariesDetail","ReadBeneficiariesBasic","ReadDirectDebits","ReadStandingOrdersDetail","ReadStandingOrdersBasic","ReadParty","ReadScheduledPaymentsBasic","ReadScheduledPaymentsDetail"]}]}

Request

GET /api/open-banking/v3.1/aspsps/:provider_code/permissions

Headers

Header	Type	Description
`Accept`	string, optional	Media type that is acceptable for the response. Default value: application/json
`x-fapi-interaction-id`	string, optional	An RFC4122 UID used as a correlation Id.
`Client-Id`	string, required	Client application identifier in Salt Edge PSD2 Compliance. Should be used to get public key for Authorization header validation. Can raise: ResourceNotFound

Request parameters

provider_code (path)

string, required

ASPSP code.

Response headers

Header	Type	Description
`Content-Type`	string, required	The media type of the body of the request.
`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

object, required

Wrapper for the data.

SupportedPermissions

array, required

ASPSP supported permissions. Allowed values: ReadAccountsBasic, ReadAccountsDetail, ReadBalances, ReadTransactionsBasic, ReadTransactionsCredits, ReadTransactionsDebits, ReadTransactionsDetail, ReadBeneficiariesDetail, ReadBeneficiariesBasic, ReadDirectDebits, ReadStandingOrdersDetail, ReadStandingOrdersBasic, ReadParty, ReadScheduledPaymentsBasic, ReadScheduledPaymentsDetail

Related Errors

Class	Code	Description
ResourceNotFound	400	Specified resource doesn't exist.