Last Updated: 17 December 2024 | Change Log

Payment update

POST your request to the fraudsight:payment action link.

Payment update example request

POST https://try.access.worldpay.com/fraudsight/update/payment

Payment update request body:

application/vnd.worldpay.fraudsight-v1.hal+json

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.com/riskprofile/ewogICJ2ZXJzaW9uIiA6IDEsCiAgImtleSIgOiAxLAogICJkYXRhIiA6ICJ5d1NnSzMwYnNGZXVYalR0QUJ0QWdnT3UvK3VhcktrL3c1dCtmSFd4dUFXRmVMZUpuM0MyaEtnYnZlZEdnbGtRY1h4LzltN1pSZGVXZWRBQ1ZvTmxZdFNiZUxaSmFrZXZxenVndFQ2bG44NkpNTW5CeGJSRFVWWWY3dTd5SXVuVFJLK0NYZS9tODRkaHdTUWVnZlYyYTRCb1RaQVNKK0RpcGpmYUxkK1lETlJFclVyZ1c0TGIvOGhvNnFzbFVBU0dSem8zRVRkMEdIUTZXZ1dIT2t1UVBabUF1NXZuVFdBeGZrSEQ5SkdrT1BoV1pMMmIyZm9yNWNOMzZvWUhOY2dkT0lKdkhNMEg5TG1oRDM1RXA4T3R2WWptVmNXS25FZmtLZ0RrK09KRDNLb2pobG", "paymentOutcome": "authorized", "cvcResult": "matched", "avsResult": { "address": "matched", "postcode": "matched" }, "authentication": { "version": "2.1.0", "eci": "05" } }

Schema

Full API Reference here

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.

entitystring[ 1 .. 64 ] characters^[A-Za-z0-9 ]*$required

Used to route the request in Access Worldpay, created as part of on-boarding.

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.

addressstring

Outcome of the address check.

Enum"matched""not_matched""not_checked""not_supplied"
postcodestring

Outcome of the postcode check.

Enum"matched""not_matched""not_checked""not_supplied"
authenticationobject

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

versionstring[ 5 .. 10 ] characters^([0-9]{1,3})(\.)([0-9]){1,3}(\.)([0-9]{1,3})...

3DS version used by issuer e.g. 1.0.2, 2.1.0 or 2.2.0.

ecistring= 2 characters

Electronic Commerce Indicator (ECI). Outcome of the 3DS authentication as applied in the payment.

  • 02 or 05 - Fully Authenticated Transaction
  • 01 or 06 - Attempted Authentication Transaction
  • 00 or 07 - Non 3-D Secure Transaction
  • Mastercard - 02, 01, 00
  • Visa - 05, 06, 07
  • Amex - 05, 06, 07
  • JCB - 05, 06, 07
  • Diners - 05, 06, 07
Enum"00""01""02""05""06""07"

Payment update responses

Best Practice

Access Worldpay returns a WP-CorrelationId in the headers of service responses. We highly recommend you log this. The WP-CorrelationId is used by us to examine individual service requests.

The response status is 200 OK.