Refund Payment
OAuthScope
ZohoCommerce.salesorders.CREATE
HTTP Request
POST https://commerce.zoho.com/store/api/v1/salesorders/{salesorder_id}/refund
API Kind
kind#checkout-address
Body Parameters
| Parameter | Type |
| amount* | double: Amount to be refunded. |
Request Example
Copiedcurl -i -L -X POST
-H "Content-Type:application/json"
-H "Authorization:Zoho-oauthtoken ***"
-H "X-com-zoho-store-organizationid:58927961"
-d
'{
"amount":1,
"line_items":[{"is_returned_to_stock":false}]
}'
'https://commerce.zoho.com/store/api/v1/salesorders/51128000000118261/refund'Success Response
Copied{
"code": 0,
"message": "Sales order refunded",
"salesreturns":{
"refund_id": "51128000000121227",
"refund_date": "2019-09-30",
"amount": 1,
"return_number": "",
"refund_type": "order_refund"
}
}Failure Response
Copied{
"code": 253815,
"message": "Amount to be refunded exceeds the available refundable amount.Please enter a valid refund amount."
}