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 Name | JSON Field Name | Data Type |
|---|---|---|
| Customer Code | customerCode | Text |
| Beneficiary Account No | beneficiaryAccountNo | Text |
| Beneficiary Account IFSC | beneficiaryAccountIFSC | Text |
| Beneficiary Full Name | beneficiaryFullName | Text |
| Transfer Type | transferType | Text |
| Transfer Unique No. | transferUniqueNo | Text |
| Transfer Time | transferTimestamp | Text (YYYY-MM-DD 24HH:MM:SS ) |
| Transfer Currency | transferCurrency | Text |
| Transfer Amount | transferAmount | Number with Two decimal places |
| Remitter Account No. | remitterAccountNo | Text |
| Remitter Account IFSC | remitterAccountIfsc | Text |
| Remitter Account Type | remitterAccountType | Text |
| Remitter Full Name | remitterFullName | Text |
| Remitter Address | remitterAddress | Text |
| Remitter to Beneficiary Note | remitterToBeneficiaryNote | Text |
| Status | status | Text |
| Attempt No | attemptNo | Text |
| Credited At | creditedAt | Text (YYYY-MM-DD 24HH:MM:SS ) |
| Retuned At | returnedAt | Text (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 Body | HTTP Response Status |
|---|---|
| {} | 200 |
KYC Status
This is the webhook for intimation of KYC status for a user.
| Parameter Name | JSON Field Name | Data Type |
|---|---|---|
| User Id | userId | Text |
| KYC Approval | kycApproval | Text Any one of four values: -SUCCESS -FAILURE -PENDING -UNSUCCESSFUL |
| Date | date | Text (yyyy-MM-dd'T'HH:mm:ss'Z') |
| KYC Status | kycStatus | Text Any one of two values: - MIN - FULL |
| Reason for Failure | failureReason | Text |
| 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 Body | HTTP Response Status |
|---|---|
| {} | 200 |
Biometric KYC Agent Details
This webhook is for intimation of biometric KYC agent details.
| Parameter Name | JSON Field Name | Data Type |
|---|---|---|
| Agent Name | agentName | Text |
| Agent ID | agentUserId | Text |
| Agent Mobile Number | agentMobileNumber | Text |
| Agent DOB | agentDateOfBirth | Text (yyyy-MM-dd'T'HH:mm:ss'Z') |
| Agent Organisation Name (if any) | agentOrganisationName | Text |
| Sample Request |
|---|
| { "agentName": "Ritesh Singla", "agentUserId": "645601e1-05e0-4721-a383-9c2d1024b16d", "agentMobileNumber": "+919988711898", "agentDateOfBirth": "Sun Aug 10 00:00:00 IST 1997", "agentOrganisationName": "nonjit" } |
SAMPLE RESPONSE
| Response Body | HTTP Response Status |
|---|---|
| {} | 200 |
Check ATM Balance
This is the webhook for ATM Balance Enquiry.
| Parameter Name | JSON Field Name | Data Type |
|---|---|---|
| User ID | userId | Text |
| Card ID | cardId | Text |
| Transaction | transaction | |
| RRN | rrn | Text |
| Transaction Date | transactionDate | Text (yyyy-MM-dd'T'HH:mm:ss'Z') |
| Transaction Amount | transactionAmount | Number with Two decimal places |
| Transaction Currency | transactionCurrency | Text |
| Payment Channel | paymentChannel | Text |
| Card Balance | cardBalance | Number with Two decimal places |
| Sample Request |
|---|
| { "userId": "f4793f68-fff3-484f-8e4e-ca08672e35d7", "cardId": "916d629b-fbde-4274-9f5d-c8e562f62fb2", “transaction”: { "referenceId": "30000001553499116", "transactionDate": "2013-09-29T18:46:19Z", "transactionAmount": 0, “transactionCurrency”: “INR”, “paymentChannel”: ”ATM”, “cardBalance”: ”1500.00”, } } |
SAMPLE RESPONSE
| Response Body | HTTP Response Status |
|---|---|
| {} | 200 |