This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.
Request Payload Validation for UK
Request Payload Validation adds flexibility to validate an incoming request against any customisations done to the swagger definition. For example, remove an enumeration from an existing set and check whether the incoming request contains the defined enumerations.
According to the following sample payload, the given account number formats are accepted.
If your API supports only the UK.OBIE.IBAN
and UK.OBIE.SortCodeAccountNumber
account number formats, you can simply modify the published swagger file and republish the API for the modifications to take effect.
When an API is published, the swagger file is added as a local entry and saved under the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/local-entries
directory.
To add the swagger as a local entry, the created and published API lifecycles are extended using customised API executor named com.wso2.finance.open.banking.api.executor.OBAPIPublisherExecutor
. For more information on executors, see Extension Points of API Life cycle.
You need to republish the API to apply the swagger based validations. Therefore, follow the steps below:https://<WSO2_OB_APIM_HOST>:9443/publisher
using the credentials of a user, whose role is an API Publisher. For more information on users and roles, see here.