API Command: release_settlement
The Release Settlement API is used to flag the sub-payment you want to settle; after adding splits for a particular payment, the money will not be settled directly into the child merchants account unless you call a release event corresponding to the individual suborder you want to settle.
Use Case: Most marketplace model owners wait for the delivery or dispatch to happen first from the sub-seller’s end. Only after the successful dispatch, the owner will release the funds into the sub-seller’s bank account. This API gives them the flexibility to do so.
The Release Settlement API can be used to release the settlement of all the blocked child transactions in the aggregator workflow.
HTTP Method: POST
Environment
| Test Environment | https://test.payu.in/merchant/ |
| Production Environment | https://info.payu.in/merchant/ |
Request parameters
| Parameter | Description | Example |
|---|---|---|
| key mandatory | varchar The merchant key is included in this parameter. | Your Test Key |
| command mandatory | varchar The release_settlement must be included in this parameter | release_settlement |
| hash mandatory | varchar The hash string encryption is specified in this parameter.The format of the hash is: string key|command|var1|salt Where var1 is your mihpayuid | |
| var1 mandatory | varchar The mihpayuId is specified in this parameter | 8000123 |
| var2 mandatory | varchar The childMid is specified in this parameter. | 393437 |
Sample request
curl -X POST "https://test.payu.in/merchant/postservice?form=2"
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d
"key=A****r&command=release_settlement&var1=8000123&var2=8000123&hash=6692a8b560c51e8a4bb830206d3b8fac3678fb5b0844"
Response parameters
| Parameter | Description |
|---|---|
| status | The status can contain any of the following values: - Status will be 1 if API call is a success - Status will be 0 in case of failure you'll get system handled failure reasons in this case |
| msg | Message string for both success and failure cases. |
Sample Response
Success Scenario
- Successful Transaction
Sample Success Response for Release Settlement
{"status":1,"msg":"Release request is accepted"}
Failure Scenarios
- Failure Response when PayU ID is empty
Failure Response when PayUID is empty
{"status":0,"msg":"payuId is empty"}
- Failure response when child merchant ID is empty
Failure response when child merchant ID is empty
{"status":0,"msg":"Mid passed is empty"}
- Failure Response when child merchant ID and PayU ID do not match
Failure Response when child merchant ID and PayU ID do not match
{"status":0,"msg":"Invalid childMid and payuId"}
- Failure response when attempting to release an already released sub-payment
Failure response when attempt to release an already released sub- payment
{"status":0,"msg":"Release request is already accepted"}