Confirm Debit

This API is used to confirm the transaction by debiting the amount from the remitter user account.
MANDATORY
Method: POST
API URL: BASE_URL/transaction/confirmDebit
INFO
This API can only be used by the remitter entity of the respective transaction.
WARNING
  • If the txn_nature in the Debit Amount Webhook is CASH call the Confirm Debit API with the status HOLD(1002) in realtime.
  • When the user receives money from the entity's cash counter, call the Confirm Debit API realtime and confirm the status asSUCCESS.
  • The txn_reference must be the same for HOLD(1002) and SUCCESS/FAILED for the same transaction if the txn_nature is CASH.
  • If the transaction is not completed, it will expire and be marked as FAILED within a maximum of 12 hours.
MANDATORY
If the txn_nature in the Debit Amount Webhook is other than CASH call the Confirm Debit API with the status SUCCESS / FAILED in realtime.

Request

Parameters

Parameter
Type
Description
auth
Object
API_ID
String
Unique ID generated from the dashboard. Eg: 1a21as51a351f1155f
API_KEY
String
Unique KEY generated from the dashboard. Eg: AAD5451FS654SD6F5SD46F3S1D5S
result
Object
code
Integer
Status code for the transaction request. Find result codes
status
String
The status against transaction created. Allowed values: SUCCESS, FAILED, HOLD
data
Object
txn_nature
String
The nature of the transaction. Find transaction nature
Eg: INTERPE
txn_type
String
The type of transaction. Find transaction types
Allowed values: DEBIT, RF_DEBIT
Eg: DEBIT
txn_number
String
A Unique Transaction Number. Refer Eg: 02166814365694072422429
txn_urn
String
A Unique Transaction Reference Id. Refer
Eg: LJOTHD1668143656985ZBSVPV
txn_amount
String
Transaction amount debited from the remitter account. Eg: 1200.99
txn_reference
String
A unique transaction reference id created by the remitter entity. Eg: 123456789ghhg08nxv
account_balance
String
The latest balance after debiting the txn_amount. Eg: 1200.99

ON FIRST REQUEST

  • Send request as SUCCESS if the remitter user's account has sufficient balance. Else status must beFAILED.
  • Use HOLD only if the txn_nature in the Debit Amount Webhook is CASH.

Request format

Encrypted
SUCCESS / HOLD
FAILED
{
"head": {
"api": "confirmDebit",
"apiVersion": "V1",
"timeStamp": "2023-01-13 11:07:31 AM",
"auth": {
"API_ID": "6360b30096066b82e9697996",
"API_KEY": "b54996b0-59a8-11ed-911b-87fca52fd2dc"
}
},
"encrypted_data": {
"cipher_text": "3/RjQRwHHmKBZnotlKT0EhDHHv5GC9vnqgADKaqrYTOCjKhKhQ3JY7bFIweX4iiik8uCKNeCekJBkHNPApmFKc8hCphQoH6fu2NPE5wyhM3Tj8hYj4WI7thul3apvZd0ebfo7u/vlBbLme3LKJ/AXUrF3Ir9xFPg1K0Mfdy4VqYAjHyV2+nJYuavR7eOit5DBFo3pp9WfDrxO3OehGeB97bPhIcHHmS4/3+NhIKcoXDy1goNEi7w7IckhGh+S37MJbDZhtBXGDi/FVNUcrR0LYbHyPlbtdNuAbnXo6CduCQmdSX4iS6a6g3cZOcrW/XsmdiHalI/zYZb4FJV83YaEJJ6hTaCCEmZ3eq7xNMszwAWqeMO7Wf3zOiWfW3wovslzhUGf0xz5s2F7W2jzwB6dV6cJY+PehQ+25a325J7O1c=",
"iv": "63e3e8a23f4b364b",
"hash": "b38f94ec51695c61f4b65efc48b06dfd8a3b9732476eb4bf50723d937b431207"
}
}
{
"head": {
"api": "confirmDebit",
"apiVersion": "V1",
"timeStamp": "2023-01-13 11:07:31 AM",
"auth": {
"API_ID": "6360b30096066b82e9697996",
"API_KEY": "b54996b0-59a8-11ed-911b-87fca52fd2dc"
}
},
"content": {
"result": {
"code": 1001,
"status": "SUCCESS",
"message": "The request is successfully processed"
},
"data": {
"txn_urn": "BDXPBZ1673588251820ZUNTCD",
"txn_number": "01167358825176067931888",
"txn_reference": "RWCY6219897357242",
"txn_amount": "100",
"txn_type": "DEBIT",
"txn_nature": "INTERPE",
"account_balance": "1200"
}
}
}
{
"head": {
"api": "confirmDebit",
"apiVersion": "V1",
"timeStamp": "2023-01-12 06:42:25 AM",
"auth": {
"API_ID": "6360b30096066b82e9697996",
"API_KEY": "b54996b0-59a8-11ed-911b-87fca52fd2dc"
}
},
"content": {
"result": {
"code": 8899,
"status": "FAILED",
"message": "Insufficient balance"
},
"data": {
"txn_urn": "LJOTHD1668143656985ZBSVPV",
"txn_number": "02166814365694072422429",
"txn_reference": "OIKY7293742638846",
"txn_amount": "699",
"txn_type": "DEBIT",
"txn_nature": "BANK",
"account_balance": "0"
}
}
}

Result Code

Success

1001 - SUCCESS

Hold

1002 - HOLD

Failed

8899 - Insufficient balance
8898 - Account not found
8897 - Account is inactive / blocked / closed
8896 - Debit is not allowed
8894 - User declined
8893 - Time expired
8892 - Attempts to retry exceeded maximum
8891 - Settlement account not found

