• Register

List of Accounts

 

This service is used for getting list of accounts for a particular client , below are the detailed specifications of this API.

Download

Request parameters:

Node

Child Node

Type 

Max

Description

Remarks

header

msg_id

String

12

Unique Source Message ID

Mandatory

msg_type

String

12

Request Type

Default: "ENQUIRY"

Mandatory

msg_function

String

50

Function name to be used

Default: "REQ_LIST_OF_ACCOUNTS"

Mandatory

src_application

String

10

Source requesting channel

Ex: IVR

Mandatory

target_application 

String

10

Target application name

Ex. : "WAY4"

Mandatory

timestamp

String

30

Timestamp of the request

Format  “DD/MM/YYYY HH:MM:SS”

Mandatory

tracking_id

String

15

N/A

Optional

bank_id

String

4

Source Bank Id Ex: TIQMO

Mandatory

body

customer_id

String

20

Customer ID 

Conditional
card_type String 32 PREPAID/CREDIT/DEBIT Mandatory
balance_list String 100 AVAILABLE,BLOCKED,TOTAL_BALANCE Optional
Request Json
{
    "NISrvRequest": {
        "request_list_of_accounts": {
            "header": {
                "msg_id": {{$timestamp}},
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_LIST_OF_ACCOUNTS",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "{{timestamp1}}",
                "tracking_id": {{$randomInt}},
                "bank_id": "TIQMO"
            },
            "body": {
                "customer_id": "00000001000021",
                "card_type": "PREPAID"
            }
        }
    }
}

 

Response Parameters:

Node Child Node Type   Max Description Remarks
header msg_id     The msg_id sent in the request will be sent back in response in this field. Mandatory
String 12 Unique Source Message ID e.g. “ada123456fdsf”
msg_type String 12 msg_type sent in the request will be sent back in response in this field. Mandatory
msg_function String 50 Default: “REP_LIST_OF_ACCOUNTS” Mandatory
src_application String 10 The src_application sent in the request will be sent back in response in this field. Mandatory
target_application  String 10 The target_application sent in the request will be sent back in response in this field. Mandatory
timestamp     Timestamp of the response Mandatory
String 30 Date & time. Format  “DD/MM/YYYY HH:MM:SS”
tracking_id String 15 725 Optional
bank_id String 4 The bank_id sent in the request will be sent back in response in this field.  Mandatory
Exception_details application_name String 20 Application Name Mandatory
date_time   30 Timestamp of the response Mandatory
String Format “DD/MM/YYYY HH:MM:SS”
status String 1 Status of the request (S/F) Mandatory
  Success- S,  Failure - F
error_code String 4 EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions) Mandatory
error_description String 100 Error Description (Check error codes section for the complete list of error codes and error code descriptions) Mandatory
transaction_ref_id String 20 The tracking_id sent in the request will be sent back in response in this field. Optional
body customer_id  String 20 Customer Id  Mandatory
  account_number String 19 Account number Mandatory
rbs_number String 32 rbs number Optional
product_code String 32 product code Mandatory
product_name String 255 product name Mandatory
#Array of Statuses#
statuses type string 32 Satus type Mandatory
value string 32 Status Value Mandatory
changed_date string 10 Changed Date Mandatory
description string 100 Description Optional
#Array of Limits#
limits type String 10 Refer to limits Optional
currency String 3  Currency Optional
value String 13 Amount Optional


Response Json
{
    "NISrvResponse": {
        "response_list_of_accounts": {
            "header": {
                "msg_id": "1649398145",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_LIST_OF_ACCOUNTS",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2022-04-08T10:04.08+04:00",
                "tracking_id": "725",
                "bank_id": "TIQMO"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2022-04-08T09:09:05.702+03:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success",
                "transaction_ref_id": "725"
            },
            "body": {
                "customer_id": "00000001000021",
                "accounts": [
                    {
                        "account_number": "0003603330000000017",
                        "rbs_number": "1234556",
                        "product_code": "360_SAR_001_A",
                        "statuses": [
                            {
                                "type": "BCC-ACC1-360",
                                "value": "_",
                                "changed_date": "' '",
                                "description": "SPACE"
                            },
                            {
                                "type": "BCC-ACC2-360",
                                "value": "_",
                                "changed_date": "' '",
                                "description": "SPACE"
                            },
                            {
                                "type": "BCC-CARD-360",
                                "value": "_",
                                "changed_date": "' '",
                                "description": "SPACE"
                            }
                        ],
                        "limits": [
                            {
                                "type": "CR_LIMIT",
                                "currency": "SAR",
                                "value": "0.00"
                            }
                        ]
                    }
                ]
            }
        }
    }
}

version 3 as of 1 year ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation