POST /transactions/{transaction-id}/record_refund

Records a refund made offline. Applicable only for transactions of type = payment.

Servers

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

Path parameters

Name	Type	Required	Description
`transaction-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.
`reference_number`	String	No	The reference number for this transaction. For example, the check number when `payment_method` = `check`.
`custom_payment_method_id`	String	No	Identifier of the custom payment method of this transaction.
`amount`	Integer	No	The amount to be recorded as refunded. Must not exceed amount_unused. If not passed then all of amount_unused is recorded as refunded.
`payment_method`	String	Yes	The payment method used to make the refund. * card - Card * alipay - Alipay * sofort - Sofort * play_store - Play Store * custom - Custom * sepa_instant_transfer - Sepa Instant Transfer * upi - upi * venmo - Venmo * ach_credit - ACH Credit * amazon_payments - Amazon Payments * apple_pay - Apple Pay * ideal - IDEAL * giropay - giropay * boleto - boleto * 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. * automated_bank_transfer - Automated Bank Transfer * wechat_pay - WeChat Pay * sepa_credit - SEPA Credit * google_pay - Google Pay * cash - Cash * netbanking_emandates - netbanking_emandates * unionpay - Unionpay * bancontact - Bancontact * faster_payments - Faster Payments * pay_to - PayTo * bank_transfer - Bank Transfer * paypal_express_checkout - Paypal Express Checkout * app_store - App Store * check - Check * direct_debit - Direct Debit * klarna_pay_now - Klarna Pay Now * dotpay - Dotpay * other - Payment Methods other than the above types Possible values: `"check"` `"chargeback"` `"other"` `"cash"` `"bank_transfer"` `"custom"`
`date`	Integer	Yes	The date when the refund was made.

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.