{"swagger":"2.0","info":{"title":"PAPI Polish Api","description":"Creative Commons Attribution 3.0 Unported Poland (CC BY 3.0 PL)","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v2.1.1.1"},"host":"ifcsandbox.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/polish-api/v2.1.1.1/accounts/v2_1_1.1/deleteConsent":{"post":{"tags":["AIS","Mocked-Data"],"summary":"Removes consent","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
NOTE: This endpoint currently only returns example data.
Removes consent
Authentication is Mandatory
","operationId":"deleteConsent","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/accounts/v2_1_1.1/getAccount":{"post":{"tags":["AIS","Mocked-Data"],"summary":"Get detailed information about user payment account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
User identification based on access token
Authentication is Mandatory
","operationId":"getAccount","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/accounts/v2_1_1.1/getAccounts":{"post":{"tags":["AIS","Mocked-Data"],"summary":"Get information about all user's payment account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
User identification based on access token
Authentication is Mandatory
","operationId":"getAccounts","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/accounts/v2_1_1.1/getHolds":{"post":{"tags":["AIS","Mocked-Data"],"summary":"Get list of user's holded operations","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"getHolds","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/accounts/v2_1_1.1/getTransactionDetail":{"post":{"tags":["AIS","Mocked-Data"],"summary":"Get detailed information about user's single transaction","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"getTransactionDetail","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/accounts/v2_1_1.1/getTransactionsCancelled":{"post":{"tags":["AIS","Mocked-Data"],"summary":"Get list of user cancelled transactions","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"getTransactionsCancelled","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/accounts/v2_1_1.1/getTransactionsDone":{"post":{"tags":["AIS","Mocked-Data"],"summary":"Get list of user done transactions","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"getTransactionsDone","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/accounts/v2_1_1.1/getTransactionsPending":{"post":{"tags":["AIS","Mocked-Data"],"summary":"Get list of user's pending transactions","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"getTransactionsPending","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/accounts/v2_1_1.1/getTransactionsRejected":{"post":{"tags":["AIS","Mocked-Data"],"summary":"Get list of user's rejected transactions","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"getTransactionsRejected","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/accounts/v2_1_1.1/getTransactionsScheduled":{"post":{"tags":["AIS","Mocked-Data"],"summary":"Get list of user scheduled transactions","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"getTransactionsScheduled","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/auth/v2_1_1.1/authorize":{"post":{"tags":["AS","Mocked-Data"],"summary":"Requests OAuth2 authorization code","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Requests OAuth2 authorization code
Authentication is Mandatory
","operationId":"authorize","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/auth/v2_1_1.1/authorizeExt":{"post":{"tags":["AS","Mocked-Data"],"summary":"Requests OAuth2 authorization code based on One-time authorization code issued by External Authorization Tool","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Requests OAuth2 authorization code based One-time authorization code issued by External Authorization Tool. Authorization code will be delivered to TPP as callback request from ASPSP if PSU authentication is confirmed by EAT. Callback function must provide similar notification also in case of unsuccessful authentication or its abandonment.
Authentication is Mandatory
","operationId":"authorizeExt","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/auth/v2_1_1.1/token":{"post":{"tags":["AS","Mocked-Data"],"summary":"Requests OAuth2 access token value","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Requests OAuth2 access token value
Authentication is Mandatory
","operationId":"token","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/confirmation/v2_1_1.1/getConfirmationOfFunds":{"post":{"tags":["CAF","Mocked-Data"],"summary":"Confirmation of the availability of funds","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Confirming the availability on the payers account of the amount necessary to execute the payment transaction, as defined in Art. 65 PSD2.
Authentication is Mandatory
","operationId":"getConfirmationOfFunds","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/payments/v2_1_1.1/EEA":{"post":{"tags":["PIS","Mocked-Data"],"summary":"Initiate SEPA foreign transfers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"eEA","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/payments/v2_1_1.1/bundle":{"post":{"tags":["PIS","Mocked-Data"],"summary":"Initiate many transfers as bundle","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"bundle","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/payments/v2_1_1.1/cancelPayments":{"post":{"tags":["PIS","Mocked-Data"],"summary":"Cancelation of future dated payment","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"cancelPayments","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/payments/v2_1_1.1/cancelRecurringPayment":{"post":{"tags":["PIS","Mocked-Data"],"summary":"Cancelation of recurring payment","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"cancelRecurringPayment","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/payments/v2_1_1.1/domestic":{"post":{"tags":["PIS","Mocked-Data"],"summary":"Initiate domestic transfer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"domestic","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/payments/v2_1_1.1/getBundle":{"post":{"tags":["PIS","Mocked-Data"],"summary":"Get the status of bundle of payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"getBundle","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/payments/v2_1_1.1/getMultiplePayments":{"post":{"tags":["PIS","Mocked-Data"],"summary":"Get the status of multiple payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"getMultiplePayments","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/payments/v2_1_1.1/getPayment":{"post":{"tags":["PIS","Mocked-Data"],"summary":"Get the status of payment","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"getPayment","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/payments/v2_1_1.1/getRecurringPayment":{"post":{"tags":["PIS","Mocked-Data"],"summary":"Get the status of recurring payment","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"getRecurringPayment","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/payments/v2_1_1.1/nonEEA":{"post":{"tags":["PIS","Mocked-Data"],"summary":"Initiate non SEPA foreign transfers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"nonEEA","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/payments/v2_1_1.1/recurring":{"post":{"tags":["PIS","Mocked-Data"],"summary":"Defines new recurring payment","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"recurring","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/polish-api/v2.1.1.1/payments/v2_1_1.1/tax":{"post":{"tags":["PIS","Mocked-Data"],"summary":"Initiate tax transfer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
","operationId":"tax","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/FooBar":{"get":{"tags":["_Foo Bar","Dynamic-Entity","Dynamic"],"summary":"Get Foo Bar List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Foo Bar List.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FooBar" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /FooBar?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Foo Bar.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FooBar" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createFooBar_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"fooBarId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["fooBarId","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/FooBar/FOO_BAR_ID":{"delete":{"tags":["_Foo Bar","Dynamic-Entity","Dynamic"],"summary":"Delete Foo Bar by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Foo Bar by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FooBar" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteFooBar_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"fooBarId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["fooBarId","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Foo Bar","Dynamic-Entity","Dynamic"],"summary":"Get Foo Bar by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Foo Bar by id.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FooBar" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleFooBar_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"fooBarId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["fooBarId","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Foo Bar","Dynamic-Entity","Dynamic"],"summary":"Update Foo Bar","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Foo Bar.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FooBar" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateFooBar_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"fooBarId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["fooBarId","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/authority_data_request":{"get":{"tags":["_Authority Data Request","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request List.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /authority_data_request?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createauthority_data_request_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"bank_code":{"type":"string","example":"mybank"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","bank_code","mandate_name","mandate_name_year"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"bank_code":{"type":"string","example":"mybank"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","bank_code","mandate_name","mandate_name_year"]}},"required":["authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/authority_data_request/AUTHORITY_DATA_REQUEST_ID":{"delete":{"tags":["_Authority Data Request","Dynamic-Entity","Dynamic"],"summary":"Delete Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Authority Data Request by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteauthority_data_request_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"bank_code":{"type":"string","example":"mybank"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","bank_code","mandate_name","mandate_name_year"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"bank_code":{"type":"string","example":"mybank"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","bank_code","mandate_name","mandate_name_year"]}},"required":["authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Authority Data Request","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request by id.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleauthority_data_request_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"bank_code":{"type":"string","example":"mybank"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","bank_code","mandate_name","mandate_name_year"]}},"required":["authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Authority Data Request","Dynamic-Entity","Dynamic"],"summary":"Update Authority Data Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateauthority_data_request_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"bank_code":{"type":"string","example":"mybank"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","bank_code","mandate_name","mandate_name_year"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"bank_code":{"type":"string","example":"mybank"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","bank_code","mandate_name","mandate_name_year"]}},"required":["authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/000202/authority_data_request":{"get":{"tags":["_Authority Data Request(000202)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request List.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /authority_data_request?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createauthority_data_request_000202","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/000202/authority_data_request/AUTHORITY_DATA_REQUEST_ID":{"delete":{"tags":["_Authority Data Request(000202)","Dynamic-Entity","Dynamic"],"summary":"Delete Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Authority Data Request by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteauthority_data_request_000202","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Authority Data Request(000202)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request by id.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleauthority_data_request_000202","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Authority Data Request(000202)","Dynamic-Entity","Dynamic"],"summary":"Update Authority Data Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateauthority_data_request_000202","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/ADOPEM/authority_data_request":{"get":{"tags":["_Authority Data Request(ADOPEM)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request List.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /authority_data_request?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createauthority_data_request_ADOPEM","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/ADOPEM/authority_data_request/AUTHORITY_DATA_REQUEST_ID":{"delete":{"tags":["_Authority Data Request(ADOPEM)","Dynamic-Entity","Dynamic"],"summary":"Delete Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Authority Data Request by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteauthority_data_request_ADOPEM","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Authority Data Request(ADOPEM)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request by id.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleauthority_data_request_ADOPEM","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Authority Data Request(ADOPEM)","Dynamic-Entity","Dynamic"],"summary":"Update Authority Data Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateauthority_data_request_ADOPEM","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/APAP/authority_data_request":{"get":{"tags":["_Authority Data Request(APAP)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request List.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /authority_data_request?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createauthority_data_request_APAP","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/APAP/authority_data_request/AUTHORITY_DATA_REQUEST_ID":{"delete":{"tags":["_Authority Data Request(APAP)","Dynamic-Entity","Dynamic"],"summary":"Delete Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Authority Data Request by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteauthority_data_request_APAP","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Authority Data Request(APAP)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request by id.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleauthority_data_request_APAP","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Authority Data Request(APAP)","Dynamic-Entity","Dynamic"],"summary":"Update Authority Data Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateauthority_data_request_APAP","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/BANRESERVAS/authority_data_request":{"get":{"tags":["_Authority Data Request(BANRESERVAS)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request List.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /authority_data_request?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createauthority_data_request_BANRESERVAS","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/BANRESERVAS/authority_data_request/AUTHORITY_DATA_REQUEST_ID":{"delete":{"tags":["_Authority Data Request(BANRESERVAS)","Dynamic-Entity","Dynamic"],"summary":"Delete Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Authority Data Request by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteauthority_data_request_BANRESERVAS","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Authority Data Request(BANRESERVAS)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request by id.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleauthority_data_request_BANRESERVAS","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Authority Data Request(BANRESERVAS)","Dynamic-Entity","Dynamic"],"summary":"Update Authority Data Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateauthority_data_request_BANRESERVAS","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/BHD_LEON/authority_data_request":{"get":{"tags":["_Authority Data Request(BHD LEON)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request List.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /authority_data_request?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createauthority_data_request_BHD_LEON","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/BHD_LEON/authority_data_request/AUTHORITY_DATA_REQUEST_ID":{"delete":{"tags":["_Authority Data Request(BHD LEON)","Dynamic-Entity","Dynamic"],"summary":"Delete Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Authority Data Request by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteauthority_data_request_BHD_LEON","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Authority Data Request(BHD LEON)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request by id.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleauthority_data_request_BHD_LEON","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Authority Data Request(BHD LEON)","Dynamic-Entity","Dynamic"],"summary":"Update Authority Data Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateauthority_data_request_BHD_LEON","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/CONFISA/authority_data_request":{"get":{"tags":["_Authority Data Request(CONFISA)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request List.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /authority_data_request?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createauthority_data_request_CONFISA","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/CONFISA/authority_data_request/AUTHORITY_DATA_REQUEST_ID":{"delete":{"tags":["_Authority Data Request(CONFISA)","Dynamic-Entity","Dynamic"],"summary":"Delete Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Authority Data Request by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteauthority_data_request_CONFISA","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Authority Data Request(CONFISA)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request by id.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleauthority_data_request_CONFISA","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Authority Data Request(CONFISA)","Dynamic-Entity","Dynamic"],"summary":"Update Authority Data Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateauthority_data_request_CONFISA","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/POPULAR/authority_data_request":{"get":{"tags":["_Authority Data Request(POPULAR)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request List.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /authority_data_request?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createauthority_data_request_POPULAR","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/POPULAR/authority_data_request/AUTHORITY_DATA_REQUEST_ID":{"delete":{"tags":["_Authority Data Request(POPULAR)","Dynamic-Entity","Dynamic"],"summary":"Delete Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Authority Data Request by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteauthority_data_request_POPULAR","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Authority Data Request(POPULAR)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request by id.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleauthority_data_request_POPULAR","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Authority Data Request(POPULAR)","Dynamic-Entity","Dynamic"],"summary":"Update Authority Data Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateauthority_data_request_POPULAR","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/SCOTIABANK/authority_data_request":{"get":{"tags":["_Authority Data Request(SCOTIABANK)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request List.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /authority_data_request?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createauthority_data_request_SCOTIABANK","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/SCOTIABANK/authority_data_request/AUTHORITY_DATA_REQUEST_ID":{"delete":{"tags":["_Authority Data Request(SCOTIABANK)","Dynamic-Entity","Dynamic"],"summary":"Delete Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Authority Data Request by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteauthority_data_request_SCOTIABANK","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Authority Data Request(SCOTIABANK)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request by id.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleauthority_data_request_SCOTIABANK","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Authority Data Request(SCOTIABANK)","Dynamic-Entity","Dynamic"],"summary":"Update Authority Data Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateauthority_data_request_SCOTIABANK","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/brrd_01/authority_data_request":{"get":{"tags":["_Authority Data Request(brrd 01)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request List.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /authority_data_request?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createauthority_data_request_brrd_01","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/brrd_01/authority_data_request/AUTHORITY_DATA_REQUEST_ID":{"delete":{"tags":["_Authority Data Request(brrd 01)","Dynamic-Entity","Dynamic"],"summary":"Delete Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Authority Data Request by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteauthority_data_request_brrd_01","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Authority Data Request(brrd 01)","Dynamic-Entity","Dynamic"],"summary":"Get Authority Data Request by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Authority Data Request by id.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleauthority_data_request_brrd_01","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Authority Data Request(brrd 01)","Dynamic-Entity","Dynamic"],"summary":"Update Authority Data Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Authority Data Request.
Legal request to give customer data to the authorities
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"authority_data_request" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateauthority_data_request_brrd_01","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["customer_number","mandate_name","mandate_name_year"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"authority_data_request":{"type":"object","properties":{"authority_data_requestId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_number":{"type":"string","example":"1234567"},"mandate_name":{"type":"string","example":"National Anti-Fraud Act"},"mandate_name_year":{"type":"string","example":"1978"}},"required":["authority_data_requestId","customer_number","mandate_name","mandate_name_year"]}},"required":["bank-id","authority_data_request"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/trn.34.my.strings/ObpActivity":{"get":{"tags":["_Obp Activity(trn.34.my.strings)","Dynamic-Entity","Dynamic"],"summary":"Get Obp Activity List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Obp Activity List.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"ObpActivity" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /ObpActivity?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Obp Activity.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"ObpActivity" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createObpActivity_trn.34.my.strings","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["name","username","created_date"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obpActivityId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obpActivityId","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/trn.34.my.strings/ObpActivity/OBP_ACTIVITY_ID":{"delete":{"tags":["_Obp Activity(trn.34.my.strings)","Dynamic-Entity","Dynamic"],"summary":"Delete Obp Activity by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Obp Activity by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"ObpActivity" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteObpActivity_trn.34.my.strings","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["name","username","created_date"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obpActivityId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obpActivityId","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Obp Activity(trn.34.my.strings)","Dynamic-Entity","Dynamic"],"summary":"Get Obp Activity by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Obp Activity by id.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"ObpActivity" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleObpActivity_trn.34.my.strings","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obpActivityId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obpActivityId","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Obp Activity(trn.34.my.strings)","Dynamic-Entity","Dynamic"],"summary":"Update Obp Activity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Obp Activity.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"ObpActivity" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateObpActivity_trn.34.my.strings","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["name","username","created_date"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obpActivityId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obpActivityId","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/test-dynamic-resource-doc/my_user/MY_USER_ID":{"post":{"tags":["Dynamic-Resource-Doc"],"summary":"A test endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"A test endpoint.
Just for debug method body of dynamic resource doc.
better watch the following introduction video first
* Dynamic resourceDoc version1
The endpoint return the response from PractiseEndpoint code.
Here, code.api.DynamicEndpoints.dynamic.practise.PractiseEndpoint.process
You can test the method body grammar, and try the business logic, but need to restart the OBP-API code .
Authentication is Optional
","operationId":"test-dynamic-resource-doc","parameters":[{"in":"body","name":"body","description":"RequestRootJsonClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/RequestRootJsonClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/RequestRootJsonClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"JvalueCaseClass":{"required":["jvalueToCaseclass"],"properties":{"jvalueToCaseclass":{"type":"object","properties":{"transferData":{"type":"string","example":""},"usInfo":{"type":"object","properties":{"periodId":{"type":"string","example":"periodId"},"periodType":{"type":"string","example":"periodType"},"payerInfo":{"type":"object","properties":{"payorId":{"type":"string","example":"payorId"},"payorIdType":{"type":"string","example":"N"}},"required":["payorId","payorIdType"]},"formCode":{"type":"string","example":"formCode"},"year":{"type":"integer","format":"int32","example":"6026"},"obligationId":{"type":"string","example":"obligationId"}},"required":["periodId","periodType","payerInfo","formCode","year","obligationId"]},"tppTransactionId":{"type":"string","example":"tppTransactionId"},"system":{"type":"string","example":"Elixir"},"sender":{"type":"object","properties":{"nameAddress":{"type":"object","properties":{"value":{"type":"array","items":{"type":"string","example":"value"}}},"required":["value"]}},"required":["nameAddress"]},"deliveryMode":{"type":"string","example":"ExpressD0"},"recipient":{"type":"object","properties":{"nameAddress":{"type":"object","properties":{"value":{"type":"array","items":{"type":"string","example":"value"}}},"required":["value"]}},"required":["nameAddress"]},"executionMode":{"type":"string","example":"Immediate"},"requestHeader":{"type":"string","example":""},"hold":{"type":"boolean","example":"true"}},"required":["transferData","usInfo","tppTransactionId","system","sender","deliveryMode","recipient","executionMode","requestHeader","hold"]}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}},"ErrorUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50000: Unknown Error."}}},"RequestRootJsonClass":{"required":["name","age","hobby"],"properties":{"name":{"type":"string","example":"ACCOUNT_MANAGEMENT_FEE"},"age":{"type":"integer","format":"int64","example":"18"},"hobby":{"type":"array","items":{"type":"string"}}}}}}