Challenge disputes

curl --request POST \
  --url https://api.tabby.ai/api/v1/disputes/challenge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dispute_id": "uuid",
  "description": "Comment for Tabby support",
  "reason": "merchant_reason_other",
  "amount": "100",
  "attachment_ids": [
    "attachment id, uuid format"
  ]
}
'

{
  "disputes": [
    {
      "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,
      "items": [
        {
          "reference_id": "payment id",
          "title": "Order item title",
          "unit_price": "100.00"
        }
      ],
      "order_number": "#1234",
      "comment": "additional comments"
    }
  ]
}

POST

api

disputes

challenge

Challenge disputes

curl --request POST \
  --url https://api.tabby.ai/api/v1/disputes/challenge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dispute_id": "uuid",
  "description": "Comment for Tabby support",
  "reason": "merchant_reason_other",
  "amount": "100",
  "attachment_ids": [
    "attachment id, uuid format"
  ]
}
'

{
  "disputes": [
    {
      "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,
      "items": [
        {
          "reference_id": "payment id",
          "title": "Order item title",
          "unit_price": "100.00"
        }
      ],
      "order_number": "#1234",
      "comment": "additional comments"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

dispute_id

string

required

ID of the dispute

Example:

"uuid"

description

string

required

Comment for Tabby support.

Example:

"Comment for Tabby support"

reason

enum<string>

required

Reason for requesting dispute challenge:

merchant_reason_other - there were other problems with the order that required further clarification;
merchant_reason_order_on_its_way - the order has been confirmed and is in the process of being delivered;
merchant_reason_order_has_been_already_delivered - the order has already been delivered and is complete;
merchant_reason_order_amount_should_be_different - there was a problem with the amount of the order and it needed to be changed;
merchant_reason_problem_with_delivery - there was a problem with the order during delivery that needed to be adjusted and resolved.

Available options:

merchant_reason_other,

merchant_reason_order_on_its_way,

merchant_reason_order_has_been_already_delivered,

merchant_reason_order_amount_should_be_different,

merchant_reason_problem_with_delivery

Example:

"merchant_reason_other"

amount

string

If the dispute challenged with reason merchant_reason_order_amount_should_be_different - a new disputed amount is required.

Example:

"100"

attachment_ids

string<uuid>[]

Attachment ID that will be attached. ID can be received via upload attachment endpoint.

Response

Success. Disputes were challenged.

disputes

object[]

Show child attributes

disputes.id

string<uuid>

required

ID of the dispute.

Example:

"dispute id, uuid format"

disputes.attachments

string[] | null

required

Array of links to images which were uploaded by customer.

disputes.payment_id

string<uuid>

required

ID of the payment.

Example:

"payment id, uuid format"

disputes.amount

string

required

Total disputed amount.

Example:

"100.00"

disputes.currency

enum<string>

required

The currency of the dispute. It's always equal to the currency of the payment.

Available options:

AED,

SAR,

KWD

Example:

"AED"

disputes.created_at

string

required

Date and time the Dispute was created, in UTC, and displayed in ISO 8601 datetime format.

Example:

"2018-10-17T00:00:00.000Z"

disputes.expired_at

string

required

Date and time of the expiration of the Dispute, in UTC, and displayed in ISO 8601 datetime format.

Example:

"2018-10-17T00:00:00.000Z"

disputes.status

enum<string>

required

The current status of the dispute:

new - dispute pending merchant approval for refund or initiate a challenge
declined - dispute was declined by Tabby support
cancelled - dispute was canceled by customer
refunded - dispute was approved or the order was refunded via Payments API
in_progress - merchant challenged dispute and need a response from Tabby support

Available options:

new,

declined,

cancelled,

refunded,

in_progress

Example:

"new"

disputes.reason

enum<string>

required

Cause of the dispute was created (selected by customer). There are only four reasons:

unreceived_refund - a refund not received
identity_theft - I did not place this order (also known as identity theft)
product_issue - there was a problem with the product
not_delivered - the order was not delivered

Available options:

unreceived_refund,

identity_theft,

product_issue,

not_delivered

Example:

"unreceived_refund"

disputes.days_left

integer<uint16>

required

How many days left before dispute will be automatically approved.

disputes.items

object[]

required

Show child attributes

disputes.items.reference_id

string

required

Reference id from payment.

Example:

"payment id"

disputes.items.title

string

required

Order item title.

Example:

"Order item title"

disputes.items.unit_price

string

required

Order item unit price.

Example:

"100.00"

disputes.order_number

string

required

Merchant-assigned order number.

Example:

"#1234"

disputes.comment

string

required

The customer additional comments on the causes of the dispute.

Example:

"additional comments"

Approve disputes Upload attachment

⌘I

API Playground

Checkout

Payments

Webhooks

Disputes

Challenge disputes

Authorizations

Body

Response