Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TaxJar Transactions - Refunds API

Refund transaction management

TaxJar Transactions - Refunds API is one of 9 APIs that TaxJar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Transactions - Refunds. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against 2 base URLs: https://api.taxjar.com/v2, https://api.sandbox.taxjar.com/v2.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.taxjar.com/v2/
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

TaxJar Transactions - Refunds API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Use your TaxJar API token. Format: "Bearer [token]" or "Token token=[token]"

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Transactions - Refunds 5

Refund transaction management

GET
/transactions/refunds
List refund transactions
listRefunds 4 params → 200401
POST
/transactions/refunds
Create a refund transaction
createRefund body → 201400401422
GET
/transactions/refunds/{transaction_id}
Show a refund transaction
showRefund 2 params → 200401404
PUT
/transactions/refunds/{transaction_id}
Update a refund transaction
updateRefund 1 param body → 200400401404
DELETE
/transactions/refunds/{transaction_id}
Delete a refund transaction
deleteRefund 2 params → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Refund (20 properties), RefundRequest (19 properties), LineItemRequest (8 properties), LineItem (8 properties). Each schema is shown below with its type and property counts.

LineItem
object
8 properties
LineItemRequest
object
8 properties
RefundRequest
object
19 properties 9 required
Refund
object
20 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

taxjar-transactions-refunds-api-openapi.yml Raw ↑

Other APIs TaxJar publishes across the network.

TaxJar Categories API
TaxJar Customers API
TaxJar Nexus API
TaxJar Rates API
TaxJar Summary Rates API
TaxJar Taxes API
TaxJar Transactions - Orders API
TaxJar Validations API