Skip to content

Update this token

Request

Updating different fields represented by the token

Security
BasicAuth
Path
tokenIdstringrequired

Access Worldpay encrypted token.

Bodyapplication/vnd.worldpay.tokens-v2.hal+json
schemeTransactionReferencestring, [ 1 .. 56 ] characters^[a-zA-Z0-9 ]*$

A value provided by Visa or Mastercard which tracks recurring transactions.

Note: You are not normally expected to provide a value for schemeTransactionReference. If you are using the Verified Tokens API to create tokens, it is automatically included where applicable.

cardHolderNamestring, [ 1 .. 255 ] characters

The name on the customer's card.

descriptionstring, [ 1 .. 255 ] characters^[^&<]*$

A description of your token. If not supplied, a default description is created for you.

monthinteger, [ 1 .. 12 ]
yearinteger, <= 9999
address1string
address2string
address3string
postalCodestring
citystring
statestring
countryCodestring, = 2 characters^[A-Z]*$

Update a billing address.

{ "address1": "1 Test Street", "address2": "Address line 2", "address3": "Address line 3", "postalCode": "TE12 34ST", "city": "Testville", "state": "Testshire", "countryCode": "TS" }

Responses

The token was successfully updated.