• Register

Card Statement Summary

Card statement summary service is used for fetching the online card statement for a given card. This service is applicable only for Credit Cards. Below are the detailed specifications of this API.

Request Parameters:

 

Node Child Node Data Type Length Description Remarks
header msg_id A/N 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_CARD_STATEMENT_SUMMARY " Mandatory
src_application String 10 Source requesting channel Ex: IVR Mandatory
target_application String 10 Target application name Ex. : "PCMS" Mandatory
timestamp String 30 Timestamp of the request Format  “DD/MM/YYYY HH:MM:SS” Mandatory
tracking_id String 15 Transaction Tracking Id Optional
bank_id String 4 Source Bank Id Ex: bankID Mandatory
body card_identifier_id String 32 454545XXXXXX1234 Mandatory
card_identifier_type String 20 CONTRACT_NUMBER  or EXID Mandatory
statement_period String 4 Format MMYY (Maximum statement is 12 months from the current date) Mandatory
Request Json
{
  "NISrvRequest":{
    "request_card_statement_summary":{
      "header":{
        "msg_id":"236001",
        "msg_type":"ENQUIRY",
        "msg_function":"REQ_CARD_STATEMENT_SUMMARY",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"2020-07-20T10:49:02.366+04:00",
        "tracking_id":"236001",
        "bank_id":"bankID"
      },
      "body":{
        "card_identifier_id": "454545XXXXXX1234",
        "card_identifier_type": "CONTRACT_NUMBER/EXID",
        "statement_period":"1023"
      }
    }
  }
}

Response Parameters:

Node

Child Node

Type 

Max

Description

Remarks

header

msg_id

 

String

 

12

The msg_id sent in the request will be sent back in response in this field. Unique Source Message ID e.g. “ada123456fdsf”

Mandatory

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: “REQ_CARD_STATEMENT_SUMMARY”

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

 

String

 

30

Timestamp of the response

Date & time. Format  “DD/MM/YYYY HH:MM:SS”

Mandatory

tracking_id

 

String

 

15

N/A

Optional

bank_id

 

String

4

The bank_id sent in the request will be sent back in response in this field.

Mandatory

instance_id

String

10

N/A

Optional

Exception_details

application_name

String

20

Application Name

Mandatory

date_time

 

String

30

Timestamp of the response.Format “DD/MM/YYYY HH:MM:SS”

Mandatory

status

 

String

1

Status of the request (S/F). Success- S,  Failure - F

Mandatory

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

 card_identifier_id

 

String

32

454545XXXXXX1234

Mandatory
card_identifier_type String 20 CONTRACT_NUMBER  or EXID Mandatory
statement_period String 4 Format MMYY (Maximum statement is 12 months from the current date) Mandatory

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

statement_details

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

statement_date

String

10

Billing Date

Mandatory

last_statement_date

String

3

Last billing date

Mandatory

statement_opening_balance

String

20

Statement Opening balance

Mandatory

statement_closing_balance

String

20

Statement Closing balance

Mandatory

due_amount

String

20

Due amount

Conditional (Applicable for credit cards)
due_date String 10 Statement due date in format YYYY-MM-DD Conditional (Applicable for credit cards)
full_payment_amount String 20 Full payment amount/interest free amount Conditional (Applicable for credit cards)

interest_this_statement

String

20

Interest amount in selected statement

Conditional (Applicable for credit cards)
statement_available_balance String 20 Available amount at the time of statement Mandatory

reward_programs

 

reward_type

string

3

Reward Type

optional

reward_open_balance

string

3

Reward Open Balance

optional

reward_balance

string

20

Reward Balance

optional

reward_earned

string

20

Reward Earned

optional

reward_redeemed

string

20

Reward Redeemed

optional

reward_adjust

string

20

Reward Adjust

optional

reward_total_earned

string

20

Reward Total Earned

optional

Response Json

{
   "NISrvResponse":{
      "response_card_statement_summary":{
         "header":{
            "msg_id":"1234543212",
            "msg_type":"ENQUIRY",
            "msg_function":"REP_CARD_STATEMENT_SUMMARY",
            "src_application":"TIBCO",
            "target_application":"WAY4",
            "timestamp":"2021-07-26T18:49:02.366+04:00",
            "tracking_id":"1234543212",
            "bank_id":"PRMBK"
         },
         "exception_details":{
            "application_name":"NITIB_TCC_ADP_STD_1",
            "date_time":"2021-11-09T15:02:45.803+04:00",
            "status":"S",
            "error_code":"000",
            "error_description":"Success",
            "transaction_ref_id":"1234543212"
         },
         "body":{
            "card_identifier_id": "454545XXXXXX1234",
            "card_identifier_type": "CONTRACT_NUMBER/EXID",
            "statement_period":"1221",
            "statement_details":[
               {
                  "statement_date":"15/12/2021",
                  "last_statement_date":"' '",
                  "statement_opening_balance":"0.00",
                  "statement_closing_balance":"-6000.00",
                  "due_amount":"-900.00",
                  "due_date":"05/01/2022",
                  "full_payment_amount":"-6000.00",
                  "interest_this_statement":"0.00",
                  "statement_available_balance":null
               }
            ]
         }
      }
   }
}

version 11 as of 2 years ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation