Search
Refund Status
It is used to retrieve the status of a refund using getRefundStatus() function.
Parameters
| Parameter Name | Data Type | Mandatory | Description |
|---|---|---|---|
refundId | String | Yes | Refund Id created by the merchant at the time of initiating the refund |
Example :
import {StandardCheckoutClient, Env} from 'pg-sdk-node';
const clientId = "<clientId>";
const clientSecret = "<clientSecret>";
const clientVersion = 1; //insert your client version here
const env = Env.SANDBOX; //change to Env.PRODUCTION when you go live
const client = StandardCheckoutClient.getInstance(clientId, clientSecret, clientVersion, env);
const refundId = '<REFUND_ID>'; //refundId used to initiate the refund
client.getRefundStatus(refundId).then((response) => {
const state = response.state
})Returns:
It returns a RefundStatusResponse Object.
RefundStatusResponse
| Property | Data Type | Description |
|---|---|---|
merchantId | String | Merchant Id who initiated the refund |
merchantRefundId | String | Refund Id created by the merchant at the time of refund initiation |
originalMerchantOrderId | String | Order Id for which refund has initiated. Created by the merchant at the time of order creation |
amount | Number | Amount to refund |
state | String | State of the refund |
paymentDetails | List<PaymentRefundDetail> | Contains the list of details of each transaction attempt made corresponding to this particular order |
PaymentRefundDetail:
| Property | Data Type | Description |
|---|---|---|
transactionId | String | Transaction Id generated by the PhonePe |
paymentMode | String | Mode of Payment. It can be anyone of the following modes: 1. UPI_INTENT 2. UPI_COLLECT 3. UPI_QR 4. CARD 5. TOKEN 6. NET_BANKING |
timestamp | Number | Timestamp of the attempted transaction in epoch |
state | String | Attempted transaction state. It can be any one of the following states: 1. PENDING 2. COMPLETED 3. FAILED |
errorCode | String | Error code present only when the transaction state is Failed |
detailedErrorCode | String | Detailed Error Code present only when transaction state is Failed |
splitInstruments | List<InstrumentCombo> | Type of transaction instrument. It can be any one of the following types: 1. ACCOUNT 2. CREDIT_CARD 3. DEBIT_CARD 4. NET_BANKING |