API References

Falcon provides webhooks which can be consumed by the partners. To consume the following webhooks, please share respective endpoints to [email protected].
You can simulate the webhooks in the UAT environment using this portal - http://simulator.stage.uat.kitecash.in/

Virtual Account Transfer (Notify)

This is the webhook for intimation of a Virtual Account transaction event.

Parameter NameJSON Field NameData Type
Customer CodecustomerCodeText
Beneficiary Account NobeneficiaryAccountNoText
Beneficiary Account IFSCbeneficiaryAccountNoText
Beneficiary Full NamebeneficiaryFullNameText
Transfer TypetransferTypeText
Transfer Unique No.transferUniqueNoText
Transfer TimetransferTimestampText (YYYY-MM-DD 24HH:MM:SS )
Transfer CurrencytransferCurrencyText
Transfer AmounttransferAmountNumber with Two decimal places
Remitter Account No.remitterAccountNoText
Remitter Account IFSCremitterAccountIfscText
Remitter Account TyperemitterAccountTypeText
Remitter Full NameremitterFullNameText
Remitter AddressremitterAddressText
Remitter to Beneficiary NoteremitterToBeneficiaryNoteText
StatusstatusText
Attempt NoattemptNoText
Credited AtcreditedAtText (YYYY-MM-DD 24HH:MM:SS )
Retuned AtreturnedAtText (YYYY-MM-DD 24HH:MM:SS )
Sample Request
{
"customerCode": "TESTX1",
"beneficiaryAccountNo": "TESTX176235233",
"beneficiaryAccountIfsc": "YESB0CMSNOC",
"beneficiaryFullName": "reds",
"transferType": "NEFT",
"transferUniqueNo": "7346tyeghd",
"transferTimestamp": "2018-03-27 17:29:17",
"transferCurrency": "INR",
"transferAmount": 43.00,
"remitterAccountNo": "87654356789",
"remitterAccountIfsc": "hdfc0123456",
"remitterAccountType": "ca",
"remitterFullName": "refd",
"remitterToBeneficiaryNote": "pass",
"attemptNo": 1,
"status": "CREDITED",
"creditedAt": "2017-07-27 11:48:02"
}

SAMPLE RESPONSE

Response BodyHTTP Response Status
{}200

KYC Status

This is the webhook for intimation of KYC status for a user.

Parameter NameJSON Field NameData Type
User IduserIdText
KYC ApprovalkycApprovalText
Any one of four values:
-SUCCESS
-FAILURE
-PENDING
-UNSUCCESSFUL
DatedateText (yyyy-MM-dd'T'HH:mm:ss'Z')
KYC StatuskycStatusText
Any one of two values:
- MIN
- FULL
Reason for FailurefailureReasonText
Sample Request
{
"userId": "01933274-29ee-45bd-a259-999f624a7604",
"kycApproval": "SUCCESS",
"date": "2021-06-22T01:02:47Z",
"kycStatus": "FULL",
"failureReason": "PAN OCR extraction failed"
}

SAMPLE RESPONSE

Response BodyHTTP Response Status
{}200

Card Transaction (Post Auth)

This is the webhook for intimation of a card transaction event.

Parameter NameJSON Field NameData Type
Card IdcardIdText
User IduserIdText
Transactiontransaction-
Reference IdreferenceIdText
Transaction DatetransactionDateText (yyyy-MM-dd'T'HH:mm:ss'Z')
Transaction StatusstatusText
(SUCCESS or FAILURE)
Transaction AmounttransactionAmountNumber with Two decimal places
FeesfeesNumber with Two decimal places
TaxtaxNumber with Two decimal places
Total AmounttotalAmountNumber with Two decimal places
Transaction CurrencytransactionCurrencyText
Payment ChannelpaymentChannelText
NetworknetworkText
RRNrrnText
Merchantmerchant-
Merchant NamemerchantNameText
Country CodecountryCodeText
Merchant Category CodemccNumber
Merchant IdmerchantIdText
Sample Request
{
"cardId": "916d629b-fbde-4274-9f5d-c8e562f62fb2",
"userId": "f4793f68-fff3-484f-8e4e-ca08672e35d7",
“transaction”: {
"referenceId": "30000001553499116",
"transactionDate": "2013-09-29T18:46:19Z",
"status": "SUCCESS",
"transactionAmount": 195.50,
"fees": 10.00,
"tax": 1.00,
“totalAmount”: 206.50,
“transactionCurrency”: “INR”,
“paymentChannel”: ”MANUALLY_KEYED_ECOM”,
“network”: ”Master”,
“rrn”: “22345523”
},
“merchant”: {
"merchantName": "Test Merchant Limited",
“countryCode”: ”TWN”,
“mcc”:0780,
“merchantId”:”M30M33421S”
}
}

SAMPLE RESPONSE

Response BodyHTTP Response Status
{}200