Get Split Info API

The Get Split Info API is used for getting split info of the parent transaction in the aggregator flow.

Environment

Request parameters

Header

ParamsDescriptionExample
mid mandatoryThis parameter must contain the parent merchant’s MID.720043 
command
mandatory
This parameter must contain the API Command for getting Transaction. It should be get_split_info for Get Split Info API. Get Split Info

Body

ParamsDescriptionExample
payuId
mandatory
PayU id in array "payuId" : ["17066265059"], "payuId" : ["10006265058"]
splitType
mandatory
Value should always be 22
hash
mandatory
This parameter must contain the hash value to be calculated at your end. Hash logic for this API is: sha512(key|command|var1|salt)
sha512

Sample request

curl -X POST https://api.example.com/get_split_info \
-H "mid: 720043" \
-H "command: get_split_info" \
-H "Content-Type: application/json" \
-d '{
  "payuId": ["17066265059", "10006265058"],
  "splitType": 2,
  "hash": "your_calculated_hash_here"
}'

Response parameters

ParameterDescriptionExample
messageThis parameter returns the reason string. For a list of error codes for failure scenarios, refer to Error codes for failure scenarioHash validation failed
statusThis parameter returns the status of web service call. The status can be any of the following:
0 - If web service call failed.
1 - If web service call succeeded
0
resultThis parameter contains the response in a JSON array format. Each JSON object contains the mihpayuid and Transaction_details field. For more information on transactionDetails field, refer to transactionDetails fields description.

transactionDetails fields description

FieldDescription
idThis field contains the PayU transaction ID.
transactionIdThis field contains the transaction ID.
merchantkeyThis field contains the chidl merchant key.
merchantnameThis field contains the child merchant name.
statusThis field contains the transaction status. For more information, refer to Payment State Explanations.
txnidThis field contains the transaction ID.
base_idThis field contains the base PayU Transaction ID. It will be null for a parent transaction.
firstnameThis field contains the first name of the customer who did the transaction.
lastnameThis field contains the last name of the customer who did the transaction.
addedonThis field contains the transaction created date and time. Format: yyyy-mm-dd hh:ii:ss
bank_nameThis field contains the bank name of payment transaction.
payment_gatewayThis field contains the payment gateway used in the transaction.
phoneThis field contains the contact number of the customer who did the transaction.
emailThis field contains the email ID of the customer who did the transaction.
transaction_feeThis field contains the transaction fee without discount and additional charges.
amountThis field contains the total amount paid by customer.
discountThis field contains the discount or Subvention charges on the transaction.
additional_chargesThis field contains the additional charges on transaction.
productinfoThis field contains the product information provided by merchant.
error_codeThis field contains the transaction error code. For more information on errors, refer to Error codes for failure scenario
bank_ref_noThis field contains the bank reference number.
ibibo_codeThis field contains the IBIBO Code or bank_code that was submitted in transaction by the merchant to PayU.
modeThis field contains the Mode of transaction, such as, CC, DC, NB, EMI.
address2This field contains the address of the customer.
cityThis field contains the city of the customer.
zipcodeThis field contains the PIN code of the customer.

Sample response

Success scenariro

