Skip to content
APIs/FraudSight/Update

Provide details of the payment outcome

Request

Provide payment outcome information.

Note: This should only be provided if using a different gateway for the payment.

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.

paymentOutcomestringrequired

Outcome of the payment authorization.

Enum:"authorized""refused"
refusalCodestring, [ 1 .. 2048 ] characters

The refusal response code from the acquirer.

Example:"5"
refusalDescriptionstring, [ 1 .. 2048 ] characters

The description of the 'refusalCode'.

Example:"REFUSED"
cvcResultstring

Outcome of the CVC check.

Enum:"matched""not_matched""not_checked""not_supplied"
avsResultobject

Object containing outcome of the address verification service check.

authenticationobject

Include this object if 3DS authentication details were part of the payment.

Authorized payment outcome details are 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",
  "paymentOutcome": "authorized",
  "cvcResult": "matched",
  "avsResult": {
    "address": "matched",
    "postcode": "matched"
  },
  "authentication": {
    "version": "2.1.0",
    "eci": "05"
  }
}

Responses

Successful update with payment information

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

Payment outcome details are provided to the fraudsight service

{}