Create Refund Reversals

Reverse a refund you’ve previously created

POST /tax/refund_reversals

Try it

cURL

cURL

curl --request POST \
  --url https://api.numeralhq.com/tax/refund_reversals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refund_id": "ref_tr_123456789"
}
'

200

{
  "id": "ref_tr_123456789",
  "object": "tax.refund",
  "refund_type": "partial",
  "testmode": "false",
  "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,
          "rate_type": "SALES TAX",
          "jurisdiction_name": "Indiana",
          "fee_amount": 0,
          "note": "Cross-border B2B sale to VAT-registered business, reverse charge applies"
        }
      ],
      "quantity": 2,
      "tax_amount": -14,
      "amount_excluding_tax": -200,
      "amount_including_tax": -214
    }
  ]
}

Refund Reversal Endpoint (2025-05-12)

Reverse a refund you’ve previously created.

Remember to include the X-API-Version: 2025-05-12 header in your request to use this API version.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

refund_id · string

The ID of the refund to reverse

Example:

"ref_tr_123456789"

Response

200

application/json

Refund response

id · string

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.

Example:

"ref_tr_123456789"

object · string

The type of object: tax.refund.

Example:

"tax.refund"

refund_type · string

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

Example:

"partial"

testmode · boolean

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

Example:

"false"

refund_processed_at · number

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:

1714787673

line_items · object[]

Show child attributes

line_items. product · object

Show child attributes

line_items.product. reference_product_name · string

Example:

"Widget"

line_items.product. reference_line_item_id · string

Example:

"line_987654321"

line_items.product. reference_product_id · string

Example:

"p-1233543"

line_items.product. product_tax_code · string

Example:

"GENERAL_MERCHANDISE"

line_items. tax_jurisdictions · (object | null)[]

Show child attributes

line_items.tax_jurisdictions. tax_rate · number

The tax rate percentage applied to this transaction.

Example:

0.07

line_items.tax_jurisdictions. rate_type · string

Example:

"SALES TAX"

line_items.tax_jurisdictions. jurisdiction_name · string

Example:

"Indiana"

line_items.tax_jurisdictions. fee_amount · number

The flat fee that is added to this transaction. Like all numeric values, this will be returned in cents and should be added directly to the tax amount independent of other percentages. For example, a $100 transaction taxed at 5% and with a fee_amount: 50 will lead to ($100 * 5% + 0.50) = $5.50 in tax being charged

Example:

0

line_items.tax_jurisdictions. note · string

Additional information about the tax jurisdiction. Available with API version 2025-05-12. For B2B transactions, reverse charge is determined by comparing origin_address.address_country vs customer.address.address_country (same country = domestic VAT, different countries = reverse charge).

Example:

"Cross-border B2B sale to VAT-registered business, reverse charge applies"

line_items. quantity · number<int32>

The quantity of this product being refunded.

Example:

2

line_items. tax_amount · number<int32>

The tax amount, which should be a negative number for refunds.

Example:

-14

line_items. amount_excluding_tax · number<int32>

The amount excluding tax, which should be a negative number for refunds.

Example:

-200

line_items. amount_including_tax · number<int32>

The amount including tax, which should be a negative number for refunds.

Example:

-214