Refund an excess customer payment

POST

/customerpayments/{customer_payment_id}/refunds

Refund the excess amount paid by the customer.

Request

Authorization

OAuth 2.0

Implicit

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://accounts.zoho.com/oauth/v2/auth

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/customerpayments//refunds' \
--header 'Content-Type: application/json' \
--data-raw '{
    "date": "2013-10-01",
    "refund_mode": "Cash",
    "reference_number": " ",
    "amount": 2000,
    "exchange_rate": 1,
    "payment_form": "cash",
    "from_account_id": "460000000070003",
    "description": "The New York State Department of  Taxation and Finance"
}'

Response Example

{
    "code": 0,
    "message": "The refund information for this payment has been saved.",
    "payment_refunds": [
        {
            "payment_refund_id": "460000000078307",
            "payment_id": "460000000076027",
            "date": "2013-10-01",
            "refund_mode": "Cash",
            "reference_number": " ",
            "amount": 2000,
            "exchange_rate": 1,
            "payment_form": "cash",
            "description": "The New York State Department of  Taxation and Finance"
        }
    ]
}

Modified at 2025-10-12 16:28:37

List refunds of a customer payment

Update custom field in existing customerpayments