Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

List All Disputes

List all the Dispute resources that have been created.

Copy
Copied
curl https://finix.sandbox-payments-api.com/disputes/ \
    -H "Content-Type: application/vnd.json+api" \
    -H 'Finix-Version:2022-02-01' \
    -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e

Example Response:

Copy
Copied
{
  "_embedded" : {
    "disputes" : [ {
      "id" : "DIb72obRhTmPdMG1VxDKFLrb",
      "created_at" : "2022-07-14T19:40:06.52Z",
      "updated_at" : "2022-07-14T19:40:06.11Z",
      "action" : null,
      "amount" : 888888,
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "dispute_details" : {
        "arn" : "123"
      },
      "identity" : "IDuqZpDw28f2KK6YuDk4jNLg",
      "message" : null,
      "occurred_at" : "2022-07-14T19:39:00.77Z",
      "reason" : "FRAUD",
      "respond_by" : "2022-07-21T19:40:06.51Z",
      "state" : "PENDING",
      "tags" : {
        "test" : "sale"
      },
      "transfer" : "TRkhvS4GfMKxaHyBBdkPSx6g",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "transfer" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRkhvS4GfMKxaHyBBdkPSx6g"
        },
        "evidence" : {
          "href" : "https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb/evidence"
        },
        "adjustment_transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb/adjustment_transfers"
        }
      }
    }, {
      "id" : "DIs7yQRkHDdMYhurzYz72SFk",
      "created_at" : "2022-01-27T07:43:03.74Z",
      "updated_at" : "2022-09-16T22:21:54.75Z",
      "action" : null,
      "amount" : 888888,
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "dispute_details" : {
        "arn" : "123"
      },
      "identity" : "IDpYDM7J9n57q849o9E9yNrG",
      "message" : null,
      "occurred_at" : "2022-01-27T07:42:48.56Z",
      "reason" : "FRAUD",
      "respond_by" : "2022-02-03T07:43:03.73Z",
      "state" : "WON",
      "tags" : {
        "order_number" : "21DFASJSAKAS"
      },
      "transfer" : "TRoTrJ3kqNTFh1P2FJ7A36Ky",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "transfer" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky"
        },
        "evidence" : {
          "href" : "https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence"
        },
        "adjustment_transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/disputes/?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 3
  }
}

HTTP Request

GET https://finix.sandbox-payments-api.com/disputes/

Response

Field Type Description
reason integer The system defined reason for the Dispute. It is one of the following values: INQUIRY, QUALITY, CLERICAL, FRAUD, or TECHNICAL
state integer The current state of the Dispute. It is one of the following values: INQUIRY, PENDING, WON, or LOSS