Skip to main content
POST
/
v0
/
business
/
{business_id}
/
refund
Refund an Invoice
curl --request POST \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 100,
  "refund_external_id": "<string>",
  "refunded_at": "2023-11-07T05:31:56Z",
  "method": "cash",
  "invoices_to_refund": [
    {
      "amount": 100,
      "invoice_id": "inv_WQMDNUHpBThYSNh4AprDBo",
      "invoice_external_id": "ext_inv_001",
      "invoice_line_id": "inl_WQMDNUHpBThYSNh4AprDBo",
      "memo": "Refund for returned item"
    }
  ],
  "memo": "Customer returned defective item",
  "processor": "John Doe",
  "is_return": false
}
'
{
  "data": {
    "business_id": "<string>",
    "external_id": "<string>",
    "amount": 123,
    "method": "cash",
    "refunded_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "amount_paid": 0,
    "memo": "<string>",
    "processor": "<string>",
    "is_return": false,
    "status": "pending",
    "payments": [
      {
        "amount": 123,
        "id": "<string>",
        "transaction_id": "<string>"
      }
    ],
    "refund_invoices": [
      {
        "amount": 123,
        "id": "<string>",
        "invoice_id": "<string>",
        "invoice_line_id": "inl_WQMDNUHpBThYSNh4AprDBo",
        "external_id": "<string>",
        "memo": "<string>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getasset.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-user-id
string | null

Optional external entity identifier that performed the action

Path Parameters

business_id
string<biz_string>
required

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

Body

application/json
amount
required

The amount to refund.

Required range: x > 0
Example:

100

refund_external_id
string
required

The external ID of the refund.

Maximum string length: 255
Example:

"ref_ext_001"

refunded_at
string<date-time>
required

The date and time of the refund.

Example:

"2025-01-15T14:30:00Z"

method
enum<string>
required

The method of the refund.

Available options:
cash,
check,
credit_card,
ach,
credit_balance,
other
Examples:

"cash"

"check"

"credit_card"

"ach"

"credit_balance"

"other"

invoices_to_refund
InvoicesToRefundRequest · object[]
required

The invoices to refund.

Required array length: 1 - 100 elements
memo
string | null

The memo for the refund.

Maximum string length: 255
Example:

"Customer returned defective item"

processor
string | null

The name of the person who processed the refund.

Maximum string length: 255
Example:

"John Doe"

is_return
boolean
default:false

Whether the refund is for a return.

Response

Successful Response

data
RefundPublic · object
required