• Register

PAN Information Summary

This record provides contains Primary Account Number (PAN)-level nonmonetary information. For Falcon Fraud Manager debit or credit usage, there are one or more PIS records for each account indicated by an Account Information Summary (AIS) record.

Request Body:

Node Child Node Type Max 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_PIS" 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 tranCode String 3 The action code.
Note: tranCode values must be greater or equal to 100.
Optional
source String 10 Name of source application.
Note: A header accompanies both a message from a sender to a
recipient, and a response from the recipient to the sender. In the
response, the source and dest values are reversed.
Optional
dest String 10 Name of destination application.
Note: A header accompanies both a message from a sender to a
recipient, and a response from the recipient to the sender. In the
response, the source and dest values are reversed.
Optional
extendedHeader String 1024 Extended header. Contains data used by, and returned unaltered to,
the requesting system.
Optional
workflow String 16 Contains the name of the workflow to be executed by Falcon Fraud Manager. Optional
recordType String 8 PIS12 Optional
dataSpecificationVersion String 5 1.2 Optional
clientIdFromHeader String 16 Unique identifier for the client or subclient.  The value of this field is determined jointly by the client and FICO. Optional
recordCreationDate String 8 Format: yyyymmdd
Date that this record was created. Time zone must be GMT.
Optional
recordCreationTime String 6 Format: hhmmss
Time that this record was created. Time zone must be GMT.
Optional
recordCreationMilliseconds String 3 Format: sss
Milliseconds portion of the time that this record was created.  
Optional
gmtOffset String 6 Filled with blanks. Optional
customerIdFromHeader String 20 Primary Customer Identifier.  Financial institution's unique identifier for the primary customer for the PAN. Optional
customerAcctNumber String 40 Unique identifier for the account associated with the transaction/record. Optional
externalTransactionId String 32 Client-generated unique transaction ID that is unique across all data feeds for a specific installation of Falcon Fraud Manager.  Optional
pan String 19 Primary Account Number (PAN) of the payment instrument. This is the number encoded or embossed on the payment instrument.  Optional
type String 1 Type of the card:
C = Credit card
D = Debit card
M = Multi-card (combined credit and debit)
P =  Pre-paid (stored value)
Optional
subType String 2 Card subtype:
B = Commercial, corporate, business, purchasing, fleet, and so on.
C = Co-branded
DA = ATM only
H = Health benefits/flexible spending account
L = Oil card
R = Retail card
N = Standard consumer card
O = Other
PA = Travel
PB = Commercial reloadable
PG = General purpose non-reloadable (gift)
PI = Income (payroll)
PR = General purpose reloadable
PT = Teen
Optional
category String 1 Card category:
P = Platinum
G = Gold
S = Standard
Optional
association String 1 Credit card association under which the card was issued:
A = AMEX
D = Discover
J = JCB
M = MasterCard
N = Diners Club
O = Other
P = Proprietary
V = Visa
Optional
panOpenDate String 8 Format: yyyymmdd
Date on which a card was first provided on the account.
Optional
memberSinceDate String 8 Format: yyyymmdd
Card member since date, as printed on the card.
Optional
issuingCountry String 3 ISO numeric country code for the country from which the card was issued.  Optional
cardholderCity String 40 PAN primary address: city Optional
cardholderStateProvince String 5 PAN primary address: state or province. Optional
cardholderPostalCode String 10 PAN primary address: postal code. Optional
cardholderCountryCode String 3 PAN primary address: ISO numeric country code. Optional
numberOfPaymentIds String 3 Number of activated payment instruments for this Primary Account Number (PAN). Optional
paymentInstrumentId String 30 Filled with blanks for initial PIS record for each PAN.
For token provisioning, populated with most recent token or virtual
card number.
Optional
status String 2 Current card status:
00 = Open, non-statused, active
11 = Open, inactive
20 = Closed
21 = Closed, cardholder request
22 = Closed, bankruptcy or filing for bankruptcy
23 = Closed, bank action (revoked)
24 = Closed, charged-off
25 = Closed, fraud
26 = Closed, stolen
27 = Closed, lost
28 = Closed, deceased
29 = Closed, other
30 = Closed, due to inactivity
31 = Closed, non-fraud, transacted at point of compromise (POC)
32 = Closed, bank-initiated upgrade of card technology
33 = Closed, customer verified attempted fraud
40 = Statused, other (blocked)
Optional
statusDate String 8 Format: yyyymmdd
Effective date of current status.
Optional
pinLength String 2 Length of PIN.  Optional
pinSetDate String 8 Format: yyyymmdd
Date on which the PIN was last set.
Optional
pinType String 1 Type of PIN:
I = Issuer selected
C = Customer selected
Blank = Unknown
Optional
activeIndicator String 1 PAN activation indicator:
Y = Yes
N = No
Optional
nameOnInstrument String 40 Name that appears on the payment instrument(s). Fill with blanks if the name is not the same for all payment instruments with the specified PAN. Optional
expirationDate String 8 Format: yyyymmdd
PAN expiration date.
Optional
lastIssueDate String 8 Format: yyyymmdd
PAN issue date.
Optional
plasticIssueType String 1 Card issue type for most recently issued payment instrument:
F = Force emboss (reissue due to lost or stolen card, fraud, or other cardholder request such as a request for an additional card)
I = Initial issue (first plastic issued on the account)
R = Normal reissue
S = Special reissue (due to an issuer's special project, such as a rebranding)
T = Token or virtual card issue
Blank = Unknown/other
Optional
incentive String 1 Incentive program associated with the PAN, if any.  Valid values:
A = Auto discount
C = Cash back (for example, rebate program)
F = Frequent-flier miles
G = Gas discount
H = Charity contribution
I = Internet discount
L = Telephone discount
M = Merchandise rebate
O = Other
R = General purpose points/rewards
N = None
Optional
currencyCode String 3 ISO numeric currency code.  This is the currency unit used for all currency-based fields. Optional
currencyConversionRate String 13 Format: nnnnnn.nnnnnn
The multiplicative currency conversion rate that is used to convert the currency specified in currencyCode to US dollars. The number of US dollars in the currency specified in currencyCode.
Optional
creditLimit String 10 Format: nnnnnnnnnn
Credit limit for the PAN. Expressed in full units of the currency specified in currencyCode. 
Optional
overdraftLimit String 10 Format: nnnnnnnnnn
Overdraft limit for the PAN. Expressed in full units of the currency specified in currencyCode. 
Optional
dailyPosLimit String 10 Format: nnnnnnnnnn
Daily limit for POS transactions for the PAN.  Expressed in full units of the currency specified in currencyCode. 
Optional
dailyCashLimit String 10 Format: nnnnnnnnnn
Daily limit for cash (ATM) transactions for the PAN. Expressed in full units of the currency specified in currencyCode. 
Optional
cashbackLimitMode String 1 Indicates which daily limit cashback counts towards:
0 = No daily limits
1 = Cashback debited from POS limit
2 = Cashback debited from CASH limit
3 = Cashback debited from POS limit and CASH limit
4 = Cashback not debited from POS limit or CASH limit

Optional
mediaType String 1 Medium carrying the payment information:
C = Chip card
D = Contactless-capable chip card
M = Magnetic-stripe card
N = Contactless-capable magnetic-stripe card
P = Mobile Phone
V = Virtual card (no physical instrument exists)
W = Contactless only card
Blank = Unknown/not provided.
Optional
aipStatic String 1 Indicates the ability of a chip card to support Static Data Authentication (SDA) as part of the Application Interchange Profile:
Y = SDA is supported.
N = SDA is not supported.
Blank = Unknown/not provided.
Optional
aipDynamic String 1 Indicates the ability of a chip card to support Dynamic Data Authentication (DDA) as part of the Application Interchange Profile:
Y = DDA is supported.
N = DDA is not supported.
Blank = Unknown/not provided.
Optional
aipVerify String 1 Indicates the ability of a chip card to support Cardholder Verification as part of the Application Interchange Profile:
Y = Cardholder Verification is supported.
N = Cardholder Verification is not supported.
Blank = Unknown/not provided.
Optional
aipRisk String 1 Indicates the ability of a chip card to perform Terminal Risk Management as part of the Application Interchange Profile:
Y = Terminal Risk Management is to be performed
N = Terminal Risk Management is not to be  performed
Blank = Unknown/not provided.
Optional
aipIssuerAuthentication String 1 Indicates the ability of a chip card to support Issuer Authentication as part of the Application Interchange Profile:
Y = Issuer Authentication is supported
N = Issuer Authentication is not supported
Blank = Unknown/not provided.
Optional
aipCombined String 1 Indicates the ability of a chip card to support DDA/AC Generation (CDA) as part of the Application Interchange Profile:
Y = CDA is supported.
N = CDA is not supported.
Blank = Unknown/not provided.
Optional
chipSpecification String 1 Chip specification:
V = VIS
C = CCD
M = M/Chip
Blank = Unknown/not provided
Optional
chipSpecVersion String 3 Chip specification version. Examples:
140 = Version 1.4
210 = Version 2.1
400 = Version 4.0
Optional
offlineLowerLimit String 2 Lower consecutive off-line limit for card.
Blank = Unknown/not provided
Optional
offlineUpperLimit String 2 Upper consecutive off-line limit for card.
Blank = Unknown/not provided
Optional
userIndicator01 String 1 User-defined information. Editable in Falcon Expert rules. Optional
userIndicator02 String 1 User-defined information. Editable in Falcon Expert rules. Optional
userCode1 String 3 User-defined information. Optional
userCode2 String 3 User-defined information. Optional
userData01 String 6 User-defined information. Editable in Falcon Expert rules. Optional
userData02 String 6 User-defined information. Editable in Falcon Expert rules. Optional
userData03 String 10 User-defined information. Editable in Falcon Expert rules. Optional
userData04 String 10 User-defined information. Editable in Falcon Expert rules. Optional
userData05 String 15 User-defined information. Editable in Falcon Expert rules. Optional
userData06 String 20 User-defined information. Editable in Falcon Expert rules. Optional
userData07 String 40 This field can be configured for PIS emergency updates. Contact FICO Modeling for more details. Optional

 

Response Body:

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. Mandatory
Unique Source Message ID e.g. “adfasf123456”
msg_type String 12 Request Type Mandatory
msg_function String 50 Function name to be used Mandatory
"REP_PIS"
src_application String 10 The src_application sent in the request will be sent back in response in this field. Mandatory
Source requesting channel e.g. “SSP”
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 N/A Optional
bank_id String 4 The bank_id sent in the request will be sent back in response in this field. E.g. ‘XXXX Mandatory
instance_id String 10 N/A Optional
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   1 Status of the request (S/F) Mandatory
String 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 ehError string   hexadecimal value  
workflow string   Workflow code received in original transaction is returned. e.g.
"CREDIT" -- for clients with credit portfolio, and opted for SCORES
"DEBIT" -- for clients with debit portfolio, and opted for SCORES
"RBTRAN" -- for clients with credit portfolio, and opted for SCORES
"modelSTUB" -- Default for RULES ONLY clients
 
cause string   Possible cause for error.
e.g. "Invalid value for recordType"
 
tran_code number 3 nnn - The transaction code.
101 for auth; 102 for advice; 108 for profile maturation
Mandatory
source string 10 Name of source application.

Note: A header accompanies both a message from a sender to a recipient, and a response from the recipient to the sender. In the response, the source and dest values are reversed.
Mandatory
destination string 10 Name of destination application. Mandatory
extended_header string 1024 Extended header. Contains data used by, and returned/unaltered to, the requesting system. For example: Tracking identifier used by requesting system Mandatory
responseRecordVersion String 1 The response_record_version specifies the version of the scoring response
layout. This field is included to support building libraries that support reading
multiple versions of scoring response messages.
Mandatory
scoreCount String 2 This field specifies the number of scores in the response message and has
values from 0 to 8
Mandatory
decisionCount String 2 This field specifies the number of decisions in the response message and has
values from 0 to 10.
Mandatory
scoringServerId String 4 Contains a unique identifier for the Scoring Server host. The default value is
blank. The Scoring Server id is specified during Scoring Server installation and
is meant to be used for high availability configurations (where a scoring request
message is sent to multiple Scoring Servers with the first response received by
the Scoring Server client application (SSCA) being the response that is used by
the client application).
Not Applicable for clients
warning string 50   Optional
Array of decisions (upto 10 Occurences)      
decisions decision_type String 32 Stores the decision type of a type/code pair created by Falcon Expert functions
that generate type/code pairs.
Optional
decision_code String 32 Stores the decision code of a type/code pair created by Falcon Expert functions
that generate type/code pairs.
Optional
Scores Array (up to 8 occurences) -- expected for clients who opted for SCORES as well  
scores score number 4 This is the score returned from the model. Optional
error_code string 4 This is the error code generated by the model during its processing of the transaction to generate a score. A value of 0 or blank indicates no error. Optional
segment_id string 8 This field contains the segment ID of the score in the score_1 field. For segment ID definitions, see the model report for the model that scored the transaction. Optional
score_name string 22 Identifier for the score. The default score names are delivered with the model and can be changed after the model is installed, if needed. Optional
reason1 string 4 This field contains the top reason the score was generated.

For reason-code definitions, see the model report for the model that scored the transaction.
Optional
reason2 string 4 This field contains the second reason the score was generated. Optional
reason3 string 4 This field contains the third reason the score was generated. Optional

Request Json

{
    "NISrvRequest": {
        "request_pis": {
            "header": {
                "msg_id": "1694602918",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_FALCON_PIS",
                "src_application": "TIBCO",
                "target_application": "FALCON",
                "timestamp": "2023-09-13T14:02:05.639+03:00",
                "tracking_id": "1694602918",
                "bank_id": "default",
                "instance_id": "1694602918"
            },
            "body": {
                "tranCode": "102",
                "source": "TIBCO",
                "dest": "FLACON",
                "extendedHeader": "EXTENDEDHEADER120003",
                "workflow": "modelSTUB",
                "recordType": "PIS12",
                "dataSpecificationVersion": "1.2",
                "clientIdFromHeader": "LOOP",
                "recordCreationDate": "20230913",
                "recordCreationTime": "160912",
                "recordCreationMilliseconds": "234",
                "gmtOffset": "+03.00",
                "customerIdFromHeader": "12345000000003",
                "customerAcctNumber": "000999111000000003",
                "externalTransactionId": "D360PIS000000001",
                "pan": "4521092300032124",
                "type": "D",
                "subType": "R",
                "category": "P",
                "association": "V",
                "panOpenDate": "20230913",
                "memberSinceDate": "20230112",
                "issuingCountry": "681",
                "cardholderCity": "RIYAD",
                "cardholderStateProvince": "RIY",
                "cardholderPostalCode": "RIY 09 DH",
                "cardholderCountryCode": "682",
                "numberOfPaymentIds": "2",
                "paymentInstrumentId": "TOKEN01ADSADJJK010",
                "status": "00",
                "statusDate": "20230913",
                "pinLength": "6",
                "pinSetDate": "20230913",
                "pinType": "I",
                "activeIndicator": "Y",
                "nameOnInstrument": "ABDULLAH ZAFAR ALI MUBARAK",
                "expirationDate": "20250912",
                "lastIssueDate": "20230913",
                "plasticIssueType": "T",
                "incentive": "A",
                "currencyCode": "SAR",
                "currencyConversionRate": 1.56,
                "creditLimit": "22334455",
                "overdraftLimit": "1133557799",
                "dailyPosLimit": "3311224455",
                "dailyCashLimit": "9900887766",
                "cashbackLimitMode": "4",
                "mediaType": "D",
                "aipStatic": "Y",
                "aipDynamic": "N",
                "aipVerify": "Y",
                "aipRisk": "N",
                "aipIssuerAuthentication": "Y",
                "aipCombined": "N",
                "chipSpecification": "C",
                "chipSpecVersion": "140",
                "offlineLowerLimit": "29",
                "offlineUpperLimit": "99",
                "userIndicator01": "Y",
                "userIndicator02": "Z",
                "userCode1": "ABC",
                "userCode2": "XYZ",
                "userData01": "1USRDT",
                "userData02": "2USRDT",
                "userData03": "3USER DATA",
                "userData04": "4USER DATA",
                "userData05": "5USERXXXX DATAX",
                "userData06": "6USERXXXX DATAXDATAX",
                "userData07": "USER DATA 07000000000000000000000000000X"
            }
        }
    }
}

Response Json

{
    "response_pis": {
        "header": {
            "msg_id": "1694602918",
            "msg_type": "TRANSACTION",
            "msg_function": "REP_FALCON_PIS",
            "src_application": "TIBCO",
            "target_application": "FALCON",
            "timestamp": "2023-09-13T14:02:05.639+03:00",
            "tracking_id": "1694602918",
            "bank_id": "default"
        },
        "exception_details": {
            "application_name": "",
            "date_time": "2023-09-13T14:02:05.616+03:00",
            "status": "S",
            "error_code": "000",
            "error_description": "Success"
        },
        "body": {
            "tran_code": "102",
            "source": "PMAX",
            "destination": "TIBCO",
            "extended_header": "EXTENDEDHEADER120003",
            "responseRecordVersion": "4",
            "scoreCount": "00",
            "decisionCount": "0"
        }
    }
}

 

 

 

Docs Navigation