Financial Transaction Event

This webhook is triggered in various financial transaction event. At any point of time, there is an effective debit or credit to the cardholder account, this webhook is triggered. This webhook is triggered in below scenarios:

Authorisation Transaction (ATM, POS, ECOM)
Authorisation Advice Transaction (Pre-auth completion)
Reversal Transaction (This is also known as Base I or Online Reversals. This occurs if the transaction has failed due to timeout or incorrect data elements. This could happen at Issuer, Network or Acquirer).
Reversal Advice Transaction (This is same as Reversal Transaction but this occurs if the Issuer has not responded properly to the Reversal Request).
Refunds in the clearing
Surcharges in the clearing
Manual adjustments (debit) by the recon team

{
   "entry_id":"ent_123456789877654321",
   "txn_log_id":"txn_123456789877654321",
   "account_id":"acc_123456789877654321",
   "card_id":"crd_123456789877654321",
   "user_id":"usr_4a33eea0234e4f558",
   "txn_indicator":"Debit",
   "txn_type":"AUTH",
   "txn_code": "DEBIT"
   "txn_status":"0",
   "txn_date":"2019-09-05T10:19:00.169615Z",
   "stan":"435892",
   "aid":"089472",
   "mid":"TUFANGANJ NEAR",
   "terminal_id":"00058015",
   "auth_code":"ABCDEF",
   "rrn":"5805 ",
   "channel":"ATM",
   "merchant":"TUFANGANJ (NEAR HOSPIT /TUFANGANJ / I/ND",
   "mcc":"6011",
   "remarks":"",
   "txn_amount":1000000,
   "pan_entry_mode": "CHIP",
   "location": "DOM",
   "txn_currency":{
      "alpha_code":"INR",
      "numeric_code":356
   },
   "acquiring_amount":1000000,
   "acquiring_currency":{
      "alpha_code":"INR",
      "numeric_code":356
   },
   "target_account_balance":[
      {
         "currency":"INR",
         "balance":2996000
      }
   ],
   "funding_account_balance":[
      {
         "currency":"INR",
         "balance":9706587
      }
   ],
   "rha":{
      "configured":true,
      "response_status":200
   },
   "original_txn_id":"txn_prev_log_id",
   "fee_type":"Surcharge",
   "rule_violation_info":{
      "rule_id":"rul_12345432",
      "msg":"Transactions on ATM is blocked."
   },
   "pan_entry_mode":"MANUAL",
   "is_mandate_txn":true,
   "mandate_detail":{
      "mandate_id":"si_123frn5i55vtn454",
      "end_date":"2024-08-01T00:00:00Z",
      "freq_ind":"MONTHLY",
      "init_date":"02",
      "number_of_instalments":1,
      "max_amount":1000,
      "min_amt":500,
      "mode":"SMS_AND_EMAIL",
      "start_date":"2023-07-02T00:00:00Z"
   },
   "is_emi_txn":true,
   "emi_detail":{
      "emi_id":"emi_f8949c4df40646178f93d3b0c85fa009",
      "amt":500,
      "interest_rate":500,
      "number_of_instalments":500,
      "total_amount":500
   }
}

Field Name

Data Type

Required (O/M)

Description

aid

String

Acquirer Id

rrn

String

Retrieval Reference Number

terminal_id

String

Terminal Id

txn_indicator

String

Define Credit or Debit

stan

String

entry_id

String

Unique reference to the entry of the transaction

txn_type

String

Refer below for more details

txn_log_id

String

Unique reference to the transaction

txn_status

String

Status of the transaction. 0 = Success Rest all = failure for various reasons

mid

String

Merchant Id

auth_code

String

Authorization Code

txn_date

String

Transaction Date time stamp

channel

String

Mode of the transaction (POS, ATM, ECOM)

merchant

String

Merchant Name

account_id

String

Account Id of the user

mcc

String

Merchant category code

remarks

String

txn_amount

Numeric

Transaction Amount

txn_currency

String

Transaction Currency

acquiring_amount

Numeric

Transaction’s Acquiring Amount

acquiring_currency

String

Transaction’s Acquiring Currency

card_id

String

Reference to the card

target_account_balance

List

funding_account_balance

List

user_id

string

User Id for the Card Holder

rha.configured

bool

If RHA configure True else False

rha.response_status

int

Response Code of the RHA Request

original_txn_id

string

In case of a reversal, Txn Log Id of parent txn comes

fee_type

string

Type of fee charged

rule_violation_info.rule_id

string

If a txn is failed due to a rule-violation its rule_id will be provided

