Update Payment
OAuthScope
ZohoCommerce.customerpayments.UPDATE
HTTP Request
PUThttps://commerce.zoho.com/store/api/v1/salesorders/{order_id}/payments/{payment_id}
Body Parameters
| Parameter | Description |
| payment_mode* | string: Mode through which payment is made. This can be check, cash, credit card, bank transfer, bank remittance, auto transaction, or others. Maximum length = [100]. |
| amount* | double: Amount paid in the respective payment. |
| reference_number* | string: Reference number generated for the payment. A string of your choice can also be used as the reference number. Maximum length of the reference number = [100]. |
| date* | string: Date on which payment is made. Date Format [yyyy-mm-dd]. |
| description | string: Description about the payment. |
Request Example
Copiedcurl -i -L -X PUT
-H "Content-Type:application/json"
-H "Authorization:Zoho-oauthtoken ***"
-H "X-com-zoho-store-organizationid:58927961"
-d
'{
"payment_mode":"cash",
"reference_number":"1234",
"date":"2019-09-30",
"description":"kjhasdkj",
"amount":"200"
}'
'https://commerce.zoho.com/store/api/v1/salesorders/51128000000118261/payments/51128000000120293'Success Response
Copied{
"code": 0,
"message": "The details of the payment received from the customer have been updated",
"payment":{
"payment_id": "51128000000120293",
"payment_mode": "cash",
"amount": 200,
"date": "2019-09-30",
"description": "kjhasdkj",
"reference_number": "1234",
"account_id": "51128000000000358",
"account_name": "Undeposited Funds",
"invoice_id": "51128000000120249"
}
}OAuthScope
ZohoCommerce.customerpayments.UPDATE
HTTP RequestFailure Response
Copied{
"code": 1029,
"message": "Amount recorded should be equal to the order value"
}