Response

Parameters

Parameter
Type
Description
head
Object
HTTP_CODE
Integer
HTTP response status codes. Refer
result
Object
code
Integer
Status code for the transaction request. Find result codes
status
String
The status against transaction created. Refer
data
Object
txn_urn
String
A Unique Transaction Reference Id. Refer
Eg: LJOTHD1668143656985ZBSVPV
txn_number
String
A Unique Transaction Number. Refer Eg: 02166814365694072422429
txn_reference
String
A unique transaction reference id created by the remitter entity. Eg: 123456789ghhg08nxv
txn_status
String
Status of transaction. Refer Eg: PROCESSING
txn_attempt_status
String
Status of Confirm attempt. Refer Eg: PENDING
txn_nature
String
The nature of the transaction. Find transaction nature
Eg: INTERPE
txn_type
String
The type of transaction. Find transaction types
Allowed values: DEBIT, RF_DEBIT
Eg: DEBIT
txn_mode
String
The mode of the transaction. Refer
Eg: UPI
txn_note
String
The user added note for reference. Eg: gggggggg
txn_amount
String
Transaction amount. Eg: 1200.99
txn_service_charge
String
The amount charged by the entity to the customer for using Rimit's services. This amount can be debited from the customer.
Default value: 0 (Zero). Eg: 1
txn_sp_fee
String
The amount charged by the bank/service provider for facilitating the transaction. This amount can be debited from the customer. Default value: 0 (Zero). Eg: 3
txn_fee
String
Fees charged by Rimit to User for any Services. This amount can be debited from the customer. Default value: 0 (Zero). Eg: 25
INFO The txn_reference may contain -H as a suffix if the txn_attempt_status in the response is HOLD.
Eg: "txn_reference": "625896169969166531181616306-H"

Response format

Encrypted
SUCCESS
FAILED
ERROR
{
"head": {
"api": "confirmDebit",
"apiVersion": "V1",
"timeStamp": "2023-01-13 11:07:32 AM",
"HTTP_CODE": 200
},
"encrypted_data": {
"cipher_text": "IFJNhtfsEcjvxxB6Ti0XscZQv86SLR6mXe0L70rwEDLJjNidTBPaLS7XXfOMc1Z1AQCgZWLCpSZ0NHgEM8FDYArCrXZ/zJ0kOqznn+UkNJ3Lg8DhBVb04muU52Fpbjtc6/TbE+v28VyVYQIZFf4UkybfT5gdH5uH8HqP+thzgg/UHSEwfPeMfyt/3YQgZ2w6btssMCJFDPBHfEJBBTa44NkvLMXq4fkjR2BrWviQKeJ8MNLdujXp1wpisBgOGmPvy21CwsxNIbsD1Tm3UA4k6wUvy2VmccpE6cQlBLDv8OqJvuhRGgAE8bqo3UUrWUG/xc6Lsya6ZmyVYIdRFzJA47SQfz5py6K8ZSkhZ1kfCw1BUl4JV95rYwurJpUXajaukiqNJGuOGuMuHCCb1Ix4B6xlDxdmvLODbRjL1Ayo2IrU39J/83X65IWyoa2vfsXuzrSnWELcay4eV4JXhju2j0yKRVCkNQ6akIG1WDOpl8RvibME695hiSH900mCRAXKc7uKJDZMbtQBrDyghzvggg==",
"iv": "be95017284997ad3",
"hash": "0ba27e1a1ce804797871fc8e42456e8f3f5460249722396f43ad244d49b6539c"
}
}
{
"head": {
"api": "confirmDebit",
"apiVersion": "V1",
"timeStamp": "2023-01-13 11:07:32 AM",
"HTTP_CODE": 200
},
"content": {
"result": {
"code": 1001,
"status": "SUCCESS",
"message": "The request is successfully processed"
},
"data": {
"txn_urn": "BDXPBZ1673588251820ZUNTCD",
"txn_number": "01167358825176067931888",
"txn_reference": "RWCY6219897357242",
"txn_status": "PROCESSING",
"txn_attempt_status": "SUCCESS",
"txn_nature": "INTERPE",
"txn_type": "DEBIT",
"txn_mode": "P2P",
"txn_note": "testing-2",
"txn_amount": "100",
"txn_service_charge": "1",
"txn_sp_fee": "3",
"txn_fee": "25"
}
}
}
{
"head": {
"api": "confirmDebit",
"apiVersion": "V1",
"timeStamp": "2023-01-12 06:42:25 AM",
"HTTP_CODE": 200
},
"content": {
"result": {
"code": 8899,
"status": "FAILED",
"message": "Insufficient balance"
},
"data": {
"txn_urn": "LJOTHD1668143656985ZBSVPV",
"txn_number": "02166814365694072422429",
"txn_reference": "OIKY7293742638846",
"txn_status": "FAILED",
"txn_attempt_status": "SUCCESS",
"txn_nature": "BANK",
"txn_type": "DEBIT",
"txn_mode": "NEFT",
"txn_note": "testing-2",
"txn_amount": "699",
"txn_service_charge": "1",
"txn_sp_fee": "3",
"txn_fee": "2"
}
}
}
{
"head": {
"api": "confirmDebit",
"apiVersion": "V1",
"timeStamp": "2023-01-05 08:46:52 AM",
"HTTP_CODE": 406
},
"content": {
"result": {
"code": 2092,
"status": "ERROR",
"message": "Transaction reference is not unique"
},
"data": {}
}
}

Result Code

See the listed common result codes
See the list of confirmDebit result codes