Skip to content

Conversation

@ankita10r
Copy link
Contributor

@ankita10r ankita10r commented Sep 1, 2023

Description

Fixing Bulk Account Lookup API for compliance.
Below is the expected spec:

  1. Bulk Account Lookup API

Description This API is to be invoked by the Source BB to the Payments BB incase if the Source BB (SBB) does not receive some completed transactions in bulk payment status updates callback or batch by batchId polling from the Payments BB. Then SBB can run query for single beneficiary payment status check.
Client Source BB
Server Payments BB
Method PUT
Endpoint {{IdentityAccountMapperHostName}}/beneficiary
Headers Field
  X-Callback_URL
  registeringInstitutionId
Request Body Parameters Field
requestId String(12)
  payeePartyIds
Sample Request Body {"requestId": "12232324457","payeeIdentities": ["4543545454","234354656563"]}
Response Parameters Field
requestId String
paymentModalityList Array
Sample Response Body (Success) {"requestId": "123456","paymentModalityList": [{"payeeIdentity": "514985841480405494612","paymentModality": "0","financialAddress": "998LB283697636447147812564357","bankingInstitutionCode": "123456888"},{"payeeIdentity": "5149858414804053456","paymentModality": "1","financialAddress": "998LB2836976364477","bankingInstitutionCode": "123445677"}]}

Assumption: API spec change does not include change in business logic or consumer points

Checklist

Please make sure these boxes are checked before submitting your pull request - thanks!

  • Design related bullet points or design document link related to this PR added in the description above.

  • Updated corresponding Postman Collection or Api documentation for the changes in this PR.

  • Create/update unit or integration tests for verifying the changes made.

  • Add required Swagger annotation and update API documentation with details of any API changes if applicable

  • Followed the naming conventions as given in https://docs.google.com/document/d/1Q4vaMSzrTxxh9TS0RILuNkSkYCxotuYk1Xe0CMIkkCU/edit?usp=sharing

@ankita10r ankita10r requested a review from apurbraj September 1, 2023 07:59
public interface BatchAccountLookupApi {
@PostMapping("/accountLookup")
ResponseEntity<ResponseDTO> batchAccountLookup(@RequestHeader(value="X-CallbackURL") String callbackURL, @RequestBody RequestDTO requestBody, @RequestHeader(value = "X-Registering-Institution-ID") String registeringInstitutionId) throws ExecutionException, InterruptedException;
@PutMapping("/beneficiary")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PUT /beneficiary endpoint is already used for Update beneficiary API

AccountLookupService accountLookupService;
@Override
public ResponseEntity<ResponseDTO> batchAccountLookup(String callbackURL, RequestDTO requestDTO, String registeringInstitutionId) throws ExecutionException, InterruptedException {
public ResponseEntity<ResponseDTO> batchAccountLookup(String callbackURL, BatchAccountLookupRequestDTO requestDTO, String registeringInstitutionId) throws ExecutionException, InterruptedException {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This API is async so we have to return RequestDTO, BatchAccountLookupRequestDTO will be sent in callback

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants