Webhooks Events

Dispute Created Event

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type?string

The webhook type

data?

creationDate?string

The creation date of the webhook in ISO8601 format

Formatdate-time

webhookId?string

The webhook id

Formatuuid

Default"96f76c6b-1a88-4ef9-89a7-522ce542782b"

Response Body

Example Requests

POST/dispute.created

Alerts Created Event

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

The unique identifier of the alert

account_id*string

The account identifier associated with the alert

ext_account_id*|

The external account identifier

transaction?null

The transaction object associated with the alert

created_at*string

The date when the alert was created

network_transaction*

Network transaction details

status_date*string

The date when the status was last updated

status*string

The current status of the alert

Value in

"alerted"
"pending"
"refund_initiated"
"prevented"

statement_descriptor*string

The statement descriptor for the transaction

amount*number

The amount associated with the alert

currency*string

The currency of the alert amount

outcome*string

The outcome of the alert

Value in

"duplicate"
"not_found"
"prevented"
"pending"
"chargebacked"
"previously_refunded"
"error"

type*string

The type of alert

Value in

"ethoca"
"cdrn"
"rdr"
"fraud_warning"
"other"

reason*string

The reason for the alert

Value in

"service"
"fraud"
"processing"
"authorization"

Response Body

Example Requests

POST/alerts.created

Alert Transaction Linked Event

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

The unique identifier of the alert

account_id*string

The account identifier associated with the alert

ext_account_id?string

The external account identifier from the platform

transaction_id?string

The transaction identifier associated with the alert

created_at?string

The date when the alert was created

network_transaction?

Network transaction details associated with the alert

status_date?string

The date when the status was last updated

status?string

The current status of the alert. Status can be one of the following: alerted, pending, refund_initiated, prevented.

statement_descriptor?string

The statement descriptor for the transaction.

amount?number

The amount associated with the alert

currency?string

The currency of the alert amount

outcome?string

The outcome of the alert. Outcome can be one of the following: duplicate, not_found, prevented, pending, chargebacked, previously_refunded, error.

type?string

The type of alert. Type can be one of the following: fraud_warning, ethoca, cdrn, rdr, other.

reason?string

The reason for the alert. Reason can be one of the following: fraud, processing, authorization, service.

transactionId?string

The id of the transaction you want to update alert with

Response Body

Example Requests

POST/alerts.transaction.linked

Alerts Outcome Updated Event

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

The unique identifier of the alert

account_id*string

The account identifier associated with the alert

ext_account_id*|

The external account identifier

transaction?null

The transaction object associated with the alert

created_at*string

The date when the alert was created

network_transaction*

Network transaction details

status_date*string

The date when the status was last updated

status*string

The current status of the alert

Value in

"alerted"
"pending"
"refund_initiated"
"prevented"

statement_descriptor*string

The statement descriptor for the transaction

amount*number

The amount associated with the alert

currency*string

The currency of the alert amount

outcome*string

The outcome of the alert

Value in

"duplicate"
"not_found"
"prevented"
"pending"
"chargebacked"
"previously_refunded"
"error"

type*string

The type of alert

Value in

"ethoca"
"cdrn"
"rdr"
"fraud_warning"
"other"

reason*string

The reason for the alert

Value in

"service"
"fraud"
"processing"
"authorization"

Response Body

Example Requests

POST/alerts.updated

Webhooks Events

200

200

Request Bodyapplication/json

200

Request Bodyapplication/json

200

Request Bodyapplication/json