• Register

Account Create

This service is used for creating the account record in the CMS system. Account record is the second level or mid-level in the hierarchy and it will have financial information like credit limit, available balances, current balance and various financial balance components. Key information required to board the account record are client number, product code, billing day, credit limit etc.

Download

Request Parameters:

Node Child Node Type Length Description Remarks
header msg_id A/N 12 Unique Source Message ID Mandatory
msg_type String 12 Request Type Default: "TRANSACTION" Mandatory
msg_function String 50 Function name to be used Default: "REQ_ACCOUNT_CREATE" Mandatory
src_application String 10 Source requesting channel 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 customer_id String 20 CIF ID Mandatory
card_type String 7

Values are restricted

PREPAID

CREDIT

DEBIT

Mandatory
account customer_id String 20 CIF ID Mandatory
account_number String 64 Account contract Optional
account_type String 10 Account Type e.g. SAVING, CURRENT Conditional (mandatory for Debit Card)
parent_account_number String 64 Account contract (Applicable for Corporate) Optional
branch_code String 10 Branch code e.g. “XXXX” Mandatory
product_code String 32 Product code Mandatory
billing_day String 10 Billing date Optional
currency String 3 Currency Mandatory
limit type String 32 Limit type -
FIN_LIMIT
Conditional(Mandatory for Credit Cards only)
currency String 3 Limit currency Conditional(Mandatory for Credit Cards only)
value String 20 Limit value Conditional(Mandatory for Credit Cards only)
custom_fields key String 32 Refer to Appendix 4 Refer to Appendix 4
value String 128 Refer to Appendix 4 Refer to Appendix 4

 Request JSON

{
  "NISrvRequest":{
    "request_account_create":{
      "header":{
        "msg_id":"224001",
        "msg_type":"TRANSACTION",
        "msg_function":"REQ_ACCOUNT_CREATE",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"2020-07-19T13:04:30.356+04:00",
        "tracking_id":"224001",
        "bank_id":"bankID"
      },
      "body":{
        "customer_id":"999841XX298XX733",
        "account": {
            "customer_id":"card_status",
            "account_number":"",
            "branch_code": "",
            "billing_day": "",
            "limit": {
               "type":"",
                "currency": "",
                "value": ""
             },
            "custom_fields"{
               "key": "CN-CARD_TARIFF",
                "value": "PCT_001"
             }
        }
      }
    }
  }
}

Response Parameters:

Node Child Node Type Length Description Remarks
header msg_id String 12 The msg_id sent in the request will be sent back in response in this field. Mandatory
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_ACCOUNT_UPDATE” Mandatory
src_application String 10 The src_application sent in the request will be sent back in response in this field. Mandatory
Source requesting channel 
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 Mandatory
Date & time. Format  “DD/MM/YYYY HH:MM:SS”
tracking_id String 15 The tracking_id sent in the request will be sent back in response in this field. 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 Mandatory
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 account_number String 64 Account contract Mandatory
custom_fields key String 32 Please Refer Appendix 4 Optional
value String 128 Please refer Appendix 4 Optional


























Response JSON
{
  "NISrvResponse":{
    "response_account_create":{
      "header":{
        "msg_id":"224001",
        "msg_type":"TRANSACTION",
        "msg_function":"REP_ACCOUNT_CREATE",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"19/07/2020 13:04:31",
        "tracking_id":"224001",
        "bank_id":"bankID"
      },
      "exception_details":{
        "application_name":"",
        "date_time":"2020-07-19T12:57:49.439+04:00",
        "status":"S",
        "error_code":"000",
        "error_description":"Success",
        "transaction_ref_id":null
      },
      "body":{
         "account_number": ""
      }
    }
  }
}


paytabs/NI@paytab9

Docs Navigation