Scribd
Upload
8 views3 pages

MyBankStatementEchannels Documentation

Uploaded by

Raji Babatunde
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
8 views3 pages

MyBankStatementEchannels Documentation

Uploaded by

Raji Babatunde
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 3

MY BANK STATEMENT E-CHANNELS INTEGRATION

DOCUMENTATION
1. Authorization: SWAGGER URL http://172.31.250.7:8080/mbsEchannels/swagger-
ui.html#/security45controller

The endpoint above generates a token which will be passed as Header on all requests
APPID: testApp
APP SECRET: IiZHg3rMywzIA1TYGBIS

2. To initiate a request for a customer’s statement, a first call should be made to


<GenerateStatement>

SWAGGER URL:
http://172.31.250.7:8080/mbsEchannels/swagger-ui.html#!/my45bank45statement45con
trollers/generateStatementUsingPOST

Here is a sample request payload


{ "accountNo": "1990022228", "debitAccountNo": "1990022228", "startDate":
"06-JAN-2022", "endDate": "08-JUL-2022", "destinationId": "1", "appId": "IB",
"countryCode": "1", "applicants": [ { "name": "INNOCENT OBEYA" } ] }

 destinationId - SWAGGER URL: http://172.31.250.7:8080/mbsEchannels/swagger-


ui.html#!/my45bank45statement45controllers/getDestinationsUsingGET

SAMPLE RESPONSE: {
"status": 200,
"message": "SUCCESS",
"result": [
{
"name": "Sterling Bank",
"category": "Commercial Bank",
"categoryId": "1",
"destinationId": 1
},
...
]

 appId - Unique channel ID - “IB”, “MOB”, “USSD”


 countryCode – SWAGGER URL:
http://172.31.250.7:8080/mbsEchannels/swagger-
ui.html#!/my45bank45statement45controllers/
getCountriesUsingGET

SAMPLE RESPONSE: {
"status": 200,
"message": "SUCCESS",
"result": [
{
"countryCode": "BF",
"country": "Burkina Faso"
},
]
}

The updateSigReq should be "YES" or "NO"

passing in the required parameters will generate the statement, and billing details returned.
The details can be displayed to the customer for acceptance. Once the customer is set to
proceed.

See a sample response below

{
"status": 200,
"message": "SUCCESS",
"result": {
"amount": 0.0,
"currency": "NGN",
"ticketNo": "1000011-36",
"noOfPages": 29
}
}

3. Make a call to the <SendStatement> endpoint which will debit the customer for the
statement charges,

SWAGGER URL:
http://172.31.250.7:8080/mbsEchannels/swagger-ui.html#!/my45bank45statement45con
trollers/sendStatementUsingPOST

send the statement to the destination and return a ticket Number for the request and a
base-64 encoded string.

This can then be converted into a file and made available for the customer to download. A
ticket notification will also be sent to the customer’s registered email address and phone
number.

See sample response

{ "status": 200, "message": " SUCCESS ", "result": { "ticketNo": "1234567-3", "password":
"1234", "ticket": "base64 ticket" } }

4. To initiate a reference letter request, a call should be made to the <GetLetterType> endpoint
to list the available letter types and their charges.

SWAGGER URL:
http://172.31.250.7:8080/mbsEchannels/swagger-ui.html#!/my45bank45statement45con
trollers/generateReferenceLetterUsingPOST

SAMPLE RESPONSE
{“status": 200, "message": "SUCCESS", "result": { "amount": 1311.5, "currency": "NGN",
"ticketNo": "1234567-3", "noOfPages": 5 } }

The customer can then be charged for the selected letter type.

5. Call the <SendReferenceLetter> to take the charge and send the letter to the destination.
SWAGGER URL:
http://172.31.250.7:8080/mbsEchannels/swagger-ui.html#!/my45bank45statement45con
trollers/sendReferenceLetterUsingPOST

SAMPLE RESPONSE
{ "status": 200, "message": " SUCCESS ", "result": { "ticketNo": "1234567-3", "password":
"3539", "ticket": "base64 ticket" } }
As you can see above, the endpoint also returns a ticket number for the request as a base
64 string which can be converted to a file and displayed to the customer.

You might also like