Update Payment

Provide details of the payment outcome

Methods

POST

Provide details of the payment outcome

Request

Copied!
{
 "type": "object",
 "required": [
  "transactionReference",
  "merchant",
  "riskProfile",
  "paymentOutcome"
 ],
 "properties": {
  "transactionReference": {
   "type": "string",
   "minLength": 1,
   "maxLength": 64,
   "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$"
  },
  "merchant": {
   "type": "object",
   "required": [
    "entity"
   ],
   "properties": {
    "entity": {
     "type": "string",
     "minLength": 1,
     "maxLength": 64,
     "pattern": "^[A-Za-z0-9 ]*$"
    }
   }
  },
  "riskProfile": {
   "type": "string",
   "minLength": 39,
   "maxLength": 2048,
   "format": "uri"
  },
  "paymentOutcome": {
   "type": "string",
   "enum": [
    "authorized",
    "refused"
   ]
  },
  "cvcResult": {
   "type": "string",
   "enum": [
    "matched",
    "not_matched",
    "not_checked",
    "not_supplied"
   ]
  },
  "avsResult": {
   "type": "object",
   "properties": {
    "address": {
     "type": "string",
     "enum": [
      "matched",
      "not_matched",
      "not_checked",
      "not_supplied"
     ]
    },
    "postcode": {
     "type": "string",
     "enum": [
      "matched",
      "not_matched",
      "not_checked",
      "not_supplied"
     ]
    }
   },
   "required": []
  },
  "authentication": {
   "type": "object",
   "properties": {
    "version": {
     "type": "string",
     "minLength": 5,
     "maxLength": 10,
     "pattern": "^([0-9]{1,3})(\\.)([0-9]){1,3}(\\.)([0-9]{1,3})*$"
    },
    "eci": {
     "type": "string",
     "minLength": 2,
     "maxLength": 2,
     "enum": [
      "00",
      "01",
      "02",
      "05",
      "06",
      "07"
     ]
    }
   },
   "required": []
  }
 }
}

Responses

Examples

POST
 Payment outcome details are provided to the fraudsight service
View

Link relationship

post
 Payment outcome details are provided to the fraudsight service 
POSThttps://try.access.worldpay.com/fraudsight/update/payment
Copied!
{
  "Authorization": "Basic dXNlcjE6cGFzc3dvcmQ=",
  "Content-Type": "application/vnd.worldpay.fraudsight-v1.hal+json"
}
Copied!
{
  "transactionReference": "unique-transactionReference",
  "merchant": {
    "entity": "default"
  },
  "riskProfile": "https://try.access.worldpay.com/riskprofile/ewogICJ2IiA6IDEsCiAgImsiIDogMSwKICAiZCIgOiAieWdmQjlEdkZPSGd5OFZGRktwK05pZDhnUW9VelVySmNrRDMzRFhvTXA0bEhPOTZJK0t6aUUyR1ZvTjFSazNtUEhGVFJ3d0NwT0dITThOVnluMDNyTGtwbUVSVExWM1RLbC9td2RoOVZzWFNpbG9zVktUUkRrNVMwRllSeU5hMXZOYjFYWW1TSGgyRTc4SGdWaGwzV2FnWHNjUVQwYlFMdmc1UXN5VUF5Mk9yckRGWlJabzRMVlZ2eXBsU1U3ZjVYMXdFdjBoV3FHVXhYV3dpTitRYWZmMXlGZ0laN2Nkb0pIMG5EanNCZmdDcDd5MjM4U0ZNR2I2SDBTVUx0eE9vY3JBODk0N1JUaGU2NGlPNURONDNKS3c9PSIKfQ",
  "paymentOutcome": "authorized",
  "cvcResult": "matched",
  "avsResult": {
    "address": "matched",
    "postcode": "matched"
  },
  "authentication": {
    "version": "2.1.0",
    "eci": "05"
  }
}

204

Copied!
{
  "Content-Type": "application/vnd.worldpay.fraudsight-v1.hal+json"
}
Copied!
{}