API Playground
Payments
Webhooks
curl --request GET \
--url https://api.tabby.ai/api/v1/disputes/{disputeId} \
--header 'Authorization: Bearer <token>'{
"dispute": {
"id": "dispute id, uuid format",
"attachments": [
"attachment_1"
],
"payment_id": "payment id, uuid format",
"amount": "100.00",
"currency": "AED",
"created_at": "2018-10-17T00:00:00.000Z",
"expired_at": "2018-10-17T00:00:00.000Z",
"status": "new",
"reason": "unreceived_refund",
"days_left": 123,
"history": [
{
"attachments": [
"attachment_1"
],
"created_at": "2018-10-17T00:00:00.000Z",
"created_by": "email address of the source",
"content": "customer comment",
"source": "merchant",
"event_type": "dispute_created",
"note": "additional comments"
}
],
"items": [
{
"reference_id": "payment id",
"title": "Order item title",
"unit_price": "100.00"
}
],
"order_number": "#1234",
"comment": "additional comments"
}
}Get dispute by id
Returns detailed information about dispute.
curl --request GET \
--url https://api.tabby.ai/api/v1/disputes/{disputeId} \
--header 'Authorization: Bearer <token>'{
"dispute": {
"id": "dispute id, uuid format",
"attachments": [
"attachment_1"
],
"payment_id": "payment id, uuid format",
"amount": "100.00",
"currency": "AED",
"created_at": "2018-10-17T00:00:00.000Z",
"expired_at": "2018-10-17T00:00:00.000Z",
"status": "new",
"reason": "unreceived_refund",
"days_left": 123,
"history": [
{
"attachments": [
"attachment_1"
],
"created_at": "2018-10-17T00:00:00.000Z",
"created_by": "email address of the source",
"content": "customer comment",
"source": "merchant",
"event_type": "dispute_created",
"note": "additional comments"
}
],
"items": [
{
"reference_id": "payment id",
"title": "Order item title",
"unit_price": "100.00"
}
],
"order_number": "#1234",
"comment": "additional comments"
}
}Authorizations
Bearer authentication header of the form Bearer <secret_key>, where <secret_key> is your secret_key.
Path Parameters
ID of the dispute.
"dispute id, uuid format"
Response
Success. Returns dispute info.
Show child attributes
Show child attributes
ID of the dispute.
"dispute id, uuid format"
Array of links to images which were uploaded by customer.
ID of the payment.
"payment id, uuid format"
Total disputed amount.
"100.00"
The currency of the dispute. It's always equal to the currency of the payment.
AED, SAR, KWD "AED"
Date and time the Dispute was created, in UTC, and displayed in ISO 8601 datetime format.
"2018-10-17T00:00:00.000Z"
Date and time of the expiration of the Dispute, in UTC, and displayed in ISO 8601 datetime format.
"2018-10-17T00:00:00.000Z"
The current status of the dispute:
new- dispute pending merchant approval for refund or initiate a challengedeclined- dispute was declined by Tabby supportcancelled- dispute was canceled by customerrefunded- dispute was approved or the order was refunded via Payments APIin_progress- merchant challenged dispute and need a response from Tabby support
new, declined, cancelled, refunded, in_progress "new"
Cause of the dispute was created (selected by customer). There are only four reasons:
unreceived_refund- a refund not receivedidentity_theft- I did not place this order (also known as identity theft)product_issue- there was a problem with the productnot_delivered- the order was not delivered
unreceived_refund, identity_theft, product_issue, not_delivered "unreceived_refund"
How many days left before dispute will be automatically approved.
Show child attributes
Show child attributes
Array of links to images which were uploaded by customer or merchant.
Date and time of creation of dispute history items, in UTC, and displayed in ISO 8601 datetime format.
"2018-10-17T00:00:00.000Z"
Indicates the entity responsible for the creation of the record. It can take one of the following values:
- If
sourceis set tocustomer, this field will contain the email address of the customer; - If
sourceis set tomerchantand the action was performed through the merchant-dashboard, then field will contain the email address of the dashboard user; - If
sourceis set tomerchantand the action was performed through the Disputes API, this field will contain the constant value 'Disputes API'; - If
sourceis set totabby-support, this field will be empty.
"email address of the source"
Contains additional information or comments related to the performed action. It can take one of the following values:
- If
sourceis set tocustomer, this field will contain the customer's comment. - If
sourceis set tomerchant, this field will contain the reason for the challenge. - If
sourceis set totabby-support, this field will be empty.
"customer comment"
This field specifies author that led to the creation of the record. It can take one of the following values:
customer: Indicates that the action was initiated by a customer;merchant: Indicates that the action was initiated by a merchant;tabby-support: Indicates that the action was initiated by Tabby support.
customer, merchant, tabby-support "merchant"
The event type of the dispute history item:
dispute_created- the customer raised a dispute;dispute_approved- disputed was approved and amount was refunded to customer;dispute_declined- dispute was declined by Tabby support;dispute_canceled- dispute was canceled by customer;dispute_in_arbitration- merchant challenged dispute (e.g incorrect amount);dispute_amount_changed- disputed amount was changed;dispute_comment_added- merchant added comment to the dispute.
dispute_created, dispute_approved, dispute_declined, dispute_canceled, dispute_in_arbitration, dispute_amount_changed, dispute_comment_added "dispute_created"
Contains additional message provided by merchant while perform action.
"additional comments"
Merchant-assigned order number.
"#1234"
The customer additional comments on the causes of the dispute.
"additional comments"
Was this page helpful?