Fetch a Dispute Evidence File
attention
This API is available for Finix Flex and Finix Core customers.
Fetch a previously uploaded Dispute
evidence file. Users can view the status of their evidence upload to check if the file was successfully sent to the processor if they do not have access to the Dashboard.
curl https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFnA9eVoYxRnxxLKzgcGGxYL \
-H "Content-Type: application/vnd.json+api" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Example Response:
{
"id" : "DFnA9eVoYxRnxxLKzgcGGxYL",
"tags" : {
"file-extension" : ".pdf",
"content-type" : "application/pdf",
"file-name" : "testfile.pdf"
},
"dispute" : "DIs7yQRkHDdMYhurzYz72SFk",
"state" : "PENDING",
"created_at" : "2022-01-27T07:43:56.13Z",
"updated_at" : "2022-01-27T07:43:55.90Z",
"_links" : {
"self" : {
"href" : "https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFnA9eVoYxRnxxLKzgcGGxYL"
}
}
}
HTTP Request
GET https://finix.sandbox-payments-api.com/disputes/:DISPUTE_ID/evidence/:EVIDENCE_ID
URL Parameters
Parameter |
Description |
---|---|
:DISPUTE_ID | ID of the Dispute |
:EVIDENCE_ID | ID of the Dispute evidence file |
Response
Field | Type | Description |
---|---|---|
id |
string | ID of the Dispute evidence file |
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 |
created_at |
string | Timestamp of when the Dispute evidence file was created |
updated_at |
string | Timestamp of when the Dispute evidence file was updated |