GET
/
v0
/
business
/
{business_id}
/
refunds
Get all refunds for a business
curl --request GET \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/refunds \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "business_id": "biz_Pk2fNFDd8wj7EFeLWJywc7",
      "external_id": "<string>",
      "amount": 123,
      "amount_paid": 0,
      "memo": "<string>",
      "processor": "<string>",
      "method": "cash",
      "is_return": false,
      "refund_credit": false,
      "refunded_at": "2023-11-07T05:31:56Z",
      "status": "pending",
      "id": "rfu_WQMDNUHpBThYSNh4AprDBo",
      "payments": [
        {
          "amount": 123,
          "id": "rfp_WQMDNUHpBThYSNh4AprDBo",
          "transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo"
        }
      ],
      "refund_invoices": [
        {
          "external_id": "<string>",
          "amount": 123,
          "memo": "<string>",
          "id": "rfi_WQMDNUHpBThYSNh4AprDBo",
          "invoice_id": "inv_WQMDNUHpBThYSNh4AprDBo",
          "invoice_line_id": "inl_WQMDNUHpBThYSNh4AprDBo"
        }
      ]
    }
  ],
  "pagination": {
    "next_page_token": "<string>",
    "previous_page_token": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

business_id
string<biz_string>
required

Query Parameters

status
enum<string> | null

Filter refunds by status

Available options:
pending,
completed,
voided
page_token
string | null
page_size
integer
default:100
Required range: 1 <= x <= 100

Response

200
application/json

Successful Response

The response is of type object.