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

Tabby Disputes API

The Disputes API is designed to simplify the process of handling disputes and help merchants resolve issues with customer orders more efficiently. Merchants can use this API to retrieve a list of disputes, view details about a specific dispute, and approve or challenge a bunch of disputes. It mirrors the functionality available in Tabby Merchant Dashboard and operates exclusively with live payments using live credentials. A secret key is required for using the Disputes API.

Tabby Disputes API is one of 4 APIs that Tabby publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include Disputes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 7 JSON Schemas.

This API exposes 6 operations across 6 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.tabby.ai/, https://api.tabby.sa/.

6 operations 6 paths 21 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://api.tabby.ai/
https://api.tabby.sa/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Tabby Disputes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Bearer authentication header of the form Bearer , where is your secretkey.

Paths & Operations 6

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

Disputes 6

The Disputes API is designed to simplify the process of handling disputes and help merchants resolve issues with customer orders more efficiently. Merchants can use this API to re…

GET
/api/v1/disputes
Get disputes list
getDisputes 4 params → 200400401404500
GET
/api/v1/disputes/{disputeId}
Get dispute by id
getDispute 1 param → 200400401404500
POST
/api/v1/disputes/{disputeId}/provide-evidence
Provide evidence for a dispute
postDisputeProvideEvidence 1 param body → 200400401404409500
POST
/api/v1/disputes/approve
Approve disputes
postDisputesApprove body → 200400401404500
POST
/api/v1/disputes/challenge
Challenge disputes
postDisputesChallenge body → 200400401404500
POST
/api/v1/disputes/attachments/upload
Upload attachment
postUploadAttachment body → 200400401500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Dispute (14 properties), DisputeNoHistory (13 properties), DisputeHistoryItem (7 properties), Evidence (6 properties). Each schema is shown below with its type and property counts.

DisputeAttachments
array
Array of links to images which were uploaded by customer.
Error_401_invalid_secret_key
object
3 properties
Error_404_dispute_not_found
object
3 properties
Dispute
object
14 properties 14 required
Currency
string
ISO 4217 currency code for the payment amount. Currently there are 3 possible currency options - depending on the country where the store is located: - AED - U…
Evidence
object
6 properties 5 required
Error_404
string
DisputeID
string
ID of the dispute.
Error_500
string
DisputeComment
string
The customer additional comments on the causes of the dispute.
DisputeReason
string
Cause of the dispute was created (selected by customer). There are only four reasons: - unreceivedrefund - a refund not received - identitytheft - I did not pl…
DisputeStatus
string
The current status of the dispute: - new - dispute pending merchant approval for refund or initiate a challenge - declined - dispute was declined by Tabby supp…
DisputeCreatedAt
string
Date and time the Dispute was created, in UTC, and displayed in ISO 8601 datetime format.
DisputeNoHistory
object
13 properties 13 required
DisputeDaysLeft
integer
How many days left before dispute will be automatically approved.
DisputeOrderItem
object
3 properties 3 required
Error_400_bad_request
object
3 properties
DisputeExpiredAt
string
Date and time of the expiration of the Dispute, in UTC, and displayed in ISO 8601 datetime format.
Error_409
object
3 properties
DisputeHistoryItem
object
7 properties 6 required
PaymentID
string
Unique identifier for the payment (UUID), assigned by Tabby. Save it on your side!

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tabby-disputes-api-openapi.yml Raw ↑

Other APIs Tabby publishes across the network.

Tabby Checkout API
Tabby Payments API
Tabby Webhooks API