Confirm Credit

This API is used to complete the transaction by crediting the amount to the beneficiary's account.

MANDATORY

Method: POST

API URL: BASE_URL/transaction/confirmCredit

INFO

This API can only be used by the beneficiary entity of the respective transaction.

WARNING

• If the txn_nature in the Credit Amount Webhook is CASH call the Confirm Credit API with the status HOLD(1002) in realtime.

• When the user deposits money to the entity's cash counter, call the Confirm Credit 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 Credit Amount Webhook is other than CASH call the Confirm Credit 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_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 beneficiary entity. Eg: 123456789ghhg08nxv
txn_amount	String	Transaction amount credited to the beneficiary account. Eg: 1200.99
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
account_balance	String	The latest balance after crediting the txn_amount. Eg: 1200.99

ON FIRST REQUEST

• Send request as SUCCESS if the txn_amount is credited to the beneficiary's account. Else status must beFAILED.

• Use HOLD only if the txn_nature in the Credit Amount Webhook is CASH.

Request format

Encrypted

{
    "head": {
        "api": "confirmCredit",
        "apiVersion": "V1",
        "timeStamp": "2023-01-13 11:07:32 AM",
        "auth": {
            "API_ID": "6360b30096066b82e9697996",
            "API_KEY": "b54996b0-59a8-11ed-911b-87fca52fd2dc"
        }
    },
    "encrypted_data": {
        "cipher_text": "ENX8N/83Mzn9RLD5CASpjugitMklcGZajq51eZd9jpG2mDqDmM1OFSRjptBvGNox4QLJIqaQZE8EZed4reGf8md+Of+pJlTyOAxbFrj/awb4nJcL5mP0PBE4u32oPbo0MlM34ZoF55AcTArmbdC/VsyZn16TTppx0LsypelvpqNyGhWCTTOdwus/dtenydNtV2b113nDj1fPp9BnfKdTg3Z6NW867i4BJwyUp0NDlwUuFNhi11MSs6bIRElrF+I/nNJT6Gu3GFHzu6Vn+ZOxo89h3KevA/eL40wqyEa34nccdXXeVhPqKKp48kSRHdkYmpDeKX6rvUEwadv5M5Mq6QZ60fTrTrawk26B1QdBgpf9BtNmKyhStomM8gAXfCNrHe2IeVtervWQhHJcbVazkTCeyBDm39IZy8cosianTaM=",
        "iv": "0549b493a55165f1",
        "hash": "2b87ca9e967103d9db930b2ef3b2c1d1a0044613b5a81cf0befe736f0d0c039f"
    }
}

SUCCESS / HOLD

{
    "head": {
        "api": "confirmCredit",
        "apiVersion": "V1",
        "timeStamp": "2023-01-13 11:07:32 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": "MZSJRR1673588252113FRBFJZ",
            "txn_number": "01167358825176067931888",
            "txn_reference": "BBHA7184198632803",
            "txn_amount": "100",
            "txn_type": "CREDIT",
            "txn_nature": "INTERPE",
            "account_balance": "2400"
        }
    }
}

FAILED

{
    "head": {
        "api": "confirmCredit",
        "apiVersion": "V1",
        "timeStamp": "2023-01-12 08:47:24 AM",
        "auth": {
            "API_ID": "6360b30096066b82e9697996",
            "API_KEY": "b54996b0-59a8-11ed-911b-87fca52fd2dc"
        }
    },
    "content": {
        "result": {
            "code": 8898,
            "status": "FAILED",
            "message": "Account not found"
        },
        "data": {
            "txn_urn": "QQGOVB1668251835914ZBUSOQ",
            "txn_number": "03166825183584855892541",
            "txn_reference": "TEPY6834944787899",
            "txn_amount": "11",
            "txn_type": "CREDIT",
            "txn_nature": "INTERPE",
            "account_balance": "0"
        }
    }
}

Result Code

Success

1001 - SUCCESS

