Bank Statement
Get bank statement
This API provides merchants with the capability to access comprehensive and precise bank account statements. The integration of this API into their systems enables merchants to retrieve detailed information regarding bank transactions, balances, and other related data pertaining to their customers' accounts at Providus Bank.
The process of accessing these bank account statements involves three distinct stages:
- Initiate Consent: This initial step involves initiating the consent request. The merchant's system sends a request to the API, indicating the intention to retrieve bank account statements. This request typically involves inputing the user's account name and bank.
- Finalize Consent: During this stage, the merchant is required to provide additional information to finalize the consent process. This may include inputting a reference number associated with the consent request and an OTP (One-Time Password) that is sent to the user for verification purposes. These steps ensure the authenticity and authorization of the consent.
- Generate Statement: Once the customer's consent has been successfully obtained and finalized, the merchant proceeds to input the desired start date and end date for the statement they wish to generate. This allows them to specify the time period for which they require the bank account statement.
Note
It is important to note that these processes are specifically designed for accessing bank account statements from Providus Bank
TEST DATA
INITIATE CONSENT
account_no: 1010101010
bank: providus
FINALIZE CONSENT
account_no: 1010101010
bank: providus
otp: 123456
reference: 123456
GENERATE STATEMENT
account_no: 1010101010
bank: providus
start_date: 01-03-2023
end_date: 01-05-2023
POST
Initiate Consent: {{URL}}/identitypass/statement/consent/initiate
Finalize Consent: {{URL}}/identitypass/statement/consent/finalize
Generate Statement: {{URL}}/identitypass/statement/generate
Header
| Key | Description |
|---|---|
| app-id | Your App ID |
| x-api-key | Your Secret Key |
Body
INITIATE CONSENT BODY
| Key | Description |
|---|---|
| account_no | Account Number |
| bank | Name of Bank |
FINALIZE CONSENT BODY
| Key | Description |
|---|---|
| account_no | Account Number |
| bank | Name of Bank |
| reference | Unique reference number |
| otp | The One-Time-Password sent to user |
GENERATE STATEMENT BODY
| Key | Description |
|---|---|
| account_no | Account Number |
| bank | Name of Bank |
| start_date | Start date of Statement |
| end_date | End date of Statement |
"INITIATE CONSENT" Response
{
"state": true,
"response_code": "00",
"data": {
"account_type": "INDIVIDUAL",
"account_name": "John Doe",
"reference": "123456"
},
"service_provider": "PROVIDUS"
}
"FINALIZE CONSENT" Response
{
"status": true,
"response_code": "00",
"data": {
"message": "User's subscription validated successfully !!!"
},
"service_provider": "PROVIDUS"
}
"GENERATE STATEMENT" Response
{
"responseCode": "00",
"responseDescription": "Generation successful",
"oTransList": [
{
"valDate": "2023/Apr/28",
"intDate": "2023/Apr/28",
"traAmt": "80",
"curCode": "NGN",
"remarks": "SMS ALERT CHARGE for 1st - 28thAPR 2023",
"drCrDesc": "D",
"balAfter": "169349.91",
"docNum": "0",
"traDate": "2023/Apr/28",
"explEng": "MISC."
},
{
"valDate": "2023/Apr/27",
"intDate": "2023/Apr/27",
"traAmt": "10000",
"curCode": "NGN",
"remarks": "Mob: Airtime",
"drCrDesc": "D",
"balAfter": "169429.91",
"docNum": "0",
"traDate": "2023/Apr/27",
"explEng": "ACCOUNT TRANSFERS"
}
]
}
Response Description (INITIATE CONSENT)
| Response | Description |
|---|---|
| state | Boolean value indicating the state of the response. |
| response_code | Represents the response code. |
| data | An object containing additional data related to the verification. |
| data.account_type | A string indicating the type of the bank account. |
| data.account_name | A string containing the name associated with the bank account. |
| data.reference | A string representing a unique reference or identifier associated with the bank statement. |
| service_provider | A string indicating the name of the service provider or bank providing the response. |
Response Description (FINALIZE CONSENT)
| Response | Description |
|---|---|
| status | Indicates that the request was successful. |
| response_code | Represents the response code. |
| data | An object containing additional data related to the verification. |
| message | A detailed message indicating that User's subscription is validated successfully |
| service_provider | A string indicating the name of the service provider or bank providing the response. |
Response Description (GENERATE STATEMENT)
| Response | Description |
|---|---|
| responseCode | A string representing the response code for the transaction. |
| responseDescription | A description of the response generated. |
| oTransList | An array of transaction objects. |
| valDate | The value date of the transaction. |
| intDate | The interest date of the transaction. |
| traAmt | The transaction amount. |
| curCode | The currency code (e.g., "NGN" for Nigerian Naira). |
| remarks | Additional remarks or description of the transaction. |
| drCrDesc | Indicates if it is a debit ("D") or credit ("C") transaction. |
| balAfter | The account balance after the transaction. |
| docNum | Document number associated with the transaction. |
| traDate | The transaction date. |
| explEng | Explanation or category of the transaction. |
Updated over 1 year ago