Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26286592.7 KB

Add a refund to a transaction

post/tax/refunds

Request body

transaction_idstring required

The ID of the transaction to refund. This is the transaction_id returned from the /transactions creation response.

typestring required

This will be either 'full' or 'partial'. If type='partial', you must also provide the line item(s) you wish to apply refunds against.

refund_processed_atnumber

Unix timestamp in seconds representing the date and time the refund was made. If not provided, the current date and time will be used.

Example request

{
  "transaction_id": "tr_123456789",
  "type": "partial",
  "refund_processed_at": 1714787673,
  "line_items": [
    {
      "reference_product_id": "p-1233543",
      "reference_line_item_id": "line_123456789",
      "sales_amount_refunded": -200,
      "quantity": 2,
      "tax_amount_refunded": -14
    }
  ]
}

Response

Refund response

idstring

The ID of the refund. We recommend you store this value. If you need to reverse this refund, you will be required to reference this ID.

objectstring

The type of object: tax.refund.

refund_typestring

This will be either 'full' or 'partial'.

testmodeboolean

True if using a production API key. False if using a test API key.

refund_processed_atnumber

Unix timestamp in seconds representing the date and time the refund was made. If not provided, the time the refund was created will be used.

Example response

{
  "id": "ref_tr_123456789",
  "object": "tax.refund",
  "refund_type": "partial",
  "refund_processed_at": 1714787673,
  "line_items": [
    {
      "product": {
        "reference_product_name": "Widget",
        "reference_line_item_id": "line_987654321",
        "reference_product_id": "p-1233543",
        "product_tax_code": "GENERAL_MERCHANDISE"
      },
      "tax_jurisdictions": [
        {
          "tax_rate": 0.07,
          "tax_due_decimal": 700,
          "rate_type": "GENERAL STATE SALES TAX",
          "tax_authority_name": "Tennessee",
          "tax_type": "SALES"
        }
      ],
      "quantity": 2,
      "tax_amount": -14,
      "amount_excluding_tax": -200,
      "amount_including_tax": -214
    }
  ]
}