Skip to main content
API docs by Redocly

Triple Disputes API (1.0.0)

Download OpenAPI specification:Download

Public API for submitting disputes and retrieving evaluation results.

Evaluations

Create an evaluation

Submit dispute input data for the new evaluation flow.

Authorizations:
BearerAuthentication
Request Body schema: application/json
required
required
object (Dispute)

Dispute details including the description, disputed amount and currency.

required
object (Transaction)

Transaction being disputed.

required
object (Evidences)

Evidences supporting the dispute.

Responses

Request samples

Content type
application/json
{
  • "dispute": {
    },
  • "transaction": {
    },
  • "evidences": {
    }
}

Get evaluation result

Retrieve the finished result for a singular evaluation.

Authorizations:
BearerAuthentication
path Parameters
evaluation_id
required
string <uuid> (Evaluation Id)

Responses

Response samples

Content type
application/json
{
  • "evaluation_id": "eval_a1b2c3",
  • "confidence": "high",
  • "reason_code": "10.4",
  • "failed_rules": [
    ],
  • "failed_custom_rules": [
    ]
}

Get dispute resolution document

Authorizations:
BearerAuthentication
path Parameters
evaluation_id
required
string <uuid> (Evaluation Id)

Responses

Response samples

Content type
application/json
{
  • "evaluation_id": "4108ec8e-6efd-4b9b-bace-0bb4c296c324",
  • "document": {
    }
}

Get or generate dispute resolution document

Authorizations:
BearerAuthentication
path Parameters
evaluation_id
required
string <uuid> (Evaluation Id)

Responses

Response samples

Content type
application/json
{
  • "evaluation_id": "4108ec8e-6efd-4b9b-bace-0bb4c296c324",
  • "document": {
    }
}

Disputes

Create a dispute

Authorizations:
BearerAuthentication
Request Body schema: application/json
required
required
object (DisputeIn)
required
object (Transaction)

Transaction details for the disputed charge.

required
object (Evidences)

Responses

Request samples

Content type
application/json
{
  • "dispute": {
    },
  • "transaction": {
    },
  • "evidences": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "running",
  • "confidence": "string",
  • "reason_code": "string",
  • "workflow_version": {
    },
  • "current_node": "string",
  • "latest_run_id": "01a26ba9-be7a-49f1-b8f1-c778060a6d27",
  • "created": "2019-08-24T14:15:22Z",
  • "dispute": {
    },
  • "transaction": {
    },
  • "evidences": {
    },
  • "document": {
    }
}

Get dispute

Authorizations:
BearerAuthentication
path Parameters
dispute_id
required
string <uuid> (Dispute Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "running",
  • "confidence": "string",
  • "reason_code": "string",
  • "workflow_version": {
    },
  • "current_node": "string",
  • "latest_run_id": "01a26ba9-be7a-49f1-b8f1-c778060a6d27",
  • "created": "2019-08-24T14:15:22Z",
  • "dispute": {
    },
  • "transaction": {
    },
  • "evidences": {
    },
  • "document": {
    },
  • "runs": [ ]
}

Get dispute resolution document

Authorizations:
BearerAuthentication
path Parameters
dispute_id
required
string <uuid> (Dispute Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "card_scheme": "string",
  • "file": {
    },
  • "created_at": "2019-08-24T14:15:22Z"
}

Get or generate dispute resolution document

Authorizations:
BearerAuthentication
path Parameters
dispute_id
required
string <uuid> (Dispute Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "card_scheme": "string",
  • "file": {
    },
  • "created_at": "2019-08-24T14:15:22Z"
}

Files

Upload an evidence file

Upload an evidence file and receive its id for use in evaluations.

Authorizations:
BearerAuthentication
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{}

Get file metadata and signed URL

Retrieve metadata and a signed URL for an evidence file.

Authorizations:
BearerAuthentication
path Parameters
file_id
required
string <uuid> (File Id)

Responses

Response samples

Content type
application/json
{}