Current (2025-04-01)Platforms (Connect) API

Evidence

POST
/public/2025-04-01/evidence
x-api-key<token>

Your Chargeflow API key. Generate it in the Developer Hub under Settings.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

You can either:

  1. Provide an existing dispute_id to associate the evidence with a previously created dispute,
  2. Create a new dispute inline by including all required parameters as defined in the Create a Dispute endpoint documentation

Response Body

application/json

curl -X POST "https://example.com/public/2025-04-01/evidence" \  -H "Content-Type: application/json" \  -d '{    "account_id": "string",    "dispute": {      "dispute_id": "string"    }  }'
{  "id": "string",  "account_id": "string",  "ext_account_id": "string",  "dispute": "string",  "created_at": "2019-08-24T14:15:22Z",  "status": "in_progress",  "file_url": "http://example.com",  "file_version": 1}
GET
/public/2025-04-01/evidence/{evidenceId}
x-api-key<token>

Your Chargeflow API key. Generate it in the Developer Hub under Settings.

In: header

Path Parameters

evidenceId*string

The unique Chargeflow object identifier of the dispute.

Match^[0-9a-fA-F]{24}$

Query Parameters

expand?array<>

Available Expansions

Use the expand parameter to include additional dispute resource details in the response.

Available options:

ParameterDescription
disputeInclude the top-level dispute data in the response
dispute.transactionFull payment transaction details including amount, currency, payment method and more
dispute.orderComplete order details including products, shipping, and fulfillment and more
dispute.subscriptionComplete subscription details including plan, frequency, cancellation reason and more
dispute.activity_logsComplete activity logs details including user events and interactions

Response Body

application/json

curl -X GET "https://example.com/public/2025-04-01/evidence/string"
{  "id": "string",  "account_id": "string",  "ext_account_id": "string",  "dispute": "string",  "created_at": "2019-08-24T14:15:22Z",  "status": "in_progress",  "file_url": "http://example.com",  "file_version": 1}
Was this page helpful?