Debit/Withdraw Amount
This Webhook is used to debit the amount from the requested user's account of the remitter entity.
WARNING
This Webhook
does not require a response as a supplementary request to Confirm Debit API is mandatory.
Request
IMPORTANT
You must add the following callback URIs to the webhook profile to receive requests from us.
debitAmount
: For non-cash transactions.withdrawAmount
: For cash transactions.
Parameters
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
account_class
String
Classification of account under account_type. Character length: 30 (Max) Eg: AGRICULTURAL LOAN
transaction
Object
txn_type
String
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_number
String
The account number used for settlement. Find more about the account number.
Eg: 103200000001
authentication
Object
(Part of the v2 update. Not currently required.)
mode
String
From where authentication is handled.
Default value: PRE_APPROVED
Eg: PRE_APPROVED
hash
String
The hash value of the authentication pin.
signature
String
A digital signature used to verify the authenticity and integrity of the authentication pin.
IMPORTANT
If
txn_type
isDEBIT
orRF_DEBIT
,txn_service_charge
,txn_sp_fee
&txn_fee
should be debited.These charges/fees are exclusive of taxes. The entity can add taxes along with these amounts while debiting the
txn_amount
as per provisions.
Request format
{
"head": {
"api": "debitAmount",
"apiVersion": "V1",
"timeStamp": "2023-02-02 11:54:10 AM"
},
"encrypted_data": {
"cipher_text": "KIuSWwvaayx/YLAwSXxd8T3ioUTOPtaSZbsa7h/C/r5Lm/MiEptsFTQgpy5ugP+KO1a8C+NBAxwAyD511IIz7CKa3jIpRtgdCTmap1lNtR6mzPCTkwqjJG2dI9qBe7+aHQeNwbpSNfzMcU1isSJBMDjZvc4A6VEabiH0ZBu+TrZSNDS8AmrL5x4tRnp3JuhPB7EuvPy2SCKDy8iJJLPXbS2fbW9k+9oqhvw3M1Eay2YL5O/lQ2yZjjh33017l4ap6Q8kRp2hq3GxtbtjDplWeCtdSYDGALYJc/kxNwQoudTVMkHVifuI55gP76ClTiog66lkfnvaq/gzJM717Kk3eTMpCgO0L5B/gAFm3KyQA3yZjbXgpi/0/aIIghvOb3RsvbhmeuNUI9nUhJHwbrWhPcr7Z76tCBnTsePxA+j6DMXAFy+o4feRMXA1C4YW5f9NFGUMqI5sJAsJAb0hz/FRHaMxvG9qg9hOVrqS5Km5DyAtkbdbgsJ7d1TuNF9fm/XpmA6IQ/5WKrQQj9qHfffRVHw4WbdwJt8baY7Oe36oYeqDGwpC3R81q985ty1He78/vh740rysGindq6/wPAXzzEeDMEAPBetHGMXpiCq6YwusVarVplzlIqpXDkojimumNia66cWnFQKhncfqmmrRmSpqsWlnnbm+x9nioU5kDqdZYW2nUsaQotA/Se83Cyk/60A+FM3eGU+UDgOEP/VlSq/27jDw+O5vG/ih4a+xFmU=",
"iv": "c05a2e24471c7b67",
"hash": "4bdebe3e26cf4379f6aaca6413533f1be4a729056deba6bba6829befe67eb825"
}
}
Last updated