Guides

Bank Statement

Get bank statement

Suggest Edits

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:

  1. 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.
  2. 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.
  3. 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

KeyDescription
app-idYour App ID
x-api-keyYour Secret Key

Body

INITIATE CONSENT BODY

KeyDescription
account_noAccount Number
bankName of Bank

FINALIZE CONSENT BODY

KeyDescription
account_noAccount Number
bankName of Bank
referenceUnique reference number
otpThe One-Time-Password sent to user

GENERATE STATEMENT BODY

KeyDescription
account_noAccount Number
bankName of Bank
start_dateStart date of Statement
end_dateEnd 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)

ResponseDescription
stateBoolean value indicating the state of the response.
response_codeRepresents the response code.
dataAn object containing additional data related to the verification.
data.account_typeA string indicating the type of the bank account.
data.account_nameA string containing the name associated with the bank account.
data.referenceA string representing a unique reference or identifier associated with the bank statement.
service_providerA string indicating the name of the service provider or bank providing the response.

Response Description (FINALIZE CONSENT)

ResponseDescription
statusIndicates that the request was successful.
response_codeRepresents the response code.
dataAn object containing additional data related to the verification.
messageA detailed message indicating that User's subscription is validated successfully
service_providerA string indicating the name of the service provider or bank providing the response.

Response Description (GENERATE STATEMENT)

ResponseDescription
responseCodeA string representing the response code for the transaction.
responseDescriptionA description of the response generated.
oTransListAn array of transaction objects.
valDateThe value date of the transaction.
intDateThe interest date of the transaction.
traAmtThe transaction amount.
curCodeThe currency code (e.g., "NGN" for Nigerian Naira).
remarksAdditional remarks or description of the transaction.
drCrDescIndicates if it is a debit ("D") or credit ("C") transaction.
balAfterThe account balance after the transaction.
docNumDocument number associated with the transaction.
traDateThe transaction date.
explEngExplanation or category of the transaction.

Updated about 1 year ago