Check Order Status with .NET SDK

The Order Status API allows you to check the current status of a payment order by using the getOrderStatus() function.

Request

Parameter Name	Data Type	Mandatory (Yes/No)	Description
`merchantOrderId`	String	Yes	The order ID for which the status needs to be fetched
`details`	Boolean	No	• true → Returns all payment attempt details under the paymentDetails list. • false → Returns only the latest payment attempt details

Sample Request

    public async Task<IActionResult> CustomOrderStatus(string orderId)
    {
        _logger.LogInformation($"Testing Custom GetOrderStatus API for Order ID: {orderId}...");
        try
        {
            var response = await _customCheckoutClient.GetOrderStatus(orderId, details: true);
            _logger.LogInformation("Order Status Response:\n{Response}", JsonSerializer.Serialize(response, new JsonSerializerOptions { WriteIndented = true }));
            return Ok(response);
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "Custom GetOrderStatus API Failed");
            return StatusCode(500, new { message = ex.Message });
        }
    }

Response

The function returns a OrderStatusResponse object with the following properties:

Property	Data Type	Description
`orderId`	String	Order ID generated by PhonePe PG.
`state`	String	Current state of the order: Expected values: • PENDING • FAILED • COMPLETED
`expireAt`	`Long`	Expiry time in epoch.
`amount`	`Long`	Order amount in paisa.
`paymentDetails`	List<PaymentDetail>	Contain list of details of each payment attempt made corresponding to this order.

The paymentDetails property contains a list of payment details for each payment attempt made against an order. The details of each payment are explained in the table below.

Property	Type	Description
`paymentMode`	`String`	Mode of Payment. It can be anyone of the following modes: • UPI_INTENT • UPI_COLLECT • UPI_QR • CARD • TOKEN • NET_BANKING
`timestamp`	`Number`	Timestamp of the attempted transaction in epoch
`amount`	`Number`	Order amount in Paisa
`transactionId`	`String`	Transaction Id generated by the PhonePe
`state`	`String`	Attempted transaction state. It can be any one of the following states: • PENDING • COMPLETED • FAILED
`errorCode`	`String`	Error code (Only present when transaction state is failed)
`detailedErrorCode`	`String`	Detailed Error Code (Only present when transaction state is failed)
`rail`	PaymentRail	Contains processing rail details under which transaction attempt is made.
`instrument`	PaymentInstrumentV2	Contains instrument details of that particular transaction Id
`splitInstruments`	List<InstrumentCombo>	Contains split instrument details of all the transactions made

splitInstruments provides a list of InstrumentCombo objects. Details of each InstrumentCombo object are explained in the table below.

Property	Data Type	Type
`instrument`	PaymentInstrumentV2	Instrument used for the payment.
`rails`	PaymentRail	Rail used for the payment.
`amount`	Number	Amount transferred using the above instrument and rail.

What’s Next?

You’ve understood how to retrieve the status of an order using the getOrderStatus() function. Now, let’s move on to learn how to process refunds, which allows you to return funds to the customer for eligible transactions.