Skip to content

Debit Authorization

A Debit Authorization record contains information about a Debit authorization request. A Debit authorization request occurs when the card is presented to the merchant and the merchant sends the information about the purchase to the card issuer to determine whether the purchase should proceed or not. A Debit Posting record contains information about a Debit transaction that has already occurred and is used to tell the issuer about the transaction.

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_DBTRAN" 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 DBTRAN25 Optional
dataSpecificationVersion String 5 2.5 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 Specifies the Greenwich Mean Time (GMT) offset associated with all date-time fields in the record body (positions 161 onward).  Format is (-)nn.nn, where the digits to the right of the decimal point represent decimal fractions of an hour. For example, a GMT offset of 5 hours and 45 minutes (Nepal) is expressed as 5.75. Note that gmtOffset changes during Daylight Saving Time if Daylight Saving Time is observed in the date-time fields in the record body. Optional
customerIdFromHeader String 20 Customer Identifier. Financial institution's unique identifier for the customer associated with this transaction.   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
authPostFlag String 1 Type of transaction:
A = Authorization or other payment-card-initiated transaction (for example, available funds inquiry at ATM).
P = Posting
Optional
cardPostalCode String 9 Deprecated.
Cardholder ZIP or postal code. 
Optional
cardSeqNum String 3 The sequence number for the chip card, if used. Optional
openDate String 8 Deprecated.
Format: yyyymmdd
Date account was opened. 
Optional
plasticIssueDate String 8 Deprecated.
Format: yyyymmdd
Date of last plastic issue. 
Optional
plasticIssueType String 1 Deprecated.
Plastic issue type:
F = Force emboss (plastic reissued due to customer request, replacement for lost/stolen, emergency plastic, option change)
I = Initial issue (first plastic issued on the account)
R = Normal reissue
S = Special reissue (due to an issuer's special project)
T = Token or virtual card issue
Blank = Unknown/other
Optional
acctExpireDate String 8 Deprecated.
Format: yyyymmdd
Expiration date from cardholder file.
Optional
cardExpireDate String 8 Format: yyyymmdd
Expiration date from card, transmitted with transaction data. 
Optional
expandedBIN String 10 The first 8–10 digits of the card number (pan). Optional
dailyCashLimit String 10 Deprecated.
Format: nnnnnnnnnn
The daily cash (ATM) limit, expressed in full units of the currency. Amount is expressed in currency unit specified in transactionCurrencyCode. 
Optional
tokenizationIndicator String 1 Tokenization issue type:
C = Card on File
H = Host Card Emulation (Cloud-Based Payment)
O = Other tokenization type
Q = Quick Response Code
S = Secure Element
Blank = Transaction is not tokenized
Deprecated values:
M = Mobile device enabled token
N = One time use token
W = Digital wallet
Optional
tokenExpirationDate String 8 Date the token expires.
Network provides in 4 bytes YYMM 
Optional
consumerAuthenticationScore String 3 Payment-card network consumer authentication risk score. Optional
incomeOrCashBack String 10 Deprecated.
Format: nnnnnnnnnn
Cash-back amount if transactionType = B (merchandise with cash back). Otherwise, annual income (blank if income data not available).
 Amount is expressed in currency unit specified in transactionCurrencyCode.
Optional
cavvResult String 1 The CAVV (Cardholder Authentication Verification Value) result. Valid values:
0 = CAVV could not be verified
1 = CAVV failed verification-authentication
2 = CAVV passed verification-authentication
3 = CAVV passed verification-attempted authentication. Issuer attempts CAVV key was used to generate the CAVV.
4 = CAVV failed verification-attempted authentication. Issuer attempts CAVV key was used to generate the CAVV.
6 = CAVV not verified, issuer not participating
7 = CAVV failed verification-attempted authentication. Visa CAVV attempts key was used to generate the CAVV.
8 = CAVV passed verification-attempted authentication. Visa CAVV attempts key was used to generate the CAVV.
9 = CAVV failed verification-attempted authentication
A = CAVV failed verification-attempted authentication
B = CAVV passed verification-attempted authentication, no liability shift
C = CAVV was not verified-attempted authentication
D = CAVV was not verified-cardholder authentication
Blank = not present or not verified
Optional
peerGrouping String 1 Used to turn on peer grouping for models that contain collaborative profiles. Valid values:
Y = Peer grouping turned on
Blank = Peer grouping turned off
Optional
transactionDate String 8 Format: yyyymmdd
Date of  transaction. Time zone is specified by gmtOffset.
Optional
transactionTime String 6 Format: hhmmss
Time of transaction.  Time zone is specified by gmtOffset.
Optional
transactionAmount String 13 Format: nnnnnnnnnn.nn
Transaction amount; always a positive number or zero, regardless of entry in transactionType field. Amount is expressed in currency unit specified in transactionCurrencyCode:
- If transactionType is B (cash-back) then transactionAmount is the total of the merchandise amount and the cash-back amount.
- If transactionType is C (ATM cash) then transactionAmount should be the total of the disbursed amount and fees.
- For ATM withdrawals, the amount is not  zeroed out on decline.
- For ATM balance inquiries, this field is set to zero.
Optional
transactionCurrencyCode String 3 ISO numeric currency code. This is the currency unit used for all currency-based fields. Optional
transactionCurrencyConversionRate String 13 Format: nnnnnn.nnnnnn
The multiplicative currency conversion rate that is used to convert the currency specified in transactionCurrencyCode to US dollars. The number of US dollars in the currency specified in transactionCurrencyCode.
Optional
authDecisionCode String 1 Authorization Decision Code:
A = Approve
B = Partial approval (a portion of the funds is approved)
D = Decline
I = Approve with positive ID
P = Pick up card
R = Refer
Blank = Unknown/other
Optional
transactionType String 1 Transaction type:
A = Address verification only
B = Purchase with cash back
C = Cash
E = Initial authentication (ATM)
F = Reserved
I = ATM available funds inquiry
M = Purchase
O = Other
P = Pre-authorization
R = Crediting funds to the account
U = Automated recurring charge
X = Reversal
Z = Completion of previously pre-authorized transaction
Blank = Unknown
Deprecated:
J = ATM deposit
Optional
mcc String 4 Merchant Category Code (MCC).  Optional
merchantPostalCode String 9 Merchant ZIP or postal code.  Optional
merchantCountryCode String 3 Merchant ISO numeric country code.  Optional
pinVerifyCode String 1 PIN verification:
I = Invalid
V = Valid
X = PIN entered but not verified or verification results unknown
Y = PIN not entered, not using a card association network
Z = PIN not entered, using a card association network
Deprecated value:
P = PVKI value zero or blank
Blank = not checked
Optional
cvvVerifyCode String 1 CVV/CVC, CVV2/CVC2, dCVV/CVC3, or iCVV/Chip CVC outcome, as appropriate for the POS entry mode:
I = Invalid
V = Valid
Blank = Not checked or outcome of check unknown
Deprecated values:
N = Track data not present or insufficient
Z = CVV/CVC value zero or blank
Optional
posEntryMode String 1 POS entry mode:
C = Contactless magnetic stripe
D = Contactless microchip card
E = E-commerce
F = Fallback to magnetic stripe read on chip card that is unreadable at chip-enabled terminal
G = Fallback to keyed entry on chip card that is unreadable at chip-enabled terminal
K = Keyed (manual)
S = Magnetic stripe read; CVC/CVV checking may not be possible
T = Chip read; CVC/CVV checking may not be possible
U = Magnetic stripe read
V = Chip read
X = Contactless entry using bar code reader
Y = Contactless entry using optical character reader
Blank = Unknown/other
Optional
postDate String 8 Format: yyyymmdd
Authorization: Blank.
Posting: Date posting was processed.
Optional
authPostMiscIndicator String 1 This field indicates if the posting was authorized. Valid values:
N = No
Y = Yes
Blank = Unknown/Not Posting
Optional
mismatchIndicator String 1 Indicator for controlling case creation based on results from standard checks performed prior to Falcon. 
Mismatch Indicator:
Blank = Do not force case creation
Any other value = Create case
If you use Falcon Expert, create a rule to use this field.
Optional
caseCreationIndicator String 1 Case creation indicator:
Blank = Do not force case creation.
Any other value = Create case.
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
userData01 String 10 User-defined information. Editable in Falcon Expert rules. Optional
userData02 String 10 User-defined information. Editable in Falcon Expert rules. Optional
onUsMerchantId String 10 Deprecated.
Merchant identifier (from merchant flat-file database). For Point-of-Service (POS) transactions, this is the merchant identifier. For ATM transactions, it is the ATM identifier. 
Optional
merchantDataProvided String 1 Deprecated.
Specifies whether the merchant data fields in this record have been populated by the Scoring Server Client Application or not. Must be set to agree with the action code (online) or semaphore (batch) semantics used to process the record as the functionality is controlled by the action-code/semaphore semantics, not the value specified here:
Y = Yes. Used for action-codes/semaphores configured not to populate the merchant data fields before model execution.
N = No. Used for action-codes/semaphores configured to populate the merchant data fields before model execution. The merchant data is retrieved from the Scoring Server's merchant flat-file database; the record is identified by the onUsMerchantId field.
Optional
idMethod String 1 The ID method:
0 = not specified
1 = signature
2 = online PIN
3 = unattended terminal, no PIN pad
4 = mail/telephone/electronic commerce
P = online PIN verification
S = can signify signature
Numeric values indicate Visa responses, and letter values indicate Mastercard responses.
Optional
externalScore1 String 4 External score for use by another process. Optional
externalScore2 String 4 External score for use by another process. Optional
externalScore3 String 4 External score for use by another process. Optional
customerPresent String 1 Is cardholder present during transaction? Valid values:
Y = Yes
N = No
Blank = Unknown
Optional
atmOwner String 1 ATM owner, if mcc = 6011:
B = Issuers (financial institutions) own ATM terminal (On-us transaction)
C = Other financial institution, credit union or thrift owned terminal
M = Merchant or ISO owned terminal
O = Other owner
U = unknown
Blank for other mcc codes.
Optional
randomDigits String 2 Random digits used to define random selections of cardholders for the testing of rules and models.  Optional
portfolio String 14 Name of the "portfolio" (segment of the account base) to which this account belongs.  Optional
tokenRequestorId String 14 Strings are left justified.
Token Requestor ID
Positions 1-3: Token Service Provider code, unique to each Token Service Provider
Positions 4-11: Assigned by Token Service Provider for each requesting entity and Token Domain
Optional
acquirerBin String 6 Deprecated.
ID of acquiring financial institution. 
Optional
merchantName String 40 Merchant name (or address).  Optional
merchantCity String 30 Merchant city.  Optional
merchantState String 3 Merchant state (or country).  Optional
caseSuppressionIndicator String 1 Case suppression indicator.  Valid values:
Blank = Do not prevent case creation.
Any other value = Prevent case creation.
Optional
userIndicator03 String 5 User-defined information. Editable in Falcon Expert rules. Optional
userIndicator04 String 5 User-defined information. Editable in Falcon Expert rules. Optional
userData03 String 15 User-defined information. Editable in Falcon Expert rules. Optional
userData04 String 20 User-defined information. Editable in Falcon Expert rules. Optional
userData05 String 40 User-defined information. Editable in Falcon Expert rules. Optional
realtimeRequest String 1 Authorization: Real-time-response indicator:
Blank = Respond in real time if transaction code calls for response.
Any other value = Do not respond in real time.
If system is not in real-time mode, then information in this field is ignored.
Posting: Blank.
Optional
padResponse String 1 Authorization: Prior Action Database (PAD) response code, for use with Falcon Expert Authorization Response Module (ARM) rules. The values are determined by the client. Suggested values are:
A = Approved
D = Declined
I = Approved with positive ID
P = Picked up card
R = Short referral
C = Continuous referral
N = Never refer
Blank = Unknown
Posting: Blank.
Optional
padActionExpireDate String 8 Format: yyyymmdd
Authorization: Date through which PAD action remains valid, for use with ARM rules.
Posting: Blank.
Optional
tokenId String 19 Payment Token.  May be 13 to 19 bytes. Optional
cardAipStatic 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
cardAipDynamic 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.
Deprecated values:
D = DDA is supported.
S = DDA is not supported.
Optional
RESERVED_01 String 1 Reserved.   Optional
cardAipVerify 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
cardAipRisk 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
cardAipIssuerAuthentication 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
cardAipCombined String 1 Indicates whether a chip card supports combined 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
cardDailyLimitCode String 1 The deprecated cardDailyLimitCode field has been repurposed for use as an authentication indicator. Valid values:
1 = ecommerce / SecureCode
2 = processed through Masterpass
4 = Digital Secure Remote Payment (DSRP) with UCAF data
7 = recurring authentication
Optional
availableBalance String 13 Format: (-)nnnnnnnnn.nn
Available balance for accessed account immediately before this transaction. Amount is expressed in the currency unit specified in transactionCurrencyCode. 
Optional
availableDailyCashLimit String 13 Format: (-)nnnnnnnnn.nn
Available (remaining) daily cash limit before this transaction. Amount is expressed in currency unit specified in transactionCurrencyCode. 
Optional
availableDailyMerchandiseLimit String 13 Format: (-)nnnnnnnnn.nn
Available (remaining) daily merchandise limit before this transaction. Amount is expressed in currency unit specified in transactionCurrencyCode. 
Optional
atmHostMcc String 4 Deprecated.
For ATM transactions, MCC for merchant where terminal is located.

Optional
atmProcessingCode String 6 For ATM transactions, processing code according to ISO 8583, field 003. Otherwise, blank. Optional
atmCameraPresent String 1 Deprecated.
For ATM Transactions:
N = Camera not present
Y = Camera present
Blank = Unknown
Optional
cardPinType String 1 Deprecated.
Card PIN type:
I = Issuer selected
C = Customer selected
Blank = Unknown
Optional
cardMediaType String 1 Deprecated.
Card medium carrying the information:
C = Chip card
D = Contactless-capable chip card
M = Magnetic-stripe card
N = Contactless capable magnetic-stripe card
V = Virtual card (no physical card exists)
W = Contactless-only card
Blank = Unknown/not provided.
Optional
cvv2Present String 1 Presence indicator for Card Identification Number (CIN), CVC2, or CVV2:
0 = CVV2 not provided
1 = CVV2 present
2 = CVV2 present but not legible
9 = CVV2 not present
Blank = Unknown or not applicable.
Optional
cvv2Response String 1 Response to a CVV2 request. See field 44.10 in the Visa specification or Data Element 48, Subelement 87 of the MasterCard specification:
M = CVV2 match
N = CVV2 no match
P = CVV2 not processed
S = CVV2 should be on the card
U = Issuer is not certified or has not provided encryption keys to association.
Blank = Unknown or not applicable
Optional
avsResponse String 1 Response to an AVS (Address Verification Service) request. See field 44.2 in the Visa specification or Data Element 48, Subelement 83 of the MasterCard specification:
A = AVS address only
N = AVS no match
R = AVS system unavailable
S = AVS not supported
U = AVS no data
W= AVS ZIP nine
X = AVS exact
Y = AVS ZIP five address
Z = AVS ZIP five only
Blank = Unknown/not provided
Optional
transactionCategory String 1 Method used for the transaction:
A = Automatic/recurring
I = Internet
M = Mail
N = Card not present, Cardholder present
P = Card present
O = Other
T = Telephone
Optional
acquirerId String 12 ID code of the acquiring institution (ISO 8583 field 32).
Blank = Unknown/not provided
Optional
acquirerCountry String 3 ISO numeric country code of the acquiring institution for the merchant or ATM (ISO 8583 field 19).
Blank = Unknown/not provided
Optional
terminalId String 16 The ID number of the terminal at which the authorization was initiated.
Blank = Unknown/not provided
Optional
terminalType String 1 Code that identifies the type of POS terminal:
A = Attended terminal
L = Limited amount terminal requiring no cardholder verification
I = Internet/telephone
U = Unattended terminal, not specified elsewhere
Blank = Unknown or not applicable
Optional
terminalEntryCapability String 1 Terminal entry capability. Indicates the terminal's ability to read account numbers and expiration dates from cards:
C = Chip card read capability
D = Contactless chip card read capability
K = Key entry only (card present)
M = Magnetic stripe read capability
N = Contactless magnetic stripe read capability
O = Other
Z = No terminal used (card not present)
Blank = Unknown
Deprecated values for Visa transactions:
0 = Unknown
1 = Terminal not used
2 = Magnetic stripe read capability
3 = Bar code read capability
4 = OCR read capability
5 = Chip read capability
8 = Proximity-read-capable terminal
9 = Terminal does not read card data
Deprecated values for MasterCard transactions:
0 = Unknown or unspecified
1 = No terminal used (voice/ARU authorized)
2 = Magnetic stripe reader
3 = Contactless chip reader
4 = Contactless magnetic stripe reader
5 = Magnetic stripe reader and EMV specification compatible chip reader
6 = Key entry only
7 = Magnetic stripe reader and key entry
8 = Magnetic stripe reader and key entry and EMV specification compatible chip reader
9 = EMV specification compatible chip reader
Optional
posConditionCode String 2 A code identifying transaction conditions at the point of sale or point of service:
00 = Normal transaction of this type
01 = Customer not present
02 = Unattended acceptance terminal, customer operated
03 = Merchant suspicious of transaction or card
05 = Customer present, card not present
06 = Completion advice
08 = Mail/telephone order/recurring transaction
10 = Customer identity verified
51 = Request for account number or address verification without authorization
55 = Request for telecode verification without authorization
59 = E-commerce request through public network
71 = Card present, magnetic stripe cannot be read
Blank = Unknown/not provided
Optional
networkId String 1 Network identification:
B = Financial institution's ATM
C = Cirrus
D = Discover
E = Pulse
F = AFFN (Armed Forces Financial Network)
G = American Express
H = Co-op
I = Interlink
J = Jeanie
K = Credit Union 24
L = AllPoint
M = MasterCard/Maestro
N = Interac
O = Other
P = Plus
Q = Presto
S = Star
T = Shazam
V = Visa
X = Accel/Exchange
Y = NYCE
Optional
RESERVED_02 String 1 Reserved.   Optional
authExpireDateVerify String 1 Valid values:
I = Invalid
V = Valid
X = Expiration date present but not checked or verification results unknown
Z = Expiration date not present in authorization message
Optional
authSecondaryVerify String 1 CNP Transactions: outcome of Verified by Visa or Mastercard SecureCode Check.
CP/ATM Transactions: outcome of secondary authentication (2nd PIN, birthdates, and so on):
I = Invalid
V = Valid
U = Transaction covered by secondary authentication, outcome of check unknown
Blank = Not checked or no secondary authentication
Optional
authBeneficiary String 1 Deprecated.
Valid values:
C = Customer's account at issuing financial institution
D = Account at domestic financial institution
F = Account at foreign financial institution
O = Other
Blank = None
For bill payment:
S = Customer's own bill (for example, credit card)
T = Payee chosen from financial institution-approved list
U = Unknown payee (envelope deposited)
V = Payee chosen from customer's list
Optional
authResponseCode String 1 Valid values:
A = Approve
C = CVV/CVC failure
D = Expiration date mismatch
E = Account closed or Expired card
F = Suspected fraud or lost/stolen card
I = Insufficient funds
L = Exceeds withdrawal amount limit
M = Exceeds withdrawal frequency limit
N = No such account (checking, savings, or credit)
O = Other decline reason
P = Incorrect PIN
Q = Incorrect secondary PIN/authentication
R = ATC out of range for contactless or chip transaction
T = Allowable PIN tries exceeded
U = Incorrect password
V = Allowable password tries exceeded
W = Allowable secondary PIN/authentication tries exceeded
Optional
authReversalReason String 1 Valid values:
0 = Not a reversal
2 = Terminal processor error
3 = System timeout
4 = Terminal error/misdispense
5 = Terminal communication error
6 = Terminal error
7 = Late or unsolicited response
8 = Reversal/Customer cancel
9 = Suspected fraud
Blank = POS transaction or reversal reason unknown
Optional
authCardIssuer String 1 Card Issuer:
B = Card issued by processing financial institution
O = Card NOT issued by processing financial institution
Blank = Unknown
Optional
terminalVerificationResults String 10 Indicates the application status as registered at the terminal (Terminal Verification Results).
Blank = Unknown/not provided
Optional
cardVerificationResults String 10 The card verification results (CVR) indicate that exception conditions occurred during the current and previous transactions, as seen by the card.  The first two bytes indicate the length of the field if the Visa Integrated Circuit Card Specification (VIS) is being followed.
Blank = Unknown/not provided
Optional
cryptogramValid String 1 Indicates whether the authorization request cryptogram was valid:
I = Invalid
V = Valid
Blank = Unknown/not provided
Optional
atcCard String 5 Application transaction counter for chip cards or contactless cards. Counter maintained by the application in the ICC and incremented whenever the application is selected.
Blank = Unknown/not provided
Optional
atcHost String 5 Application transaction counter for chip cards or contactless cards, as held on the host system, for the last online transaction.
Blank = Unknown/not provided
Optional
RESERVED_03 String 2 Reserved.   Optional
tokenAssuranceLevel String 2 Contains a two-digit value ranging from 00 to 99 indicating the confidence level of the token to PAN/cardholder relationship.
Provided by the Token Service Provider
Optional
secondFactorAuthCode String 2 The second factor authentication code. Numeric values indicate Visa responses, and letter values indicate Mastercard responses.
Visa valid values:
00 = 3DS 1.0.2 or prior, All authentication methods
01 = 3DS 2.0 Challenge flow using static passcode
02 = 3DS 2.0 Challenge flow using One Time Passcode (OTP) via SMS method
03 = 3DS 2.0 Challenge flow using OTP via key fob or card reader method
04 = 3DS 2.0 Challenge flow using OTP via App method
05 = 3DS 2.0 Challenge flow using OTP via any other method
06 = 3DS 2.0 Challenge flow using Knowledge Based Authentication (KBA) method
07 = 3DS 2.0 Challenge flow using Out of Band (OOB) authentication with biometric method
08 = 3DS 2.0 Challenge flow using OOB authentication with App login method
09 = 3DS 2.0 Challenge flow using OOB authentication with any other method
10 = 3DS 2.0 Challenge flow using any other authentication method
97 = 3DS 2.0 Frictionless flow, RBA (Risk-based authentication) review
98 = 3DS 2.0 Attempts server responding
99 = 3DS 2.0 Frictionless flow, RBA (Risk-based authentication
Mastercard valid values:
J = ACS or ACS Stand-in processed (3D 1.0.2 SPA 1 Value)
H = Attempts processing (3D 1.0.2 SPA 1 Value)
KA = ACS processed without challenging cardholder (3D 2.0 SHA 256)
KB = ACS processed after challenging cardholder (3D 2.0 SHA 256)
KC = ACS Stand-in processed, RBA score (3D 2.0 SHA 256)
KD = ACS Stand-in processed, future use (3D 2.0 SHA 256)
KE = Attempts processing (3D 2.0 SHA 256)
KF = Attempts processing, future use (3D 2.0 SHA 256)
KG = ACS processed without cardholder challenge (3D 2.0 SHA 1)
KH = ACS processed after cardholder challenge (3D 2.0 SHA 1)
KJ  = ACS processed RBA Score (3D 2.0 SHA 1)
KK = ACS Stand-in processed, future use (3D 2.0 SHA 1)
KL = Attempts processing (3D 2.0 SHA 1)
KM = Attempts processing, future use (3D 2.0 SHA 1)
KN = Not Authenticated - Acquirer Exemption stronger SCA (3D 2.0 SHA 256)
KO = Authenticated - recurring shipment (3D 2.0 SHA 256)
KP = Authenticated using SCA - First in series of recurring shipment (3D 2.0 SHA 256) 
Optional
cavvKeyIndicator String 2 The CAVV key indicator:
01 = Issuer CAVV and/or CAAV attempts key set 1
02 = Issuer CAVV and/or CAAV attempts key set 2
03 = Issuer CAVV and/or CAAV attempts key set 3
04 = Issuer CAVV and/or CAAV attempts key set 4
05 = Issuer CAVV and/or CAAV attempts key set 5
06 = Issuer CAVV and/or CAAV attempts key set 6
07 = Issuer CAVV and/or CAAV attempts key set 7
08 = Issuer CAVV and/or CAAV attempts key set 8
10 = Association CAAV attempts first key set
11 = Association CAAV attempts second key set
Optional
recurringAuthExpireDate String 8 Deprecated.
Format: yyyymmdd
The date after which no recurring authorizations should be performed. For transactionType = U.
Optional
linkedAcctType String 1 Deprecated.
Which account was linked to this transaction?  Valid values:
B= Brokerage/Money market
C = Checking
K = Credit card
L = Line of credit
O = Other
S = Savings
U = Unknown
Optional
cardIncentive String 1 Deprecated.
Incentive program associated with the card, if any:
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
Blank = None
Optional
eciIndicator String 2 The ECI indicator. Valid values:
0 = not applicable
1 = single transaction of mail/phone order
2 = recurring transaction
3 = installment payment
4 = unknown classification
5 = secure electronic commerce transaction
6 = non-authenticated security transactions at a 3-D Secure capable merchant, and merchant attempted to authenticate using 3-D Secure
7 = non-authenticated security transaction
8 = non-secure transaction
Blank = Unknown/Other
Optional
cardPinSetDate String 8 Deprecated.
Format: yyyymmdd
The date on which the PIN was last set.
Optional
processorAuthReasonCode String 5 Processor's own code identifying reason for authorization decision.
Blank = Unknown/not provided
Optional
standinAdvice String 1 Valid values:
A = Association advice (stand-in)
Blank = No advice
Optional
merchantId String 16 Merchant ID (Card Acceptor ID).  Optional
cardOrder String 1 Deprecated.
The card order; indicates the card used:
1 = Primary card
2 = Secondary card
3 = Tertiary card
4 = Fourth card
5 = Fifth card
6 = Sixth card
7 = Seventh card
8 = Eighth card
9 = Ninth card or beyond
Blank = Unknown
Optional
cashbackAmount String 13 Format: nnnnnnnnnn.nn
Cash-back amount if transactionType = B (merchandise with cash back). Amount given in cash back on a merchandise transaction (for example, cash back at grocery store). Amount is expressed in currency unit specified in transactionCurrencyCode. 
Optional
userData06 String 13 User-defined information. Editable in Falcon Expert rules. Optional
userData07 String 40 User-defined information. Editable in Falcon Expert rules. Optional
paymentInstrumentId String 30 Unique identifier for the payment instrument.  Optional
avsRequest String 1 AVS (Address Verification Service) request indicator:
1 = AVS only (Must have (transactionType = A, transactionAmount = 0)
2 = AVS and authorization request
Blank = Unknown/not provided
Optional
cvrOfflinePinVerificationPerformed String 1 Offline PIN verification indicator from Card Verification Results:
1 = Offline PIN verification performed
0 = Offline PIN verification not performed
Blank = Unknown or not applicable
Optional
cvrOfflinePinVerificationFailed String 1 Offline PIN verification failure indicator from Card Verification Results:
1 = Offline PIN verification failed
0 = Offline PIN verification successful
Blank = Unknown or not applicable
Optional
cvrPinTryLimitExceeded String 1 Offline PIN try limit indicator from Card Verification Results:
1 = Offline PIN try limit exceeded
0 = Offline PIN try limit not exceeded
Blank = Unknown or not applicable
Optional
posUnattended String 1 Unattended terminal indicator:
1 = Unattended terminal
0 = Attended terminal
Blank = Unknown/other
Optional
posOffPremises String 1 Off-premises terminal indicator:
1 = Off-premises terminal
0 = On-premises terminal
Blank = Unknown/other
Optional
posCardCapture String 1 Terminal card-capture capability indicator:
1 = Terminal has card-capture capabilities
0 = Terminal does not have card-capture capabilities
Blank = Unknown/other
Optional
posSecurity String 1 Transaction security indicator:
0 = No security concern
1 = Merchant suspicious
2 = Customer identity verified
Blank = Unknown/not provided
Optional
authId String 6 Authorization Identification Response.   Optional
userData08 String 10 User-defined information. Editable in Falcon Expert rules. Optional
userData09 String 10 User-defined information. Editable in Falcon Expert rules. Optional
userIndicator05 String 1 User-defined information. Editable in Falcon Expert rules. Optional
userIndicator06 String 1 User-defined information. Editable in Falcon Expert rules. Optional
userIndicator07 String 5 User-defined information. Editable in Falcon Expert rules. Optional
userIndicator08 String 5 User-defined information. Editable in Falcon Expert rules. Optional
modelControl1 String 1 This field is used to control Falcon and Fraud Predictor model-specific features. See the model report for information on supported functionality. Optional
modelControl2 String 1 This field is used to control Falcon and Fraud Predictor model-specific features. See the model report for information on supported functionality. Optional
modelControl3 String 1 This field is used to control Falcon and Fraud Predictor model-specific features. See the model report for information on supported functionality. Optional
modelControl4 String 1 This field is used to control Falcon and Fraud Predictor model-specific features. See the model report for information on supported functionality. Optional
RESERVED_04 String 3 Reserved.   Optional
segmentId1 String 6 Segmentation ID.  Reserved for FICO modeling.  Optional
segmentId2 String 6 Segmentation ID.  Reserved for FICO modeling.  Optional
segmentId3 String 6 Segmentation ID.  Reserved for FICO modeling.  Optional
segmentId4 String 6 Segmentation ID.  Reserved for FICO modeling.  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_DBTRAN"
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_dbtran": {
            "header": {
                "msg_id": "1695040194",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_FALCON_DBTRAN",
                "src_application": "TIBCO",
                "target_application": "FALCON",
                "timestamp": "2023-09-18T15:30:22.771+03:00",
                "tracking_id": "1695040194",
                "bank_id": "default",
                "instance_id": "1695040194"
            },
            "body": {
                "tranCode": "101",
                "source": "TIBCO",
                "dest": "FLACON",
                "extendedHeader": "EXTENDEDHEADER120007",
                "workflow": "modelSTUB",
                "recordType": "DBTRAN25",
                "dataSpecificationVersion": "2.5",
                "clientIdFromHeader": "SiFi",
                "recordCreationDate": "20230914",
                "recordCreationTime": "080102",
                "recordCreationMilliseconds": "234",
                "gmtOffset": "+03.00",
                "customerIdFromHeader": "12345000000007",
                "customerAcctNumber": "000999111000000007",
                "externalTransactionId": "D360DBT000000001",
                "pan": "5430092198239488",
                "authPostFlag": "A",
                "cardPostalCode": "RIYADH09",
                "cardSeqNum": "001",
                "openDate": "20230122",
                "plasticIssueDate": "20230220",
                "plasticIssueType": "T",
                "acctExpireDate": "20250109",
                "cardExpireDate": "20230102",
                "expandedBIN": "5430092101",
                "dailyCashLimit": "1122334455",
                "tokenizationIndicator": "S",
                "tokenExpirationDate": "20240122",
                "consumerAuthenticationScore": "920",
                "incomeOrCashBack": "11002200",
                "cavvResult": "2",
                "peerGrouping": "Y",
                "transactionDate": "20230914",
                "transactionTime": "102001",
                "transactionAmount": "556677.99",
                "transactionCurrencyCode": "SAR",
                "transactionCurrencyConversionRate": "1000.00001",
                "authDecisionCode": "A",
                "transactionType": "M",
                "mcc": "5677",
                "merchantPostalCode": "JEDDAH01",
                "merchantCountryCode": "682",
                "pinVerifyCode": "V",
                "cvvVerifyCode": "V",
                "posEntryMode": "E",
                "postDate": "20230914",
                "authPostMiscIndicator": "N",
                "mismatchIndicator": "N",
                "caseCreationIndicator": "N",
                "userIndicator01": "A",
                "userIndicator02": "B",
                "userData01": "USER01DATA",
                "userData02": "USER02DATA",
                "onUsMerchantId": "MCID0001",
                "merchantDataProvided": "Y",
                "idMethod": "2",
                "externalScore1": 1111,
                "externalScore2": 2222,
                "externalScore3": 3333,
                "customerPresent": "Y",
                "atmOwner": "M",
                "randomDigits": "66",
                "portfolio": "MASSRETAIL",
                "tokenRequestorId": "TKNREQ001001",
                "acquirerBin": "563490",
                "merchantName": "PIZZA HUT RETAIL OUTLET",
                "merchantCity": "JEDDHAH",
                "merchantState": "JED",
                "caseSuppressionIndicator": "Y",
                "userIndicator03": "UID03",
                "userIndicator04": "UID04",
                "userData03": "UDAT3",
                "userData04": "UDAT4",
                "userData05": "USER DATA 05000000000000000000000000000X",
                "realtimeRequest": "R",
                "padResponse": "A",
                "padActionExpireDate": "20230914",
                "tokenId": "TKNID00100111",
                "cardAipStatic": "Y",
                "cardAipDynamic": "Y",
                "RESERVED_01": "",
                "cardAipVerify": "Y",
                "cardAipRisk": "Y",
                "cardAipIssuerAuthentication": "Y",
                "cardAipCombined": "Y",
                "cardDailyLimitCode": "1",
                "availableBalance": "-123456789.99",
                "availableDailyCashLimit": "-123456789.99",
                "availableDailyMerchandiseLimit": "-123456789.99",
                "atmHostMcc": "9090",
                "atmProcessingCode": "ATMP98",
                "atmCameraPresent": "Y",
                "cardPinType": "C",
                "cardMediaType": "V",
                "cvv2Present": "1",
                "cvv2Response": "M",
                "avsResponse": "A",
                "transactionCategory": "I",
                "acquirerId": "ACQID1234567",
                "acquirerCountry": "682",
                "terminalId": "TRMID12345678901",
                "terminalType": "I",
                "terminalEntryCapability": "1",
                "posConditionCode": "00",
                "networkId": "V",
                "RESERVED_02": "",
                "authExpireDateVerify": "V",
                "authSecondaryVerify": "V",
                "authBeneficiary": "D",
                "authResponseCode": "A",
                "authReversalReason": "0",
                "authCardIssuer": "B",
                "terminalVerificationResults": "TRMVERAPPR",
                "cardVerificationResults": "CRDVERAPPR",
                "cryptogramValid": "V",
                "atcCard": "71212",
                "atcHost": "80901",
                "RESERVED_03": "",
                "tokenAssuranceLevel": "99",
                "secondFactorAuthCode": "01",
                "cavvKeyIndicator": "02",
                "recurringAuthExpireDate": "20231001",
                "linkedAcctType": "K",
                "cardIncentive": "C",
                "eciIndicator": "2",
                "cardPinSetDate": "20230501",
                "processorAuthReasonCode": "PRAPR",
                "standinAdvice": "A",
                "merchantId": "MID1234567890111",
                "cardOrder": "1",
                "cashbackAmount": "123456789.11",
                "userData06": "USER DATA 006",
                "userData07": "USER DATA 07000000000000000000000000000X",
                "paymentInstrumentId": "PYID12345678901234567890",
                "avsRequest": "1",
                "cvrOfflinePinVerificationPerformed": "1",
                "cvrOfflinePinVerificationFailed": "0",
                "cvrPinTryLimitExceeded": "0",
                "posUnattended": "0",
                "posOffPremises": "0",
                "posCardCapture": "0",
                "posSecurity": "0",
                "authId": "ATH001",
                "userData08": "USERDATA08",
                "userData09": "USERDATA09",
                "userIndicator05": "A",
                "userIndicator06": "T",
                "userIndicator07": "UIND7",
                "userIndicator08": "UIND8",
                "modelControl1": "M",
                "modelControl2": "O",
                "modelControl3": "D",
                "modelControl4": "L",
                "RESERVED_04": "",
                "segmentId1": "SEGID1",
                "segmentId2": "SEGID2",
                "segmentId3": "SEGID3",
                "segmentId4": "SEGID4"
            }
        }
    }
}
 

Response Json

 
{
    "response_dbtran": {
        "header": {
            "msg_id": "1695040194",
            "msg_type": "TRANSACTION",
            "msg_function": "REP_FALCON_DBTRAN",
            "src_application": "TIBCO",
            "target_application": "FALCON",
            "timestamp": "2023-09-18T15:30:22.771+03:00",
            "tracking_id": "1695040194",
            "bank_id": "default"
        },
        "exception_details": {
            "application_name": "",
            "date_time": "2023-09-18T15:30:22.75+03:00",
            "status": "S",
            "error_code": "000",
            "error_description": "Success"
        },
        "body": {
            "tran_code": "101",
            "source": "PMAX",
            "destination": "TIBCO",
            "extended_header": "EXTENDEDHEADER120007",
            "responseRecordVersion": "4",
            "scoreCount": "00",
            "decisionCount": "0"
        }
    }
}