Credit/Deposit Amount

This Webhook is used to credit the amount in real-time to the Beneficiary Account.
INFO
This Webhook will be triggered every 15 seconds until a request is received in the Confirm Credit API against the txn_number received with this Webhook.
The maximum number of triggers is limited to 10.
WARNING
This Webhook does not require a response as a supplementary request to Confirm Credit API is mandatory.
IMPORTANT
If any entity fails to attempt to Confirm Credit API, a refund request will be automatically generated against the completed debit transaction.

Request

IMPORTANT
You must add the following callback URIs to the webhook profile to receive requests from us.
  • creditAmount: For non-cash transactions.
  • depositAmount: For cash transactions.

Parameters

Parameter
Type
Description
user
Object
country_code
String
Country code for the mobile number. Character length : 2 Eg: 91
mobile
String
Mobile number of user. Character length : 10 Eg: 9876543210
branch_code
String
Branch code holding account number. Eg: BR001
account_number
String
User account number to be debited. Eg: 0386780199100
account_type
String
This helps to identify the type of account. Refer
Allowed values: SA, CA, TL, OD
Eg: SA
account_class
String
Classification of account under account_type. Character length: 30 (Max) Eg: AGRICULTURAL LOAN
transaction
Object
txn_number
String
A Unique Transaction Number. Refer Eg: 02166814365694072422429
txn_urn
String
A Unique Transaction Reference Id. Refer
Eg: LJOTHD1668143656985ZBSVPV
txn_type
String
The type of transaction. Find transaction types
Allowed values: CREDIT, RF_CREDIT
Eg: CREDIT
txn_nature
String
The nature of the transaction. Find transaction nature
Eg: INTERPE
txn_note
String
The user added note for reference. Eg: Testing - IMPS
txn_date
String
The date of transaction.
Format: YYYY-MM-DD Eg: 2020-11-03
txn_time
String
The time of transaction.
Format: hh:mm A Eg: 07:47 PM
txn_ts
String
The timestamp of the transaction. Eg: 1667367750
txn_amount
String
Transaction amount. This will be a natural number. Eg: 1200.99
txn_service_charge
String
The amount charged by the entity to the customer for using Rimit's services (excluding taxes if applicable) will be a natural number.
Default value: 0 (Zero). Eg: 1
txn_sp_fee
String
The bank/service provider charge for facilitating the transaction (excluding taxes if applicable) will be a natural number. Default value: 0 (Zero). Eg: 3
txn_fee
String
Fees charged by Rimit to User for any Services (excluding taxes if applicable) will be a natural number. Default value: 0 (Zero). Eg: 25
settlement
Object
account_type
String
The account type used for settlement. Find more about account type.
Eg: DSA
account_number
String
The account number used for settlement. Find more about the account number.
Eg: 3012000000000
IMPORTANT
  • If txn_type is CREDIT, txn_service_charge , txn_sp_fee & txn_fee should be debited.
  • If txn_type is RF_CREDIT ,txn_service_charge , txn_sp_fee & txn_fee can be credited back according to the request payload.
  • These charges/fees are exclusive of taxes. The Entity should take care of necessary tax adjustments according to the txn_type.

Request format

Encrypted
Decrypted
{
"head": {
"api": "creditAmount",
"apiVersion": "V1",
"timeStamp": "2023-02-02 11:54:14 AM"
},
"encrypted_data": {
"cipher_text": "ngwyBmBTNumQ2CowOsH4LmXdjGlpNowI2CSFRlivWXDv0WYqyv6ktBaWBc4ZnR+pbkDqkoepAoiLSkhbbPZ/4O99SiUzq0+ke5H36kLwryUde9/UbQ37Al8F+jq/MN4cMnkwlLtlqT7lVCaX2vukoESXwXkkg6QWrJ3jA1xQuPi4BGYr35Ml52WywqWAQbkdPp2awuqknwk00PqiU1lklgLUwIDGN+UtKJq3h/HXrbYJ4QDk+A8zRYP4dIuZ2f015R12LHJZvwEUgkjHwxUaoCi3NKYfwNz5hFE0RNb4LxKTve7AqNGCycN3fSrmTgdJKZ/Xrfe8qK1gx6UjVyuRC0VRmIVDnWJF3ni994kF1004oYAbo7E8SAhEuGqbrMqIXwEKGc9ScJdg7dMu8mMGHLDuwdn/ZzwZM8eaeBBHsR+HBoIAd5dziEURdC5IWchxSiHdIEQVfwXtd22uZJhIOMv3m1JtyJtEI2RaUhWsJByUi7p4nRgiL+Cmsz8Wq7JIsu9rIjQD3NkZw9/8XEls+ttX8gzspQouu6EcIacilT7BTP7o8sPTiErMP3U8ZwTMZGxW8SIiBtQHNVVghR+P1uPwL4R1IkmXG2Cex96/ALde3R/qQoiMz4CcA+WfDL/CFclcCVvuUlpLllunJml9dw==",
"iv": "35b076584a830310",
"hash": "15a8e779871c4e1c3ab5c647cb6db5d4c0eabc1928fc17a325ec4f19282294c9"
}
}
{
"head": {
"api": "creditAmount",
"apiVersion": "V1",
"timeStamp": "2023-02-02 11:54:14 AM"
},
"content": {
"data": {
"user": {
"country_code": "91",
"mobile": "1111111131",
"branch_code": "BR001",
"account_number": "PBCI0386780199100",
"account_type": "SA",
"account_class": "SAVING"
},
"transaction": {
"txn_number": "02167531905089890064812",
"txn_urn": "AGWEPZ1675319054371AFEZWT",
"txn_type": "RF_CREDIT",
"txn_nature": "BANK",
"txn_note": "testing - IMPS",
"txn_date": "2023-02-02",
"txn_time": "11:54:14 AM",
"txn_ts": "1675319054",
"txn_amount": "1000",
"txn_service_charge": "0",
"txn_sp_fee": "1.5",
"txn_fee": "0"
},
"settlement": {
"account_type": "DVA",
"account_number": "13200000005",
},
}
}
}