Account Statement

This Webhook is used to retrieve the account statement and the latest balance of the account held by the user.

Request

You must add a accountStatement callback URI to the webhook profile to receive requests from us.

Parameters

Parameter
Type
Description

data

Object

mobile

String

Mobile number of user. Character length : 10 Eg: 9876543210

country_code

String

Country code for the mobile number. Character length : 2 Eg: 91

account_number

String

The account number of the requesting user. Eg: 3988762547321

branch_code

String

Branch code holding account number in the entity. Eg: BR001

start_date

String

Start date of account statement details.

Format: YYYY-MM-DD Eg: 2020-11-01

end_date

String

End date of account statement details.

Format: YYYY-MM-DD Eg: 2020-11-31

INFO

The maximum difference between start_date and end_date is 365 days. i.e. 1 year.

Request format

{
    "head": {
        "api": "accountStatement",
        "apiVersion": "V1",
        "timeStamp": "2022-11-11 07:04:37 AM"
    },
    "encrypted_data": {
        "cipher_text": "wpfVRm9eYVuFbCraLswKV/nHMOmBI9xMCiycizLDa7W9IEoQvJ5ihQykyRnZURthAReDOCpnwqAuXLk7c2QVcwbDzfxg/P8nflafaI8jT/CVxn/NlE7XCYPoiHcCr0sjdxvFYgX0p21eCsb3/LACYXw7cMfdv6hL62mTG1d9TyZ5+BgMnB32YqydBhjdQX4OJ3FmiC3Km3PigvpD0iKT4nyB6axefYRCekffluL0+40=",
        "iv": "e81c22a91b173b28",
        "hash": "bade372d33876a16491ba9921ec9752b500cc728590bfa7e7461a41964cdca63"
    }
}

Response

MANDATORY

All parameters in the response are required to proceed.

INFO

If no transaction is found/ failed to fetch for any reason, the balance_amount in the response must be 0 (zero).

WARNING

The transactions array includes all transactions between the shared dates of the account.

The transactions array should be empty if there are no transactions associated with the respective account.

Parameters

Parameter
Type
Description

head

Object

HTTP_CODE

Integer

result

Object

code

Integer

status

String

The status against the request. Allowed values: SUCCESS, FAILED

account

Object

account_number

String

The same account number shared to receive the statement. Eg: 3988762547322

branch_code

String

The same branch code shared to receive the statement. Eg: BR001

balance_amount

String

The latest balance amount in the respective account number. Eg: 123456.00

start_date

String

The same start date shared to receive the statement. Format: YYYY-MM-DD Eg: 2020-11-01

end_date

String

The same end date shared to receive the statement. Format: YYYY-MM-DD Eg: 2020-11-31

transactions_count

String

The total count of transactions array. Eg: 2

transactions

Array of Objects

txn_id

String

Unique ID saved for the transaction. Eg: 1a21s5s65f32s13d54as

date

String

The transaction date. Format: YYYY-MM-DD Eg: 2020-11-31

time

String

The transaction time. (hh:mmA) Eg: 02:30AM

debit_amount

String

In case of a withdrawal, the withdrawal amount for the transaction ID. Eg: 1200.00

credit_amount

String

In case of a deposit, the deposit amount for the transaction ID. Eg: 600.50

balance

String

The balance amount after the deposit or withdrawal to the transaction ID. Eg: 1800.50

description

String

Note or description of each transaction Eg: Cash Self Deposit

Response format

{
    "head": {
        "api": "accountStatement",
        "apiVersion": "V1",
        "timeStamp": "2022-11-11 07:04:37 AM",
        "HTTP_CODE": 200
    },
    "encrypted_data": {
        "cipher_text": "UdB2DW6hp5EEVWaiR+bSh5uN1qzYGra4wh4XR1DU3idltQfB8DUxPFijyUprm45oUdSvuJhj3g60Y28m6epHIODY1O7+DYcaPSfpPLoDRcmDEGXpm0/WMRtCSj8yyG4onmVWeclbaD/hCb1Fl0dTY+LQvJnTaqtb+ZyCq5wXzmZ4ZwZfHYvpYQL5eSoUSvoWYHcmTbK08E3fpuEmrC3Hz9E+yIodwBRnnUyeaPoYnHkcdmsAURNWhNPmWe5WmIVrLksBWkJP/kkNh7NjzOk3Cgk8CBZXYebl53GagWsuS0w0CXxKWL2XBEJjcxXQwwqw8fqQ0g9oPAOL0xFPCPEwQNOyY7OfYl/iyZzxFlQVAVqv30axmHPbA+FiW+v4JTeWhH5TITAnSz09XZgBuZZyRejkR1nFl60zZnK6/f7tGNpki8GpTYJnRVYaX6RBdYrE7QUJrIt5npQyKC9Lfowv0bhugq97X0GhdNHGYFa/jQAS7sgxZyPhvT05fL/CgHEs0NDXhtBX4zeq5rMY3rox1bS8UqYDdbtC/ObqwRiVcAIwTlfQNr7wgaKGaliFlGX/T4XB7lc+TWJ7F2TQIStEk6dWXQwNLif6B9VFMTK00Yuff2bYW7BAMxbRBAYLCuBmChSqFOFm8aS1ST5Lcf1YqP7HzA4jJs5j2SmMJjvEoNHiQA+LTGU8Ppf1VIz158b2PKbx8pDau16sOgoiS95Y2/Ri6M2+XqEootjxmq1RxqSvsdn98OeB+j4btyOukms0zWblNpTVBcUAk8jL6N+r20a/N0q5krO15u6KAWQMD6BcD3eTfwIlMy7UecjWHFKyzBnucut/cUSkmFDPG6W/1Q==",
        "iv": "b2c52e5178f301f4",
        "hash": "cfaf6934f964e90030b2e981aa18c03c5975a5c87001bc8a1839fd656e06d7fe"
    }
}

Result Code

Success

  • 1001 - SUCCESS

Failed

  • 2021 - Invalid account

  • 2022 - Account number and mobile number do not match

Last updated