Extensibility and Code Conventions

7 Extensibility and Code Conventions

Code Convention of Account API’s

Accounts related API should use below arguments and return type for working with UK Open Banking

Arguments

SessionContext sessionContextcom.ofss.digx.app.openbanking.dto.
accounts.uk.AccountRequestDTO accountRequestDTO

Return Type

BaseResponseDTO<T>Where T extends DataTransferObject

Any service implemented with the above type of argument will be compatible with UK Open Banking.

Code Convention of Payment API’s

Payment related API should use below arguments and return type for working with UK Open Banking

Arguments

Create and Read Method
SessionContex sessionContext

Any DTO Object which extends com.ofss.digx.app.openbanking.dto.consent.uk.UKPaymentDTO

Any service implemented with the above type of argument will be compatible with UK Open Banking.

Error Message Framework

The Error Message Framework helps convert the OBAPI error response according to the UK Open Banking Specifications.

The error response structure for Open Banking Read/Write APIs is as follows:

{  "Code": "...",  "Id": "...",  "Message": "...",  
        "Errors": [    
            {      "ErrorCode": "...",      
                    "Message": "...",      "Path": "...",      
                    "Url": "..."    
            }  
                  ]
        }

The UK Open Banking specified error response is handled using DIGX_OB_UK_OBAPI_ERROR_MAP table.

The contents of the table are as follows:

Column Name	Description
`DIGX_ERROR_CODE`	Represents the OBAPI error codes. This is a Primary and Unique Key
`UK_ERROR_CODE`	Represents the Open Banking specified error code
`PATH`	Represents the reference to the JSON Path of the field with error. Can be null.
`URL`	Represents the URL to help remediate the problem, or provide more information etc. Can be null.

For mapping OBAPI error codes with UK Open Banking specified codes below script can be used:

Insert into DIGX_OB_UK_OBAPI_ERROR_MAP (DIGX_ERROR_CODE,UK_ERROR_CODE,PATH,URL)
values('%%OBAPI Error Code%%',%%Open Banking specified error code%%', '%%Path%%','%%URL%%');

For example

Insert into DIGX_OB_UK_OBAPI_ERROR_MAP (DIGX_ERROR_CODE,UK_ERROR_CODE,PATH,URL)
values ('DIGX_OB_0010','UK.OBIE.Field.Missing', 'Data.Initiation ',null);

Below Query is used to check the OBAPI errors mapped with UK Open Banking specified error codes in the system

select * from DIGX_OB_UK_OBAPI_ERROR_MAP;

For configuring HTTP status codes with custom message, below script can be used:

Insert into DIGX_FW_CONFIG_ALL_B (PROP_ID, CATEGORY_ID, PROP_VALUE, FACTORY_SHIPPED_FLAG,
PROP_COMMENTS, SUMMARY_TEXT, CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATED_DATE,
OBJECT_STATUS,OBJECT_VERSION_NUMBER)

values ('%%HTTP Status code%%','OpenBankingErrorConfig', '%%Error Message%%','N',null,
'OpenBanking Error Message','ofssuser',sysdate,'ofssuser',sysdate,'Y',1);

Below Query is used to check the Open Banking HTTP status codes in the system

select * from digx_fw_config_all_b where category_id = ' OpenBankingErrorConfig';

Permission Response Handler

Permissions is used in only Account API’s. Based on Permissions, Response is generated based on permissions.

OBAPI consists of Permission Handler against each type of permissions. This configuration is availble in the table DIGX_OB_UK_PERMISSIONS_PRIMARY.

The contents of the table are as follows:

Column Name	Description
`SERVICEID`	Represents the OBAPI Service Id for which the permission and its handler is available
`PERMISSION`	Represents Permission
`RESPONSEHANDLER`	Represent Permission Handler

Permission Handler can be overriden or can be newly introduced. This will be required for additional fields mapping which is not available OOTB. Steps for the same are as follows

Introducing Permission Handler

New Permisison Handler should implement interface IResponseHandler

New Permission Handler should have below methods

public static <T implements IResponseHandler> getInstance()

public <T extends DataTransferObject> assembleResponse(DataTransferObject object, List<String> permissions) – This method assembles response from object to the require response object which needs shown in the API response. Object is the response got from base sevice and T will be the response object require by API specifications. Assembling of the values will be done this method

public int getPriority() – This defines the high priority of the handler to be applied for assembling response in case of permissions and its handler has been consented by the user i.e. Basic and Detail permission will have different handlers but if the consent is both the permisison the priority of the handler will decide which needs to be executed on high priority.

Key Providers support