rule_violation_info.msg

string

If a txn is failed due to rule-violation then the meaning/description of the rule holds here.

pan_entry_mode

string

Infomation about the Entry Mode of Card, more details below.

is_mandate_txn

bool

Indicates if the transaction is a mandate transaction

mandate_detail.mandate_id

string

Mandate id populated by npci during mandate registration

mandate_detail.card_pan

string

Reference number for the card PAN

mandate_detail.start_date

string

Mandate start date

mandate_detail.end_date

string

Mandate end date

mandate_detail.freq_ind

string

Mandate frequency indicator(DAILY/WEEKLY)

mandate_detail.mode

string

SMS/EMAIL/SMS&EMAIL

mandate_detail.min_amt

numeric

Minimum amount for which SI can be initiated

mandate_detail.max_amt

numeric

Maximum amount for which SI can be initiated

mandate_detail.number_of_instalments

numeric

Denotes total number of payment instalments

mandate_detail.init_date

string

Preferred day for SI initialisation

is_emi_txn

bool

Denotes if its an EMI transaction

emi_detail.emi_id

string

Reference to the emi

emi_detail.amt

numeric

Emi amount

emi_detail.total_amt

numeric

Total amount

emi_detail.interest_rate

numeric

Emi interest rate

emi_detail.number_of_instalments

numeric

Number of emi instalments

txn_code

string

additional info on txn_type

Notes:

Optional Parameter (O) may or may not come depending upon the Transaction type & Response
"rha" field will come for RHA enabled clients and only in case of RHA calls made to the client.
"rule_violation_info" field does come only when the txn is failed due to rule-violation and the rules’s description is not empty.
"mandate_detail" field will available for Mandate based transactions.
"emi_detail" field will be available for EMI based transactions.
txn_type is just additional information. It is advisable not to use any kind of business logic on this. However, txn_indicator gives the Debit/Credit indication
In case of Fee/Surcharge charge on a txn, an additional webhook comes along with the Parent txn webhook, that additional webhook will contain fee_type key and its value will explain the type of fee. Below is the diff types of fee_type which currently charged:
- ATM Balance Enquiry
- ATM Fee
- Surcharge
- Surcharge C@P
- Cashback

Different values of Transaction Type - txn_type:

txn_type

Description

txn_indicator

AUTH

Card Authorization transaction

Debit

AUTH_ADVICE

For any card authorization, if any pre-auth was done, you will get the actual transaction details here.

Debit

REVERSAL

This is the immediate reversal of the authorized transactions.

Credit

REVERSAL_ADVICE

This is the immediate reversal of the authorized transactions.

Credit

CLEARING_REVERSAL OR CR_EXTEND_LIMIT

This is the reversal due to settlement - An example: Payments on Credit Flipkart/Amazon. If you are returning an item, the refund amount gets posted back to the cardholder. Here the txn_type will be CLEARING_REVERSAL. This is basically known as Refunds.

Credit

FP_AE_CLEARED OR FP_AE_EXTEND_LIMIT

This is the reversal due to Acquirer Merchant Claim - If the cardholder does a Credit AUTH transaction of 1000 INR and the acquirer merchant claims only 990 INR, then a reversal of 10 INR is posted to the cardholder. Here the txn_type will be F P_AE_CLEARED. This scenario is very less frequent.

Credit

FP_CE_CLEARED OR FP_CE_WITHDRAW_LIMIT

n case, the acquirer merchant claims more than the authorized Debit transaction(surcharge on IRCTC, fuel stations, etc), an extra debit is posted to the cardholder.

Debit

ADJUSTMENT

When merchant sends the first presentment for a transactions which was immidiately reversed, we create a transaction of type ADJUSTMENT to debit the cardholder.

Debit

Different values of PAN Entry Mode

Pan Entry Mode Name

Description

BLANK

CHIP

ATM TXN is happening with CHIP

CONTACTLESS_CHIP

Tap n Pay with CHIP

CONTACTLESS_MAGSTRIPE

Tap n Pay with MAGSTRIPE

ECOM

It is an Online Txn

FULL_MAGSTRIPE_READ

Swipe Transaction with Full magnetic strip read

ICCR

Integrated Circuit Chip Read

MAGSTRIPE_FALLBACK

When The terminal is not able to the read the CHIP data, it falls back to the default magnetic strip

MAGSTRIPE_READ

Swipe Transaction with magnetic strip read

MANUAL

When card number is entered manually on the terminal

UNKNOWN

PreviousTransactional Events NextNon Financial Transaction Event

Last updated 2 years ago