Conflicts
Request data that conflicted with an existing token
PUT
Update the existing token with all conflicting data
Responses
Examples
GET
Get the existing token along with the conflicting data
Responses
Response schema
Copied!
{
"type": "object",
"properties": {
"tokenPaymentInstrument": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"tokenId": {
"type": "string",
"minLength": 15,
"maxLength": 21,
"pattern": "^[0-9A-HJ-NP-Z]+$"
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[^&<]*$"
},
"tokenExpiryDateTime": {
"type": "string",
"format": "date-time"
},
"namespace": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"paymentInstrument": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"cardNumber": {
"type": "string",
"minLength": 10,
"maxLength": 19,
"pattern": "^[0-9\\*]*$"
},
"cardHolderName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"cardExpiryDate": {
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"year": {
"type": "integer",
"maximum": 9999
}
},
"required": [
"month",
"year"
]
},
"billingAddress": {
"type": "object",
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"countryCode": {
"type": "string",
"pattern": "^[A-Z]*$",
"minLength": 2,
"maxLength": 2
}
},
"required": [
"address1",
"postalCode",
"city",
"countryCode"
]
}
},
"required": [
"cardNumber",
"cardHolderName",
"cardExpiryDate"
]
},
"schemeTransactionReference": {
"type": "string",
"minLength": 1,
"maxLength": 56,
"pattern": "^[a-zA-Z0-9 ]*$"
},
"conflicts": {
"type": "object",
"properties": {
"paymentInstrument": {
"type": "object",
"properties": {
"cardHolderName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"cardExpiryDate": {
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"year": {
"type": "integer",
"maximum": 9999
}
},
"required": [
"month",
"year"
]
},
"billingAddress": {
"type": "object",
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"countryCode": {
"type": "string",
"pattern": "^[A-Z]*$",
"minLength": 2,
"maxLength": 2
}
}
}
},
"anyOf": [
{
"required": [
"cardHolderName"
]
},
{
"required": [
"cardExpiryDate"
]
},
{
"required": [
"billingAddress"
]
}
]
},
"schemeTransactionReference": {
"type": "string",
"minLength": 1,
"maxLength": 56,
"pattern": "^[a-zA-Z0-9 ]*$"
}
},
"anyOf": [
{
"required": [
"paymentInstrument"
]
},
{
"required": [
"schemeTransactionReference"
]
}
]
},
"_links": {
"type": "object",
"format": "hal+json"
}
},
"required": [
"tokenPaymentInstrument",
"tokenId",
"description",
"tokenExpiryDateTime",
"paymentInstrument",
"conflicts",
"_links"
]
}
{ "type": "object", "properties": { "tokenPaymentInstrument": { "type": "object", "properties": { "type": { "type": "string" }, "href": { "type": "string" } } }, "tokenId": { "type": "string", "minLength": 15, "maxLength": 21, "pattern": "^[0-9A-HJ-NP-Z]+$" }, "description": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^&<]*$" }, "tokenExpiryDateTime": { "type": "string", "format": "date-time" }, "namespace": { "type": "string", "minLength": 1, "maxLength": 64 }, "paymentInstrument": { "type": "object", "properties": { "type": { "type": "string" }, "cardNumber": { "type": "string", "minLength": 10, "maxLength": 19, "pattern": "^[0-9\\*]*$" }, "cardHolderName": { "type": "string", "minLength": 1, "maxLength": 255 }, "cardExpiryDate": { "type": "object", "properties": { "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "year": { "type": "integer", "maximum": 9999 } }, "required": [ "month", "year" ] }, "billingAddress": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "countryCode": { "type": "string", "pattern": "^[A-Z]*$", "minLength": 2, "maxLength": 2 } }, "required": [ "address1", "postalCode", "city", "countryCode" ] } }, "required": [ "cardNumber", "cardHolderName", "cardExpiryDate" ] }, "schemeTransactionReference": { "type": "string", "minLength": 1, "maxLength": 56, "pattern": "^[a-zA-Z0-9 ]*$" }, "conflicts": { "type": "object", "properties": { "paymentInstrument": { "type": "object", "properties": { "cardHolderName": { "type": "string", "minLength": 1, "maxLength": 255 }, "cardExpiryDate": { "type": "object", "properties": { "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "year": { "type": "integer", "maximum": 9999 } }, "required": [ "month", "year" ] }, "billingAddress": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "countryCode": { "type": "string", "pattern": "^[A-Z]*$", "minLength": 2, "maxLength": 2 } } } }, "anyOf": [ { "required": [ "cardHolderName" ] }, { "required": [ "cardExpiryDate" ] }, { "required": [ "billingAddress" ] } ] }, "schemeTransactionReference": { "type": "string", "minLength": 1, "maxLength": 56, "pattern": "^[a-zA-Z0-9 ]*$" } }, "anyOf": [ { "required": [ "paymentInstrument" ] }, { "required": [ "schemeTransactionReference" ] } ] }, "_links": { "type": "object", "format": "hal+json" } }, "required": [ "tokenPaymentInstrument", "tokenId", "description", "tokenExpiryDateTime", "paymentInstrument", "conflicts", "_links" ] }
Examples
Update a token with data which conflicted for the original token creation request.
PUThttps://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiajlLeUdhOUp6SExsd3JYN2RmdmFMMHYxWXU1dW1KNC9wb2VDUEtEcktpWTlCNmNjUis1cCtHWjhidEFWbGJoWUJBcldacGlmdGgweXhBbHpTK1M4S3JrTDRCRGs4TFFWMTVYQnY3NzlmTWxreTQ0dTZRYmh0SmlFZTBoY3UyYk5kS1NOSTBNOERWZkxkUGpTLyt0dGhnPT0ifQ
Copied!
{
"Accept": "application/vnd.worldpay.tokens-v3.hal+json"
}
{ "Accept": "application/vnd.worldpay.tokens-v3.hal+json" }
204
Copied!
{
"Content-Type": "application/vnd.worldpay.tokens-v3.hal+json"
}
{ "Content-Type": "application/vnd.worldpay.tokens-v3.hal+json" }