- Home
- All APIs
- Access Worldpay
- API reference
- FraudSight
- Assessment
- Update Chargeback
Update Chargeback
Provide details of a payment that resulted in a chargeback
Methods
POST
Provide details of a payment that resulted in a chargeback
Request
Copied!
{
"type": "object",
"required": [
"transactionReference",
"merchant",
"riskProfile",
"sourceDate",
"acquirerReference",
"chargebackReasonCode",
"chargebackCaseReference",
"chargebackValue"
],
"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"
},
"sourceDate": {
"type": "string",
"maxLength": 20,
"format": "date-time"
},
"acquirerReference": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"chargebackReasonCode": {
"type": "string",
"minLength": 2,
"maxLength": 4
},
"chargebackCaseReference": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"chargebackValue": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"minimum": 0,
"maximum": 999999999
},
"currency": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
}
},
"required": [
"amount",
"currency"
]
}
}
}
{ "type": "object", "required": [ "transactionReference", "merchant", "riskProfile", "sourceDate", "acquirerReference", "chargebackReasonCode", "chargebackCaseReference", "chargebackValue" ], "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" }, "sourceDate": { "type": "string", "maxLength": 20, "format": "date-time" }, "acquirerReference": { "type": "string", "minLength": 1, "maxLength": 128 }, "chargebackReasonCode": { "type": "string", "minLength": 2, "maxLength": 4 }, "chargebackCaseReference": { "type": "string", "minLength": 1, "maxLength": 64 }, "chargebackValue": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 0, "maximum": 999999999 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[A-Z]{3}$" } }, "required": [ "amount", "currency" ] } } }
Responses
Response schema
Copied!
{
"type": "object",
"properties": {},
"required": []
}
{ "type": "object", "properties": {}, "required": [] }
Examples
Link relationship
fraudsight:updateChargeback
Provide details of a payment that resulted in a chargeback
Provide details of a payment that resulted in a chargeback
POSThttps://try.access.worldpay.com/fraudsight/update/chargeback
Copied!
{
"Authorization": "Basic dXNlcjE6cGFzc3dvcmQ=",
"Content-Type": "application/vnd.worldpay.fraudsight-v1.hal+json"
}
{ "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",
"sourceDate": "2022-01-27T00:00:00Z",
"acquirerReference": "02691780344910023278387",
"chargebackReasonCode": "31",
"chargebackCaseReference": "123456",
"chargebackValue": {
"currency": "GBP",
"amount": 250
}
}
{ "transactionReference": "unique-transactionReference", "merchant": { "entity": "default" }, "riskProfile": "https://try.access.worldpay.com/riskprofile/ewogICJ2IiA6IDEsCiAgImsiIDogMSwKICAiZCIgOiAieWdmQjlEdkZPSGd5OFZGRktwK05pZDhnUW9VelVySmNrRDMzRFhvTXA0bEhPOTZJK0t6aUUyR1ZvTjFSazNtUEhGVFJ3d0NwT0dITThOVnluMDNyTGtwbUVSVExWM1RLbC9td2RoOVZzWFNpbG9zVktUUkRrNVMwRllSeU5hMXZOYjFYWW1TSGgyRTc4SGdWaGwzV2FnWHNjUVQwYlFMdmc1UXN5VUF5Mk9yckRGWlJabzRMVlZ2eXBsU1U3ZjVYMXdFdjBoV3FHVXhYV3dpTitRYWZmMXlGZ0laN2Nkb0pIMG5EanNCZmdDcDd5MjM4U0ZNR2I2SDBTVUx0eE9vY3JBODk0N1JUaGU2NGlPNURONDNKS3c9PSIKfQ", "sourceDate": "2022-01-27T00:00:00Z", "acquirerReference": "02691780344910023278387", "chargebackReasonCode": "31", "chargebackCaseReference": "123456", "chargebackValue": { "currency": "GBP", "amount": 250 } }
204
Copied!
{
"Content-Type": "application/vnd.worldpay.fraudsight-v1.hal+json"
}
{ "Content-Type": "application/vnd.worldpay.fraudsight-v1.hal+json" }
Copied!
{}
{}