Add Account

This API is used to add new accounts and update the latest status of existing user accounts.

MANDATORY

Method: POST

API URL: BASE_URL/account/add

INFO

Entity can trigger this API to update the latest status of existing accounts without the support of Account Fetch webhook.

Request

MANDATORY

All parameters in the request are required to proceed.

WARNING

The request should be in a array and include all the accounts of the user in the entity.

Parameters

Parameter Type Description

Parameter	Type	Description
head	`Object`
API_ID	`String`	Unique ID generated from the dashboard. Eg: 1a21as51a351f1155f
API_KEY	`String`	Unique KEY generated from the dashboard. Eg: AAD5451FS654SD6F5SD46F3S1D5S

result	`Object`
code	`Integer`	Result code for the response. Find result codes
status	`String`	The status against the request. Allowed values: `SUCCESS` , `FAILED`

user	`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

accounts	`Array of Objects`
branch_code	`String`	Branch code where the account is maintained. Character length : 02 (Min), 12 (Max) Eg: BR001
branch_name	`String`	Name of the branch where the account is maintained. Character length : 04 (Min), 20 (Max) Eg: KOCHIN MAIN
account_name	`String`	Name of the account holder registered with the entity. Character length : 30 (Max) Only UPPERCASE letters are allowed. Eg: RAJESH KJ
account_number	`String`	User account number. Character length : 04 (Min), 20 (Max) Eg: 123456789
account_type	`String`	This helps to identify the type of account. Refer Allowed values: `SA`, `CA`, `TL`, `OD` Eg: `SA`
account_class	`String`	Classification of account under account_type. Character length: 30 (Max) Eg: AGRICULTURAL LOAN
account_status	`String`	Current status of account. Refer Possible values: `ACTIVE`, `INACTIVE`, `BLOCKED`, `CLOSED` Eg: `ACTIVE`
account_opening_date	`String`	Date of opening the account from the branch. Format: YYYY-MM-DD Eg: 2020-11-20
account_currency	`String`	Currency for transactions. Refer Possible values: `INR` Eg: `INR`
account_daily_limit	`String`	Maximum amount that can be transferred through NEFT/ RTGS/ IMPS/ UPI. Character length : 6 (Max) [I.e. 999999] Eg: 44999
auth_salt	`String`	Salt value for hashing the authentication pin for debit transactions. [Applies to high-level configuration only.] Character length : 32 (Max) Eg: abcdefghi1234567abcdefghi1234567
is_debit_allowed	`Boolean`	If debit transactions are not allowed for the account, keep it `false`. Default value is `true`. Possible values: `true`, `false` Eg: true
is_credit_allowed	`Boolean`	If credit transactions are not allowed for the account, keep it `false`. Default value is `true`. Possible values: `true`, `false` Eg: true
is_cash_debit_allowed	`Boolean`	If the account does not allow cash-based WITHDRAWALS, keep it `false`. Default value is `true`. Possible values: `true`, `false` Eg: true
is_cash_credit_allowed	`Boolean`	If the account does not allow cash-based DEPOSITS, keep it `false`. Default value is `true`. Possible values: `true`, `false` Eg: true

head

Object

API_ID

String

Unique ID generated from the dashboard. Eg: 1a21as51a351f1155f

API_KEY

String

Unique KEY generated from the dashboard. Eg: AAD5451FS654SD6F5SD46F3S1D5S

result

Object

code

Integer

Result code for the response. Find result codes

status

String

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

user

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

accounts

Array of Objects

branch_code

String

Branch code where the account is maintained. Character length : 02 (Min), 12 (Max) Eg: BR001

branch_name

String

Name of the branch where the account is maintained.

Character length : 04 (Min), 20 (Max) Eg: KOCHIN MAIN

account_name

String

Name of the account holder registered with the entity. Character length : 30 (Max) Only UPPERCASE letters are allowed. Eg: RAJESH KJ

account_number

String

User account number. Character length : 04 (Min), 20 (Max) Eg: 123456789

account_type

String

This helps to identify the type of account. Refer

Allowed values: SA, CA, TL, OD

Eg: SA

account_class

String

Classification of account under account_type. Character length: 30 (Max) Eg: AGRICULTURAL LOAN

account_status

String

Current status of account. Refer Possible values: ACTIVE, INACTIVE, BLOCKED, CLOSED

Eg: ACTIVE

account_opening_date

String

Date of opening the account from the branch. Format: YYYY-MM-DD Eg: 2020-11-20

account_currency

String

Currency for transactions. Refer

Possible values: INR Eg: INR

account_daily_limit

String

Maximum amount that can be transferred through NEFT/ RTGS/ IMPS/ UPI. Character length : 6 (Max) [I.e. 999999] Eg: 44999

auth_salt

String

Salt value for hashing the authentication pin for debit transactions. [Applies to high-level configuration only.]

Character length : 32 (Max) Eg: abcdefghi1234567abcdefghi1234567

is_debit_allowed

Boolean

If debit transactions are not allowed for the account, keep it false. Default value is true. Possible values: true, false

Eg: true

is_credit_allowed

Boolean

If credit transactions are not allowed for the account, keep it false. Default value is true. Possible values: true, false

Eg: true

is_cash_debit_allowed

Boolean

If the account does not allow cash-based WITHDRAWALS, keep it false. Default value is true.

Possible values: true, false

Eg: true

is_cash_credit_allowed

Boolean

If the account does not allow cash-based DEPOSITS, keep it false. Default value is true.

Possible values: true, false

Eg: true

Request format

{
    "head": {
        "api": "accountAdd",
        "apiVersion": "V1",
        "timeStamp": "2022-11-10 03:21:19 PM",
        "auth": {
            "API_ID": "6360b30096066b82e9697996",
            "API_KEY": "b54996b0-59a8-11ed-911b-87fca52fd2dc"
        }
    },
    "encrypted_data": {
        "cipher_text": "hDLsE1qBGwbHRxdcLy18c+fasWaEl/EvlVqum4f+ZkCbkcdNGWgLNSqD/Bz+wjOPX0WGkihxeyst9zPoXCUS8FWaTCFEOs2oPpW3gGmqIdBnVe7JMkqiEZ0pP207fcK5KSgBHt4u6EHeVqm07gTfHpadanMC7Am/4yI/bDgayOa4Mwsm1yfVSF5oBbYFZ+mDLwKLn+XoItg279vVxsbfFUV5TJbiE9TVOUlMpZCmqXOKPMz60CbaQ3YXQ3ky+npZXJFie1yDOSa4X2YOCoWrFLq1Z4tI7XTPyr0MaYPJ477gMXrgrjFrfwN77SEsEpGQcbWYIZm/tY3JtNCYXoVg5S0C2m+RoUX7AyB+gVIoLsScVFKXdLczCxb4K8zDUhFnDzuwbFGpI4Wv6umBOgi7d0BWVR0cn57x1hxG6YqwP2pMm+j9NDrxhTP32yLPc/HkKzk8traqFtVpBinEPSZa5FVuR+f0gplPucIn4YkRHRKcZHX7+PbmX3TVkaoGiXK93GmLI+N/Y/Le2rsOit3cCtAZMG/Jb1yOFL09OLMEnrkRDUvvK6z6GIfOviglh2zB+7OqHQ57rymK0lAgZQN3UupWM157QtjobNysQguiGV/oh4uGQR+SMzegmP6uAFQ1edtWCQUPV58hgWPLfXp47wqsPztlk7PZJoOTHFhpD1VVDRLixGUaWR0kgSN3YxMe+3uGgjTtgk4HXjchMBQ61OPNLcnOddZxe8Eju+Ldo2mbJDR6PREzqLsCYFHIucCEJBjCwwVIFrwRgsXQ7FR0MkqC26JgGmb6r2mSUEdscT+kQnb3t3Lu+RiVfoS9UJ3C/p+DS/zFSIYwLN3odofgbXKsRsdgVbW957LL9WaZDL1b+ADF0+m4VqxjecxtOdMLNKVfHeS917B51aMsWjOam7ysKVJG3gZJe8KMAIibVN3TgC5tsClS1ok8Cbt76m7cn+CLBQIvVzB8WIZ3BG+5YJwuHJLUL/a1h+mVuuzSDUef85dVHjvRJ/OmMqeRtaYhpF3pDfwerL74KIDMGGugD699rtoN+DCbivaWw/OgLu2AG9L+zTlZsTEUKuJLmWm7bZH+XfKG26jwctX9MYFFvnKrkBwz6fMZmp1adzOaJZUtg5TUV93fuusIpAJkUu28mY7lo7mTa8FjtnGBuudLufw0louuS2nLciBSSdjxEJ2uaNHFWXCvDyONW6e8ucX+HK3eYLqC8hIuyYm4nKEKwwIL+Lau8sYKk70+nhlH4WKIOnPG8Q+Lq+zCC6Ub5nsma7fg+s0PsffHa8Dw6YR3b2P14GzOmgpr3iunUbKXgYLa20bEfiy3OQgCr3/96fcewiX8+4Sc1Yoa3YVqdTOo3+2eCh1EEjOdc60bnmujQ7w=",
        "iv": "9ab6320a60d0d1cb",
        "hash": "6a06e43a0f5cf384846da5b786e71e548e49066a8812aef05686f7de486c9c57"
    }
}

{
    "head": {
        "api": "accountAdd",
        "apiVersion": "V1",
        "timeStamp": "2022-11-10 03:21:19 PM",
        "auth": {
            "API_ID": "6360b30096066b82e9697996",
            "API_KEY": "b54996b0-59a8-11ed-911b-87fca52fd2dc"
        }
    },
    "content": {
        "result": {
            "code": 1001,
            "status": "SUCCESS",
            "message": "The request is successfully processed"
        },
        "data": {
            "user": {
                "country_code": "91",
                "mobile": "9876543210"
            },
            "accounts": [
                {
                    "account_name": "FASIL",
                    "account_number": "5004880334479",
                    "branch_code": "BR001",
                    "branch_name": "KANNUR",
                    "account_type": "SA",
                    "account_class": "SAVING",
                    "account_status": "ACTIVE",
                    "account_opening_date": "2020-01-01",
                    "account_currency": "INR",
                    "account_daily_limit": "5000",
                    "is_debit_allowed": true,
                    "is_credit_allowed": true,
                    "is_cash_debit_allowed": true,
                    "is_cash_credit_allowed": true,
                    "auth_salt": "abcdefghi1234567abcdefghi1234567"
                },
                {
                    "account_name": "FASIL",
                    "account_number": "8758900103403",
                    "branch_code": "BR001",
                    "branch_name": "KANNUR",
                    "account_type": "SA",
                    "account_class": "SAVING",
                    "account_status": "ACTIVE",
                    "account_opening_date": "2020-01-01",
                    "account_currency": "INR",
                    "account_daily_limit": "5000",
                    "is_debit_allowed": true,
                    "is_credit_allowed": true,
                    "is_cash_debit_allowed": true,
                    "is_cash_credit_allowed": true,
                    "auth_salt": "abcdefghi1234567abcdefghi1234567"
                }
            ]
        }
    }
}

Response

Parameters

INFO

All the parameters received in the request except API_ID & API_KEY are returned in the response. The response will include all accounts associated with the user created by the entity. Find request parameters.

Response format

{
    "head": {
        "api": "addAccount",
        "apiVersion": "V1",
        "timeStamp": "2022-11-10 03:21:19 PM",
        "HTTP_CODE": 200
    },
    "encrypted_data": {
        "cipher_text": "IEau7gnewJnsjF22MJGc3DHkrU4irzNt2mShi+RU31vCSc8nez3OBs8cVuKoS1IpaCehvMLw6OZhFFFl1yY3qpVQRkxXrSvEpZ2Mt58mHONfWUpZG38E0TJEcoFqb5SffjvcDoQwKtxYJ2BPbZG7vpKi+MvfYAq5rV4AiVzcpCvyCLjuGdkYk5XCn40X9kBmpGuKVx95671awdRifo9gSnM0OJNC71l7gTGN7u6qU99CRH13b5bXh6efAplekZlvc7SjwJDnYZw+nIwQxfpSArUKx9ZC/AxGfjRFyLhUApxH5CuCEf0xaHbMqvu8yEiXFUIbSoifQsFUobI0RzAu/9etcW7tMSQslP8lyZfXP7Coe4Y84LoPiEATyNcB+CrEKvqLOipnTgdggLJANH1YnpxdJWnbqyBpx4m97gctIaIH+FForM6Vt6ZED1pGrub74lBQfxT8EOi+7FK6NSJuuclZ40+z3SXn/dtCZrDsL4hsXj37gzQgpap41b8PB7+jjuou1H9cIb97MlSn+z6BmbKNp04NTgQFH2D+4nY582Z0dssqHcuGhkAfJhDG3rklatbl93NsfkjPJraXXutDZCIkHUhsPxilsNNkeVZFcMKbXl5idvTWZYRCveSCcYjaTgG2HvZhYDm3Vvm12RAKinHA6nnwlRJwUjm1zv8L3ys0db397Bv2DgaWK6Ava6enU0ahRxoGgIdVBmR/+bQS68TGaAnAHlxwE9ZJLDFHsZdloIqu8AbI580ocpnRmWrHdJQTlT548/TxiToezAmI6KuJotPHwdkXOqDGee4yeJpyrhgjY6qvQ06Xxeo7+awb81v63q1ZmvCzttkkDBmogfNBSoFrZnmy3q9BoJANhoRXTefGbTmFKzlEQCE1RA0rdVSBdOxYQy7au6y/aR3FakoUuo0v/boGif6TyCWpx/1t80KVu05ps+NzsoFn6+DrUtBqK3JIxhDUDRJUYTpYzu1IXvlcYQbgLThO+WO7aSsNOYiDMZi4bb9bK80iHLMezQtgovkdZSdE0oFCOeFvfhfluFMcA6giJL3rFCzOlCsVsLDC8XTskk+Er3zYOP6mIiICemqw2QNwnsHKKDe8Ln4qrxuQH3JP8DSEHOdX33b+8CPAatvbam/Riy89AnSZ3q+RQ19a1rrZVJ+LIyr5cqwJLyl3bAV9q0uPlFNCLlf/Eui3m2Ewyv+0VnRHA/itkNXaoWeTwRpaPVthI3OKjonIzqMvsTxb0NQTVDswwL6VOVirFtQ2J0uM8zW3OapdglVI3tntXDrZ5P6RNE+qD6ON0J7Y8P86Et2OYRHtFri4ExvER502r9FoBK3noDNwpiYuTW77SlFYdAx9Oka/jTOiPeDNFOXyGsizfvr2ihR1LpclgWyfJ2jp6cv3OVtIMgnSmthXHpZDJi63BkNXA1ZCdd7p4vFRjD0gmVa43Jj3keacDYe+uUtge157OMjHnKFLsSaJkRTX/pJf2JN7fIK/F45j734ipUb675w+LRpnaGkpCivNhcxbu8O+VWi7jcVzDr2K/jy0hNklmqKgsmmcCtTuRahy93HlhX2fW7VNlEe3Ftz2x+WUIzmf1TFrpseWIjN3W+s+SQtaxRv50JqJkg1f974ycIwA57OUocBTzeXncpd9OmNVGP91PVxhB8rQJvf9HNQxSP2hrzwJuYU5w+6uB1o+r1bNuta4WWKIcLkaWp/6G6s/fgMY8Ru2+D0E29A6QhAdjKMS0AUgmy8LhowdhmZPaGsJEfNJM3LLM1JuvqQoNrYEOrnK5X1R44+24SrZ1rtatCEl+8J+PG68A6LqGB3L6p61uJ/dhxUqG+OJ5O/LwQUw5byTKQS9i/kPBtf2tWqV2RpjKCca2GkAXz/Duewb3Pky/NOq7Sq8PBbbUbdWTjodw66Pb8OnBfemHH27KNdF/X8PzyN8ybIX/LlMIcLim5Awmh4tqm1dwCLk0XSZ1NCAfWxqQ8Nk6fwN1cI2AynSBz5LjXW7k5OlgoMUsLdqdtJDh5m4mrzpNdHu1cGrgnUYMtci+BOkXzAcFqrdv21bvfXQ/Lul7rtlL61PTygHBZ2S1M9sTjkGochwHq4otYJlPXJaTBgFshY+fOatNjwgpcUh3d0K2iWKq0xINCFUuq2/wK7Aq4qSMQiezEAtqL+MkeCRkcUe2uInoTu8YEAT9c03dXx5rBuQ2fiQza1phoP4UAWmr3RvbtW7M4UENx1IoNHNxnigwN6w91F61uzCp3iJRY1nnUsL83/2GKo0o6Jce6hdQtn3MAHIlPn+taBx6Vtti8OusOrM8+kG+cYS75y2vt5al/mmKTDCfNqVb4buRkmb3/CKv56ZOod1fYWu7JUhjiai",
        "iv": "b24acc0b34621ed9",
        "hash": "ec5891ae7936232b6e4f4603378836320d8f397c81cd047368f76155d42e9708"
    }
}

{
    "head": {
        "api": "addAccount",
        "apiVersion": "V1",
        "timeStamp": "2022-11-10 03:21:19 PM",
        "HTTP_CODE": 200
    },
    "content": {
        "result": {
            "code": 1001,
            "status": "SUCCESS",
            "message": "The request is successfully processed"
        },
        "data": {
            "user": {
                "country_code": "91",
                "mobile": "9876543210"
            },
            "accounts": [
                {
                    "account_name": "GIRI",
                    "account_number": "0386780199100",
                    "branch_code": "BR001",
                    "branch_name": "KANNUR",
                    "account_type": "TL",
                    "account_class": "SAVING",
                    "account_status": "ACTIVE",
                    "account_opening_date": "2020-01-01",
                    "account_currency": "INR",
                    "account_daily_limit": "5000",
                    "is_debit_allowed": true,
                    "is_credit_allowed": true,
                    "is_cash_debit_allowed": true,
                    "is_cash_credit_allowed": true,
                    "auth_salt": "abcdefghi1234567abcdefghi1234567"
                },
                {
                    "account_name": "GIRI",
                    "account_number": "0686713132551",
                    "branch_code": "BR001",
                    "branch_name": "KANNUR",
                    "account_type": "SA",
                    "account_class": "SAVING",
                    "account_status": "ACTIVE",
                    "account_opening_date": "2020-01-01",
                    "account_currency": "INR",
                    "account_daily_limit": "5000",
                    "is_debit_allowed": true,
                    "is_credit_allowed": true,
                    "is_cash_debit_allowed": true,
                    "is_cash_credit_allowed": true,
                    "auth_salt": "abcdefghi1234567abcdefghi1234567"
                },
                {
                    "account_name": "FASIL",
                    "account_number": "5004880334479",
                    "branch_code": "BR001",
                    "branch_name": "KANNUR",
                    "account_type": "SA",
                    "account_class": "SAVING",
                    "account_status": "ACTIVE",
                    "account_opening_date": "2020-01-01",
                    "account_currency": "INR",
                    "account_daily_limit": "5000",
                    "is_debit_allowed": true,
                    "is_credit_allowed": true,
                    "is_cash_debit_allowed": true,
                    "is_cash_credit_allowed": true,
                    "auth_salt": "abcdefghi1234567abcdefghi1234567"
                },
                {
                    "account_name": "FASIL",
                    "account_number": "8758900103403",
                    "branch_code": "BR001",
                    "branch_name": "KANNUR",
                    "account_type": "SA",
                    "account_class": "SAVING",
                    "account_status": "ACTIVE",
                    "account_opening_date": "2020-01-01",
                    "account_currency": "INR",
                    "account_daily_limit": "5000",
                    "is_debit_allowed": true,
                    "is_credit_allowed": true,
                    "is_cash_debit_allowed": true,
                    "is_cash_credit_allowed": true,
                    "auth_salt": "abcdefghi1234567abcdefghi1234567"
                }
            ]
        }
    }
}

{
    "head": {
        "api": "addAccount",
        "apiVersion": "V1",
        "timeStamp": "2022-11-10 03:21:19 PM",
        "HTTP_CODE": 406
    },
    "content": {
        "result": {
            "code": 2006,
            "status": "FAILED",
            "message": "User default Virtual Address not found"
        },
        "data": {}
    }
}

Result Code

See the listed common result codes

PreviousAccount Fetch NextAccount Statement

Last updated 1 year ago