Create Early Alert

post

https://api.signifyd.com/v3/orders/events/chargebacks/earlyalert

To create an early alert against an order in the Signifyd system, you need to record an Early Alert Event.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

alertProviderReferenceId

string

required

Unique reference associated with the early alert by the provider and maintained throughout the life cycle of the transaction.

amount

object

required

The amount of the transaction and the currency it is within.

cardBin

integer

required

Card Bank Identification Number

merchantName

string

required

Name of the merchant associated with this early alert

orderId

string

required

The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event.

alertName

string

Provider’s name for the early alert.

alertProviderReportedDate

date-time

The date on which the early alert was reported by the provider. Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601

alertInitiatedBy

string

enum

Whether the transaction was initially identified by the card holder or the card issuer.

ISSUER - This indicates that an alert was initiated by the issuer.
CARDHOLDER - This indicates that an alert was initiated by the cardholder.
NOT_AVAILABLE - When the initiator is unknown or unavailable.

Allowed:

cardholderEmail

string

Email address for the cardholder

cardholderName

string

Name associated with the cardholder

merchantId

string

The merchant account identifier used in the transaction the alert is for.

mcc

string

A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. An MCC is used to classify every business that accepts card payments by the goods or services it provides. The MCC is provided by payment processors on authorizations.

cardScheme

string

Card scheme linked to payment card

issuer

string

The name of the card issuer

transactionId

string

Unique value assigned by the card scheme (VISA/Mastercard, etc.) to each transaction on the Authorization and maintained throughout the life cycle of the transaction.

arn

string

Acquirer Reference Number assigned to the transaction

alertReasonCode

string

The card scheme-specific chargeback reason code which indicates the cardholder’s reason for disputing the transaction.

alertReasonDescription

string

Description of the alert reason

alertOutcome

string

The outcome for the alert.

Headers

SIGNIFYD-TEAM-ID

int64

The team id requested for authentication. This should normally be omitted, as it's only relevant when auth credentials allow requests for multiple teams.

Responses

201Returned when an early alert has been successfully created.

400Response if there was a problem with the request, such as when a required field is missing or otherwise fails validation.

401Response if the provided authentication credentials are not known or do not match what is on file for the specified user.

404Response if the requested entity can't be found. This indicates Signifyd could not match the request to an order in the system.

500Response if an unexplained error occurs on the server.