Debit/Withdraw Amount

This Webhook is used to debit the amount from the requested user's account of the remitter entity.

INFO

This Webhook will be triggered every 15 seconds until a request is received in the Confirm Debit API against the txn_number received with this Webhook.

The maximum number of triggers is limited to 10. The transaction will automatically be cancelled if the entity does not trigger the Confirm Debit API.

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

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: DEBIT, RF_DEBIT Eg: DEBIT
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: 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 is DEBITor RF_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

Encrypted

{
    "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"
    }
}

Decrypted

{
    "head": {
        "api": "debitAmount",
        "apiVersion": "V1",
        "timeStamp": "2023-02-02 11:54:10 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": "UYYITS1675319050958YYJIHW",
                "txn_type": "DEBIT",
                "txn_nature": "BANK",
                "txn_note": "testing - IMPS",
                "txn_date": "2023-02-02",
                "txn_time": "11:54:10 AM",
                "txn_ts": "1675319050",
                "txn_amount": "1000",
                "txn_service_charge": "0",
                "txn_sp_fee": "1.5",
                "txn_fee": "0"
            },
            "settlement": {
                "account_type": "DVA",
                "account_number": "13200000005",
            },
            "authentication": {
                "mode": "PRE_APPROVED",
                "hash": "",
                "signature": ""
            }
        }
    }
}