Find Refunds for Transaction

Retrieve the refunds for a specific transaction

GET /tax/transactions/{transaction_id}/refunds

cURL

cURL

curl --request GET \
  --url https://api.numeralhq.com/tax/transactions/{transaction_id}/refunds \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.numeralhq.com/tax/transactions/{transaction_id}/refunds"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.numeralhq.com/tax/transactions/{transaction_id}/refunds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.numeralhq.com/tax/transactions/{transaction_id}/refunds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.numeralhq.com/tax/transactions/{transaction_id}/refunds"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.numeralhq.com/tax/transactions/{transaction_id}/refunds")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.numeralhq.com/tax/transactions/{transaction_id}/refunds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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,
              "tax_due_decimal": 700,
              "rate_type": "GENERAL STATE SALES TAX",
              "fee_amount": 0,
              "tax_authority_name": "Tennessee",
              "tax_authority_type": "",
              "tax_type": "SALES"
            }
          ],
          "quantity": 2,
          "tax_amount": -14,
          "amount_excluding_tax": -200,
          "amount_including_tax": -214
        }
      ]
    }
  ]
}

{
  "error": {
    "error_code": "missing_field",
    "error_message": "Field is required",
    "error_meta": {
      "field": "path.to.fieldname",
      "expected": "string",
      "received": "undefined"
    }
  }
}

Get Refunds for Transaction Endpoint (2024-09-01)

Retrieve the refunds for a specific transaction using its ID.

Authorizations

Authorization · string · header · required

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

Path Parameters

transaction_id · string · required

The transaction ID used to fetch associated refunds

Response

200

application/json

List of refunds for a specific transaction

refunds · object[]

Show child attributes