Hold

1002 - HOLD

Failed

8898 - Account not found

8897 - Account is inactive / blocked / closed

8895 - Credit 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 API request.
status	String	The status of the API request.
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 beneficiary 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: CREDIT, RF_CREDIT Eg: CREDIT
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. Default value: 0 (Zero). Eg: 1
txn_sp_fee	String	The amount charged by the bank/service provider for facilitating the transaction. Default value: 0 (Zero). Eg: 3
txn_fee	String	Fees charged by Rimit to Customer for any Services. 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

{
    "head": {
        "api": "confirmCredit",
        "apiVersion": "V1",
        "timeStamp": "2023-01-13 11:07:32 AM",
        "HTTP_CODE": 200
    },
    "encrypted_data": {
        "cipher_text": "97OPwxERYFSbItW/9jcBWOWnvAad6yPgDAPlxP6c4CJ6uH1GFsFXi0elBG3M/0rmyo/74Cgy0o8ZbFBd64/23gNIjF1a2mt/daEr4bgLwmYdy/EU17XWUIXJPk0ca///2k6050M0Iz6gxYZaJuT+su001QLPpaJYT0Y3BajjXYR6e1gWnBWXjV+A0kEzIIRQjKW7lzgSV3PqMqU23DfzpQUSQC9SRSBirh/azERy5R9I3LqDS4lRCaNBrVEZzOQzra27XRyW49Qadzp/KaQmm5WT6s899sA8dCFITESQKQHpCoA8mGJi6jYcSpkuyXslA5pJU/7Nks//wSAtsq8UOA62ZIuljwgMyJcnYagsddSvGRK5iyMe83E/LDsJcOYw8ip5gSnDrFXM5ptMTxCUFSWFmHWM4T6N+rt4iD+b5AinRSY40pYBXKUlpnYKajg30oEU9BTVzhaMdRrTPm9upkgQWOi4JJC0jfb7eDGEPfPXHRIqK38ofY7y8hiNJ1qOwyoDdoU+1Mu1YxlAf5nN9Q==",
        "iv": "f092814abf3e132d",
        "hash": "f93dc2480119bd09c0ff66ad110241b02134101327ae6b94492b6b5a6d6ff972"
    }
}

SUCCESS

{
    "head": {
        "api": "confirmCredit",
        "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": "MZSJRR1673588252113FRBFJZ",
            "txn_number": "01167358825176067931888",
            "txn_reference": "BBHA7184198632803",
            "txn_status": "SUCCESS",
            "txn_attempt_status": "SUCCESS",
            "txn_nature": "INTERPE",
            "txn_type": "CREDIT",
            "txn_mode": "P2P",
            "txn_note": "testing-2",
            "txn_amount": "100",
            "txn_service_charge": "1",
            "txn_sp_fee": "3",
            "txn_fee": "25"
        }
    }
}

FAILED

{
    "head": {
        "api": "confirmCredit",
        "apiVersion": "V1",
        "timeStamp": "2023-01-12 07:06:00 AM",
        "HTTP_CODE": 200
    },
    "content": {
        "result": {
            "code": 8898,
            "status": "FAILED",
            "message": "Account not found"
        },
        "data": {
            "txn_urn": "QQGOVB1668251835914ZBUSOQ",
            "txn_number": "03166825183584855892541",
            "txn_reference": "TEPY6834944787899",
            "txn_status": "FAILED",
            "txn_attempt_status": "SUCCESS",
            "txn_nature": "INTERPE",
            "txn_type": "CREDIT",
            "txn_mode": "P2P",
            "txn_note": "testing-2",
            "txn_amount": "300",
            "txn_service_charge": "0",
            "txn_sp_fee": "0",
            "txn_fee": "25"
        }
    }
}

ERROR

{
    "head": {
        "api": "confirmCredit",
        "apiVersion": "V1",
        "timeStamp": "2023-01-05 08:55:12 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 confirmCredit result codes