POST /credit_notes/{credit-note-id}/record_refund

Refunds a (refundable) credit note. The refund is provided against linked_payments first and then against any linked_taxes_withheld for the invoice associated with the credit_note. For payments made via online transactions, the refund request is processed via the payment source associated with the transaction.

Servers

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

Path parameters

Name	Type	Required	Description
`credit-note-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	Remarks, if any, on the refund.
`transaction`	Object	No	Parameters for transaction
`transaction.reference_number`	String	No	The reference number for this transaction. For example, the check number when payment_method = `check`.
`transaction.custom_payment_method_id`	String	No	Identifier of the custom payment method of this transaction.
`transaction.amount`	Integer	No	The amount to be refunded (for online payments) or recorded as refunded (for offline payments). If not specified, the entire refundable amount for this `credit_note` is refunded. Note: Any linked_tax_withheld_refunds associated with the `credit_note` can also be recorded as refunded via this operation.
`transaction.payment_method`	String	Yes	The payment method of this transaction * cash - Cash * paypal_express_checkout - Paypal Express Checkout * automated_bank_transfer - Automated Bank Transfer * venmo - Venmo * bancontact - Bancontact * custom - Custom * ideal - IDEAL * check - Check * upi - upi * sepa_instant_transfer - Sepa Instant Transfer * alipay - Alipay * sepa_credit - SEPA Credit * ach_credit - ACH Credit * faster_payments - Faster Payments * sofort - Sofort * direct_debit - Direct Debit * bank_transfer - Bank Transfer * chargeback - Only applicable for a transaction of type = `refund`. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a refund. * unionpay - Unionpay * apple_pay - Apple Pay * dotpay - Dotpay * netbanking_emandates - netbanking_emandates * amazon_payments - Amazon Payments * wechat_pay - WeChat Pay * google_pay - Google Pay * card - Card * klarna_pay_now - Klarna Pay Now * other - Payment Methods other than the above types * boleto - boleto * giropay - giropay * pay_to - PayTo Possible values: `"check"` `"chargeback"` `"other"` `"cash"` `"bank_transfer"` `"custom"`
`transaction.date`	Integer	Yes	Indicates when this transaction occurred.
`refund_reason_code`	String	No	Reason code for the refund. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Credit Notes > Refund Credit Note. Must be passed if set as mandatory in the app. The codes are case-sensitive.

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.