POST /invoices/{invoice-id}/refund

Refunds the invoice. The refund request is processed via the payment gateway originally used to charge the customer. You can choose to either make a full refund for the entire amount or make many partial refunds until you reach the total amount charged for the invoice. The API returns an error if an attempt is made to:

Refund an offline invoice. For such invoices, use the Record refund API.
Refund a fully refunded invoice.

If the refund transaction succeeds, a credit_note capturing this refund detail is created for the invoice.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`invoice-id`	String	Yes

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Possible values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Possible values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.
`chargebee-event-email`	String	No	skip only emails Possible values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`comment`	String	No	Comment, if any, on the refund.
`refund_amount`	Integer	No	The amount to be refunded. If not specified, the entire refundable amount for this invoice is refunded. The refundable amount is the total amount paid via online `transaction`s, and not already refunded. Note: Any linked_taxes_withheld associated with the invoice cannot be refunded via this operation.
`credit_note`	Object	No	Parameters for credit_note
`credit_note.reason_code`	String	No	The reason for issuing this Credit Note. The following reason codes are supported now[Deprecated; use the create_reason_code parameter instead] * product_unsatisfactory - Product Unsatisfactory * chargeback - Can be set when you are recording your customer Chargebacks * service_unsatisfactory - Service Unsatisfactory * write_off - This reason will be set automatically for the Credit Notes created during invoice Write Off operation. * subscription_change - This reason will be set automatically for Credit Notes created during Change Subscription operation when proration is enabled * fraudulent - FRAUDULENT * other - Can be set when none of the above reason codes are applicable * subscription_pause - This reason will be automatically set to credit notes created during pause/resume subscription operation. * waiver - Waiver * order_cancellation - Order Cancellation * order_change - Order Change * subscription_cancellation - This reason will be set automatically for Credit Notes created during cancel subscription operation Possible values: `"service_unsatisfactory"` `"other"` `"product_unsatisfactory"` `"order_change"` `"order_cancellation"` `"waiver"`
`credit_note.create_reason_code`	String	No	Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Credit Notes > Create Credit Note. The codes are case-sensitive
`customer_notes`	String	No	The Customer Notes to be filled in the Credit Notes created to capture this refund detail.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.