Mark as Paid
OAuthScope
ZohoCommerce.customerpayments.CREATE
HTTP Request
POST https://commerce.zoho.com/store/api/v1/salesorders/51128000000104005/payments
Body Parameters
| Parameter | Type |
| 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 POST
-H "Content-Type:application/json"
-H "Authorization:Zoho-oauthtoken ***"
-H "X-com-zoho-store-organizationid:58927961"
-d
'{
"amount":"10",
"payment_mode":"Cash",
"reference_number":"123uwoi",
"date":"2017-02-03",
"description":"Received payment for this order",
}
'
'https://commerce.zoho.com/store/api/v1/salesorders/51128000000104005/payments'Success Response
Copied{
"code" : 0,
"message" : "The payment for the order has been recorded"
"payment" :
{
"payment_id": "2000000006029",
"payment_number": "1",
"payment_mode": "Bank Transfer",
"invoice_payment_id": "2000000006031",
"description": "Received payment for this order",
"date": "2017-02-03",
"reference_number": "123uwoi",
"exchange_rate": 1,
"amount": 501,
"is_single_invoice_payment": true,
"invoice_id": "2000000014073"
}
}Failure Response
Copied{
"code": 24016,
"message": "The amount entered is more than the balance due for the selected invoices."
}