Skip to content
APIs/FraudSight/
/
Provide details of a paym...

Provide details of a payment that resulted in fraud

Request

Provide payment fraud information.

Security
BasicAuth
Headers
Content-Typestringrequired
Example:application/vnd.worldpay.fraudsight-v1.hal+json
Acceptstringrequired
Example:application/vnd.worldpay.fraudsight-v1.hal+json
Bodyapplication/vnd.worldpay.fraudsight-v1.hal+json
transactionReferencestring, [ 1 .. 64 ] characters^[-A-Za-z0-9_!@#$%()*=.:;?\[\]{}~`/+]*$required

A unique reference for authentication. For example, e-commerce order code.

merchantobjectrequired

An object that contains information about the merchant and API level configuration.

riskProfilestring, (uri), [ 39 .. 2048 ] charactersrequired

Represents the outcome of the original fraud assessment. Used to link subsequent Fraud related requests.

sourcestringrequired

Source format of confirmed fraud cases.

Enum:"SAFE""TC40"
sourceDatestring, (date-time), <= 20 charactersrequired

Date/time of source fraud file (TC40/SAFE).

acquirerReferencestring, [ 1 .. 128 ] charactersrequired

Acquirer Reference Number (ARN) - unique value assigned to a credit or debit card transaction.

fraudReasonCodestring, [ 1 .. 16 ] charactersrequired

Visa and Mastercard reason codes:

FraudReasonCodeFraudReasonDescription
00Lost
01Stolen
02Card not received
03Fraudulent application
04Counterfeit
05Account Takeover
06Cardholder not present
07Imprinting of multiple sale drafts
08Other
900Lost
901Stolen
902Card not received
903Fraudulent application
904Counterfeit
905Account Takeover
906Cardholder not present
907Imprinting of multiple sale drafts
908Other
908Other
919Other
AIncorrect Processing
BAccount or Credentials Takeover Fraud
valueobjectrequired

An object that contains information about the value of the assessment.

TC40/SAFE fraud information provided to the FraudSight service. This could be from any Worldpay or 3rd party payment provider.

{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "riskProfile": "https://access.worldpay-bsh.securedataplatform.co.uk/riskprofile/ewogICJ2ZXJzaW9uIiA6IDEsCiAgImtleSIgOiAxLAogICJkYXRhIiA6ICJ5d1NnSzMwYnNGZXVYalR0QUJ0QWdnT3UvK3VhcktrL3c1dCtmSFd4dUFXRmVMZUpuM0MyaEtnYnZlZEdnbGtRY1h4LzltN1pSZGVXZWRBQ1ZvTmxZdFNiZUxaSmFrZXZxenVndFQ2bG44NkpNTW5CeGJSRFVWWWY3dTd5SXVuVFJLK0NYZS9tODRkaHdTUWVnZlYyYTRCb1RaQVNKK0RpcGpmYUxkK1lETlJFclVyZ1c0TGIvOGhvNnFzbFVBU0dSem8zRVRkMEdIUTZXZ1dIT2t1UVBabUF1NXZuVFdBeGZrSEQ5SkdrT1BoV1pMMmIyZm9yNWNOMzZvWUhOY2dkT0lKdkhNMEg5TG1oRDM1RXA4T3R2WWptVmNXS25FZmtLZ0RrK09KRDNLb2pobG",
  "source": "TC40",
  "sourceDate": "2020-12-27T00:00:00Z",
  "acquirerReference": "02691780344910023278387",
  "fraudReasonCode": "5",
  "value": {
    "currency": "GBP",
    "amount": 250
  }
}

Responses

Successful update with fraud information

Bodyapplication/vnd.worldpay.fraudsight-v1.hal+json
Response

Provide details of a payment that resulted in fraud

{}