get https://in.staging.decentro.tech/v3/core_banking/money_transfer/get_status
Important Note
Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.
API Endpoints
| Environment | Endpoint |
|---|---|
| Staging / Sandbox | https://in.staging.decentro.tech/v3/core_banking/money_transfer/get_status?{decentro_txn_id} |
| Production | https://in.decentro.tech/v3/core_banking/money_transfer/get_status?{decentro_txn_id} |
This API can be used by you to check the money transfer transactions that were initiated/completed by your customers.
Two main parameters are required -
- reference_id ((mandatory if decentro_txn_id is not present) The request ID passed by you for this transaction when initiating it earlier.)
- decentro_txn_id ((mandatory if reference_id is not present) The decentro transaction id that we responded with while providing the initiate payment response.)
Flow
This API is an alternative to the Payout's Transaction Status Callback:. The platform should use this only if a callback has not been acknowledged or the callback has not been triggered.
- The "reference_id" passed and the "decentro_txn_id" generated for the request in the Initiate Payout:. These two values can be used to check the status of the transaction.
- The API will provide the status of the transaction. The transaction status value can be either SUCCESS, FAILURE, PENDING and UNKNOWN.
Key Points
Below are the key points for the Get transaction status workflow.
- Please ensure that when using "reference_id" to check the status of the transaction. The initiate payout API must have responded. Otherwise, the transaction will not be found in the system.
- The "api_status" must not be confused with the "transaction_status". Even if the "api_status" is success, it does not mean the actual "transaction_status" is success. Please ensure this is handled during the implementation of the get transaction status API to your platform.
API Specifications
Response Payload
| Response Parameter | Mandatory (M) / Optional (O) / Conditional Mandatory (CM) | Description |
|---|---|---|
| decentro_txn_id | M | A URN generated by Decentro against the API request |
| api_status | M | The status of the get transaction status API request. Decentro recommends not using this parameter to mark the transaction status Here are the values that will be propagated. 1. Success 2. Failure |
| message | M | A message will be propagated by Decentro regarding the status of the API. |
| response_key | M | Response key documenting the status of the API hit and various errors as mentioned here |
| data | M | The Object that contains the details of the transaction. |
| transaction_status | CM | The status of the payout transaction. These are the values that will be present. For more refer, please refer this section here 1. Success 2. Failure 3. Pending 4. Unknown |
| bank_reference_number | CM | The Bank Reference Number will be populated. It will be populated for ‘success’,’ failure’, and ‘pending’. For some cases, it will not be populated for ‘pending’ |
| transfer_type | CM | The transfer type of the payout transaction. UPI, IMPS, NEFT, and RTGS are the values propagated |
| transaction_status_description | CM | The message on the status of the transaction. This parameter will be generated when the status is "Success" or "Failure." |
| beneficiary_name | CM | The Beneficiary account holder’s name will be propagated here. This will be propagated only for ‘Success’ |