New Chargeflow docs. Everything for merchants, platforms, and the API in one place.
Log in
Current (2025-04-01)Platforms (Connect) API

Webhooks Events

Webhook event notifications

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

typestringOptional

The webhook type

dataobjectOptional
creationDatestringOptional

The creation date of the webhook in ISO8601 format

Formatdate-time
webhookIdstringOptional

The webhook id

Formatuuid
Default"2ce92305-2f21-4888-a09f-3256bf7c678e"

Response Body

Example Requests

POST/integration.access.error

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

accountIdstringRequired

The unique Chargeflow object identifier

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

The unique Chargeflow dispute identifier

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

The unique Chargeflow evidence identifier

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

The URL to the generated evidence file

versionnumberRequired

The version number of the evidence file

createdAtstringOptional

The timestamp when the evidence was generated

Default"2026-05-07T16:25:29.880Z"

Response Body

Example Requests

POST/evidence.ready

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

accountIdstringRequired

The unique Chargeflow object identifier

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

The unique Chargeflow dispute identifier

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

The unique Chargeflow evidence identifier

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

The error code indicating the type of failure

errorMessagestringRequired

A descriptive message explaining the error

versionnumberRequired

The version number of the evidence file

createdAtstringOptional

The timestamp when the error occurred

Default"2026-05-07T16:25:29.880Z"

Response Body

Example Requests

POST/evidence.error

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

typestringOptional

The webhook type

dataobjectOptional
creationDatestringOptional

The creation date of the webhook in ISO8601 format

Formatdate-time
webhookIdstringOptional

The webhook id

Formatuuid
Default"e11e21e3-41ec-4c9d-9381-442cb6030ce1"

Response Body

Example Requests

POST/dispute.created
Was this page helpful?
llms.txt