Get Started
Integration FAQs
Essentials
Calculations
Transactions
Find Refunds for Transaction
Retrieve the refunds for a specific transaction
curl --request GET \
--url https://api.numeralhq.com/tax/transactions/{transaction_id}/refunds \
--header 'Authorization: Bearer <token>'{
"refunds": [
{
"id": "ref_tr_123456789",
"object": "tax.refund",
"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": "STATE SALES TAX",
"jurisdiction_name": "Indiana",
"fee_amount": 0
}
],
"quantity": 2,
"tax_amount": -14,
"amount_excluding_tax": -200,
"amount_including_tax": -214
}
]
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The transaction ID used to fetch associated refunds
Response
The ID of the refund
The type of object: tax.refund.
True if using a production API key. False if using a test API key.
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.
The tax rate percentage applied to this transaction.
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
The quantity of this product being refunded.
The tax amount, which should be a negative number for refunds.
The amount excluding tax, which should be a negative number for refunds.
The amount including tax, which should be a negative number for refunds.
curl --request GET \
--url https://api.numeralhq.com/tax/transactions/{transaction_id}/refunds \
--header 'Authorization: Bearer <token>'{
"refunds": [
{
"id": "ref_tr_123456789",
"object": "tax.refund",
"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": "STATE SALES TAX",
"jurisdiction_name": "Indiana",
"fee_amount": 0
}
],
"quantity": 2,
"tax_amount": -14,
"amount_excluding_tax": -200,
"amount_including_tax": -214
}
]
}
]
}