{
    "message": "Success",
    "status": 1,
    "result": [
        {
            "payuId": 17066265059,
            "transactionDetails": {
                "id": 17066265059,
                "transactionId": "339024503",
                "merchantKey": "w770KY",
                "merchantName": "OMNIWARE TECHNOLOGIES PRIVATE LIMITED",
                "status": "captured",
                "discount": 0.0,
                "amount": 708.0,
                "transactionFee": 708.0,
                "additionalCharges": 0.0,
                "mode": "UPI",
                "baseTxnId": 0,
                "firstName": "DemoName",
                "lastName": "",
                "addedOn": "2023-03-28 00:05:15",
                "phone": "9600260031",
                "email": "[email protected]",
                "productInfo": "ValidityExtn",
                "errorCode": "E000",
                "ibiboCode": "UPI",
                "address": "",
                "city": "",
                "zipcode": "",
                "cardNo": null,
                "cardType": null,
                "cardToken": null,
                "udf1": "",
                "udf2": "",
                "udf3": "",
                "udf4": "",
                "udf5": "",
                "field0": null,
                "field1": "vinothou35@okaxis",
                "field2": null,
                "field3": "vinothou35@okaxis",
                "field4": "D VINOTH KUMAR",
                "field5": null,
                "field6": "D VINOTH KUMAR|0000000000",
                "field7": "00|APPROVED OR COMPLETED SUCCESSFULLY",
                "field8": null,
                "field9": "Success|Completed Using Callback",
                "errorMessage": "No Error",
                "paymentSource": "payu",
                "partnerToken": null,
                "clearToken": false,
                "ccAvenueOrderid": null,
                "merchantUTR": null,
                "threeDsEci": null,
                "threeDSEnrolled": null,
                "threeDSStatus": null,
                "appName": "GooglePay",
                "mcpLookupId": null,
                "mcpAmount": null,
                "mcpCurrency": null,
                "mcpExchangeRate": null,
                "rupayAuthRefNo": null,
                "originalCurrency": null,
                "curl": null,
                "furl": null,
                "surl": null,
                "state": null,
                "country": null,
                "bankRefNo": "308761993790",
                "ip": "103.126.229.249",
                "issuingBank": null,
                "paymentGateway": "ICICIU",
                "address2": ""
            },
            "splitTransactionDetails": [
                {
                    "payuId": 17067801351,
                    "transactionDetails": {
                        "id": 17067801351,
                        "transactionId": "splitTxn33902450310",
                        "merchantKey": "ySHBj2",
                        "merchantName": "KAROPADIS SHANMUGAM LOGANATHAN",
                        "status": "captured",
                        "discount": 0.0,
                        "amount": 692.97,
                        "transactionFee": 692.97,
                        "additionalCharges": 0.0,
                        "mode": "UPI",
                        "baseTxnId": 17066265059,
                        "firstName": "DemoName",
                        "lastName": "",
                        "addedOn": "2023-03-28 11:03:22",
                        "phone": "9600260031",
                        "email": "[email protected]",
                        "productInfo": "ValidityExtn",
                        "errorCode": "E000",
                        "ibiboCode": "UPI",
                        "address": "",
                        "city": "",
                        "zipcode": "",
                        "cardNo": null,
                        "cardType": null,
                        "cardToken": null,
                        "udf1": "",
                        "udf2": "",
                        "udf3": "",
                        "udf4": "",
                        "udf5": "",
                        "field0": null,
                        "field1": "vinothou35@okaxis",
                        "field2": null,
                        "field3": "vinothou35@okaxis",
                        "field4": "D VINOTH KUMAR",
                        "field5": null,
                        "field6": "D VINOTH KUMAR|0000000000",
                        "field7": "00|APPROVED OR COMPLETED SUCCESSFULLY",
                        "field8": null,
                        "field9": "Success|Completed Using Callback",
                        "errorMessage": "No Error",
                        "paymentSource": "child-aggregator",
                        "partnerToken": null,
                        "clearToken": false,
                        "ccAvenueOrderid": null,
                        "merchantUTR": null,
                        "threeDsEci": null,
                        "threeDSEnrolled": null,
                        "threeDSStatus": null,
                        "appName": "GooglePay",
                        "mcpLookupId": null,
                        "mcpAmount": null,
                        "mcpCurrency": null,
                        "mcpExchangeRate": null,
                        "rupayAuthRefNo": null,
                        "originalCurrency": null,
                        "curl": null,
                        "furl": null,
                        "surl": null,
                        "state": null,
                        "country": null,
                        "bankRefNo": "308761993790",
                        "ip": "103.126.229.249",
                        "issuingBank": null,
                        "paymentGateway": "ICICIU",
                        "address2": ""
                    }
                },
                {
                    "payuId": 17067801352,
                    "transactionDetails": {
                        "id": 17067801352,
                        "transactionId": "339024503",
                        "merchantKey": "w770KY",
                        "merchantName": "OMNIWARE TECHNOLOGIES PRIVATE LIMITED",
                        "status": "captured",
                        "discount": 0.0,
                        "amount": 15.03,
                        "transactionFee": 15.03,
                        "additionalCharges": 0.0,
                        "mode": "UPI",
                        "baseTxnId": 17066265059,
                        "firstName": "DemoName",
                        "lastName": "",
                        "addedOn": "2023-03-28 11:03:22",
                        "phone": "9600260031",
                        "email": "[email protected]",
                        "productInfo": "ValidityExtn",
                        "errorCode": "E000",
                        "ibiboCode": "UPI",
                        "address": "",
                        "city": "",
                        "zipcode": "",
                        "cardNo": null,
                        "cardType": null,
                        "cardToken": null,
                        "udf1": "",
                        "udf2": "",
                        "udf3": "",
                        "udf4": "",
                        "udf5": "",
                        "field0": null,
                        "field1": "vinothou35@okaxis",
                        "field2": null,
                        "field3": "vinothou35@okaxis",
                        "field4": "D VINOTH KUMAR",
                        "field5": null,
                        "field6": "D VINOTH KUMAR|0000000000",
                        "field7": "00|APPROVED OR COMPLETED SUCCESSFULLY",
                        "field8": null,
                        "field9": "Success|Completed Using Callback",
                        "errorMessage": "No Error",
                        "paymentSource": "child-aggregator",
                        "partnerToken": null,
                        "clearToken": false,
                        "ccAvenueOrderid": null,
                        "merchantUTR": null,
                        "threeDsEci": null,
                        "threeDSEnrolled": null,
                        "threeDSStatus": null,
                        "appName": "GooglePay",
                        "mcpLookupId": null,
                        "mcpAmount": null,
                        "mcpCurrency": null,
                        "mcpExchangeRate": null,
                        "rupayAuthRefNo": null,
                        "originalCurrency": null,
                        "curl": null,
                        "furl": null,
                        "surl": null,
                        "state": null,
                        "country": null,
                        "bankRefNo": "308761993790",
                        "ip": "103.126.229.249",
                        "issuingBank": null,
                        "paymentGateway": "ICICIU",
                        "address2": ""
                    }
                }
            ]
        }
    ]
}

Error codes for failure scenario

Conditionerror_codeerror_message
Hash validation failedAGG-300Hash validation failed
invalid parent transaction Payu ID:

- non-existent PayuID
- PayuID is not a parent transaction of aggregator flow
- Payu ID belongs to some other merchant.
AGG-301Invalid PayuID
Split doesn’t exist for the transactionAGG-302Split doesn't exist for this transaction