Deprecated API Reference

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

List Dispute Evidence Files

List all of the evidence uploaded to a Dispute resource.

Copy

Copied

curl https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence \
    -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" : {
    "evidences" : [ {
      "id" : "DFcVgoEuDeWn4eSvdZca8Hf",
      "created_at" : "2022-10-06T20:22:54.93Z",
      "updated_at" : "2022-10-06T20:30:00.63Z",
      "dispute" : "DIs7yQRkHDdMYhurzYz72SFk",
      "state" : "SUCCEEDED",
      "tags" : {
        "file-extension" : ".png",
        "content-type" : "image/png",
        "file-name" : "test_file.png"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFcVgoEuDeWn4eSvdZca8Hf"
        }
      }
    }, {
      "id" : "DF8o9GZJnn47X3C1hfPBYfFP",
      "created_at" : "2022-08-30T01:05:48.62Z",
      "updated_at" : "2022-08-30T01:15:00.54Z",
      "dispute" : "DIs7yQRkHDdMYhurzYz72SFk",
      "state" : "SUCCEEDED",
      "tags" : {
        "file-extension" : ".png",
        "content-type" : "image/png",
        "file-name" : "test.png"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF8o9GZJnn47X3C1hfPBYfFP"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence"
    },
    "next" : {
      "href" : "https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence?after_cursor=DF8o9GZJnn47X3C1hfPBYfFP"
    }
  },
  "page" : {
    "limit" : 100,
    "next_cursor" : "DF8o9GZJnn47X3C1hfPBYfFP"
  }
}

HTTP Request

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

URL Parameters

`Parameter`	Description
:DISPUTE_ID:	ID of the `Dispute`

Response

Field	Type	Description
`id`	string	ID of the `Dispute` evidence file
`created_at`	string	Timestamp of when the `Dispute` evidence file was created
`updated_at`	string	Timestamp of when the `Dispute` evidence file was updated
`content_type`	string	Specifies the data being sent to and from the client
`dispute`	string	ID of the `Dispute`
`file_extension`	string	File format type
`file_name`	string	`Dispute` file name
`state`	string	The state of the evidence upload. There are four available values: PENDING, SUCCEEDED, CANCELED, or FAILED
`tags`	object	Key value pair for annotating custom metadata