Overview

This API can be used by the platform to refund a transaction back to the source i,e the VPA from which payer undertook a transaction.

This can be processed for any transaction undertaken through the below modes.

• Generate Payment Link API
• Issue Collect Request
• Generate Dynamic QR
• UPI Autopay
• Push Transactions

Flow

Below is the flow for initiating the refunds through Decentro's stack.

• The platform consumes this API to refund a successful transaction using the Decentro transaction ID received from Generate payment link API, UPI Autopay and the Generate Dynamic QR API, by passing the value under original_decentro_txn_id parameter.
• We support partial refunds and the platform can choose to refund the complete transaction or part of it by passing the requisite value under the amount parameter.
• Decentro checks the platform's available balance and initiates the refund to the source VPA (payer UPI ID) if the transaction is found.
• Decentro rejects the request for a refund if the transaction is not found at its end due to an invalid value passed in the original_decentro_transaction_id parameter.
• Once the refund is processed, Decentro shares the status (possible values are listed here) via the Transaction Status Callback/Webhook .
• Alternatively, the platform can query the refund status via the Get Transaction Status (Basic and Advance) API.

The same API can be used for initiating the refunds against Push Transactions.

📘

Please Note

• A refund request can be initiated at a Transaction or a Transaction Attempt level via the Issue Refund API.
  • Transaction level parameters: original_decentro_txn_id and original_reference_id
  • Transaction Attempt level parameters: bank_reference_number and original_attempt_decentro_txn_id
• For Push Transactions, the refund can be initiated by either the bank_reference_number or the original_decentro_txn_id along with reference_id, purpose_message and amount (if partial refund)
• Refunds can only be initiated when the status value, for a given Transactions or Transaction Attempt, is "SUCCESS".
• We refer to the successful payment, by the end customer, as the 'Credit Transaction'. The refund is referred to as the 'Debit Transaction'.
• We do not update the status of the payment request (credit transaction) when the refund is requested.
• If you initiate the GTS Advance) API with the details of the credit transaction, the API response will contain the details of the associated refund (debit) transactions.
• If a Transaction Attempt was "AUTO REFUNDED" or "RELEASED" (corresponding action value), the Issue Refund API will throw an error if the platform tries to initiate a refund.

API Endpoints

Below are the API endpoints to be used by the platform basis the environments.

Response Keys

Below are the response keys propagated by Decentro in the response_key parameter, which cover all the scenarios a platform can encounter.

Please note that the below keys don't include transaction-related response keys since the status of the transaction is relayed only after the payer authorizes payment.