Refund an Invoice
Scopes: invoice:create
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Optional external entity identifier that performed the action
Path Parameters
The id of the business
"biz_GA6EG2qFxA97NZHtxeLPUy"
Body
The amount to refund.
x > 0100
The external ID of the refund.
255"ref_ext_001"
The date and time of the refund.
"2025-01-15T14:30:00Z"
The method of the refund.
cash, check, credit_card, ach, credit_balance, other "cash"
"check"
"credit_card"
"ach"
"credit_balance"
"other"
The invoices to refund.
1 - 100 elementsThe memo for the refund.
255"Customer returned defective item"
The name of the person who processed the refund.
255"John Doe"
Whether the refund is for a return.
Inline tag input. Each field maps to either a single value (string, e.g. 'NYC') or a list of {value, amount} objects to allocate the refund across multiple values. The tag field must already exist; values are created automatically if missing. Per-field sum of amounts must not exceed the refund amount.
{ "Location": "NYC" }Response
Successful Response