Skip to main content
Phone Pe Business Logo

Order Status with SplitInfo

The Order Status API is used to check the status of a payment using the merchantOrderId. It returns key details such as payment state, transaction amount, mode, and timestamp. If the order involves split settlement, the response includes a splitSettlementInfo block with a breakdown of the amounts settled to each account and their respective settlement states.

EnvironmentHttp MethodValue
SandboxGEThttps://api-preprod.phonepe.com/apis/pg-sandbox/payments/v2/order/{merchantOrderId}/status
ProductionGEThttps://api.phonepe.com/apis/pg/payments/v2/order/{merchantOrderId}/status
Request Headers
Header NameHeader Value
Content-Typeapplication/json
AuthorizationO-Bearer <partner-auth-token>
X-MERCHANT-IDMID
Path Parameters
Header NameDescription
merchantOrderIdThe merchant generated Order Id
Case 1: order is completed and settlement for merchant and split both NOT_INITIATED
{
    "orderId": "OMOxx",
    "state": "COMPLETED",
    "amount": 10000,
    "expireAt": 1291391291,
    "metaInfo":
    {
        "udf1": "",
        "udf2": "",
        "udf3": "",
        "udf4": "",
        "udf5": ""
    },
    "errorCode": "INVALID_MPIN",    
    "detailedErrorCode": "ZM",      
    "paymentDetails":
    [
        {
            "paymentMode": "UPI_QR",
            "transactionId": "OM12334",
            "timestamp": 12121212,
            "amount": 10000,
            "state": "COMPLETED",
            "rail":
            {
                "type": "UPI",
                "upiTransactionId": "upi12313",
                "vpa": "12****78@ybl"
            },
            "instrument":
            {
                "type": "ACCOUNT",
                "accountType": "SAVINGS",
                "accountNumber": "******1234"
            }
        }
    ],
    // below splitSettlementInfo block will only come if order split information is given.
    "splitSettlementInfo":
    {
        "type": "ABSOLUTE",
        "accountSplit":
        [
            {
                "value": 400,
                "accountId": "ACC12345"
            },
            {
                "value": 510,
                "accountId": "ACC6789"
            }
        ],
        "state": "PENDING"
    },
    // below errorContext block will only come if order is in failed state and queryParam is passed as "errorContext=true"
    "errorContext":
    {
        "errorCode": "INVALID_MPIN",
        "detailedErrorCode": "ZM",
        "source": "CUSTOMER",
        "stage": "AUTHENTICATION",
        "description": "Wrong MPIN was entered"
    }
}
Case 2: order is completed and merchant settlement is COMPLETED and split settlement info is COMPLETED
{
    "orderId": "OMOxx",
    "state": "COMPLETED",
    "amount": 10000,
    "expireAt": 1291391291,
    "metaInfo":
    {
        "udf1": "",
        "udf2": "",
        "udf3": "",
        "udf4": "",
        "udf5": ""
    },
    "errorCode": "INVALID_MPIN",   
    "detailedErrorCode": "ZM",   
    "paymentDetails":
    [
        {
            "paymentMode": "UPI_QR",
            "transactionId": "OM12334",
            "timestamp": 12121212,
            "amount": 10000,
            "state": "COMPLETED",
            "rail":
            {
                "type": "UPI",
                "upiTransactionId": "upi12313",
                "vpa": "12****78@ybl"
            },
            "instrument":
            {
                "type": "ACCOUNT",
                "accountType": "SAVINGS",
                "accountNumber": "******1234"
            }
        }
    ],
    // below splitSettlementInfo block will only come if order split information is given.
    "splitSettlementInfo":
    {
        "type": "ABSOLUTE",
        "accountSplit":
        [
            {
                "value": 400,
                "accountId": "ACC12345"
            },
            {
                "value": 510,
                "accountId": "ACC6789"
            }
        ],
        "state": "ACCEPTED"
    },
    // below errorContext block will only come if order is in failed state and queryParam is passed as "errorContext=true"
    "errorContext":
    {
        "errorCode": "INVALID_MPIN",
        "detailedErrorCode": "ZM",
        "source": "CUSTOMER",
        "stage": "AUTHENTICATION",
        "description": "Wrong MPIN was entered"
    }
}
Case 3: order is completed and merchant settlement is COMPLETED and split settlement info is not found
{
    "orderId": "OMOxx",
    "state": "COMPLETED",
    "amount": 10000,
    "expireAt": 1291391291,
    "metaInfo":
    {
        "udf1": "",
        "udf2": "",
        "udf3": "",
        "udf4": "",
        "udf5": ""
    },
    "errorCode": "INVALID_MPIN",    // Only present in case of failed transaction attempt and order is failed
    "detailedErrorCode": "ZM",      // Only present in case of failed transaction attempt and order is failed
    "paymentDetails":
    [
        {
            "paymentMode": "UPI_QR",
            "transactionId": "OM12334",
            "timestamp": 12121212,
            "amount": 10000,
            "state": "COMPLETED",
            "rail":
            {
                "type": "UPI",
                "upiTransactionId": "upi12313",
                "vpa": "12****78@ybl"
            },
            "instrument":
            {
                "type": "ACCOUNT",
                "accountType": "SAVINGS",
                "accountNumber": "******1234"
            }
        }
    ],
    // below splitSettlementInfo block will only come if order split information is given.
    "splitSettlementInfo":
    {
        "type": "ABSOLUTE",
        "accountSplit":
        [
            {
                "value": 400,
                "accountId": "MYACCOUNT1234"
            },
            {
                "value": 510,
                "accountId": "VENDOR567"
            }
        ],
        "state": "FAILED"
    },
    // below errorContext block will only come if order is in failed state and queryParam is passed as "errorContext=true"
    "errorContext":
    {
        "errorCode": "INVALID_MPIN",
        "detailedErrorCode": "ZM",
        "source": "CUSTOMER",
        "stage": "AUTHENTICATION",
        "description": "Wrong MPIN was entered"
    }
}
Response Parameter
Header NameData TypeDescription
orderIdStringPG generated internal order ID
stateStringIndicates the current status of the order. Possible values:
• PENDING
• FAILED
• COMPLETED
Note: Always rely on the state field to determine the final status of the payment.
amountStringTotal order amount represented in paisa.
expireAtLongTime when the order expires, represented in epoch (milliseconds).
metaInfoObjectCustom metadata provided by the merchant during order creation.
paymentDetailsListContains a list of details for each payment attempt made for the order.
paymentDetails.paymentModeStringMode used for the payment. Possible values include:
• UPI_INTENT
• UPI_COLLECT
• UPI_QR
• CARD
• TOKEN
• NET_BANKING
paymentDetails.timestampLongTime when the transaction was attempted, represented in epoch (milliseconds).
paymentDetails.amountLongThe transaction amount for the specific payment attempt, represented in paisa.
paymentDetails.transactionIdStringThe internal ID assigned to a specific payment attempt.
paymentDetails.stateStringCurrent status of the payment attempt. Possible values:
• PENDING
• COMPLETED
• FAILED
paymentDetails.errorCodeStringDisplays the error code only if the transaction attempt has failed.
paymentDetails.detailedErrorCodeStringShows a more specific error code, available only when the transaction attempt has failed.
paymentDetails.railStringIncludes the processing rail details used for the specific payment attempt.
paymentDetails.rail.typeStringIndicates the rail type used for processing. Expected values:
• UPI
• PG
paymentDetails.instrumentStringProvides details of the payment instrument used for the transaction.
paymentDetails.instrument.typeStringSpecifies the type of payment instrument used. Expected values:
• ACCOUNT
• CREDIT_CARD
• DEBIT_CARD
• NET_BANKING
settlementDetailsObjectRepresents the settlement status associated with the order.
settlementDetails.stateStringIndicates the current status of the settlement. Possible values include:
• NOT_INITIATED
• INITIATED, PROCESSED
• ATTEMPT_FAILED
splitSettlementInfoObjectProvides details about how the order amount is distributed across different accounts if a split is configured.
splitSettlementInfo.splitTypeStringIndicates the method used for splitting the amount. Supported values:
• PERCENT
• ABSOLUTE
splitSettlementInfo.accounts[*].accountIdStringUnique identifier of the split account provided by the merchant for reference.
splitSettlementInfo.settlementStatusStringIndicates whether the payment settlement information is available in the internal tStore or not.
errorContextStringProvides error information including errorCode, detailedErrorCode, source, stage, and a brief description of the issue.
settlementDetailsObjectProvides error details such as error code, detailed error code, source of failure, stage of failure, and a descriptive message.
Is this article helpful?