HomeGuidesAPI ReferenceChangelog
Log In

Refund the total amount of an invoice (specified by Invoice ID) with empty body, or partial refund by providing a body with the amount.

Upon successful refund, the operation will return a status code of 200 (OK).

If the refund amount exceeds the remaining amount for the refund, or an invalid field or value is submitted, then a status code of 400 (Bad Request) will be returned.

If the Invoice ID cannot be associated with an active invoice, a status of 404 (Not Found) will be returned.

If the refund could not be completed, the operation will return a status of 422 (UnprocessableEntity) will be returned.

Refunds potentially might not be completed because of an invalid payment method e.g. a deleted payment method or the payment processor rejected the refund.

Optional Fields
NameDescriptionDefault value
RefundAmountDollar amount to be refunded. If no amount is provided, value defaults to invoice total
Click Try It! to start a request and see the response here!