- Home
- All APIs
- Access Worldpay
- Payments API
- Versioning and Change log
Versioning and Change log
This log details any breaking and non-breaking API changes we have released for our Payments service.
Prerequisite: Make yourself familiar with our
Versioning log
Note: Version 4 is the first major version used by merchants.
Breaking changes
Version 6 introduces reasons for entering into a repeat payment agreement.
- header change to "Content-Type: application/vnd.worldpay.payments-v6+json"
- new mandatory field
intent
for allrecurring resources - removed
code
andtype
fromerror messages
Breaking changes
Version 5 supports
- header change to "Content-Type: application/vnd.worldpay.payments-v5+json"
- new mandatory field
type
- new mandatory field
version
xid
totransactionId
Breaking changes
- Header change to "Content-Type: application/vnd.worldpay.payments-v0.4+json"
- New mandatory field
entityReference
Note: You can find documentation for all versions
Change log (Non-breaking changes)
You can now receive a rawCode
in all refusal responses. See
You now receive a paymentInstrument
object in authorized responses to yourcard/plain
, card/token
, and card/checkout
.
You can now use our card/networkToken
paymentInstrument with our
You can now use our card/networkToken+applepay
paymentInstrument with our
You can now submit a new intent
value of subscription
in your
The$._links.payments:partialRefund.href
.
We have added a new set of Mastercard refusalAdvice
You can now supply payment facilitator subMerchant email and telephone number in your
The payment facilitator state
field in the
You now have an option to specify a payment channel as moto
to accept Mail Order Telephone Order (MOTO) payments with our
You can now submit your riskProfile
to our
Use it to apply the
You can now use our card/networkToken
paymentInstrument in our
You can now submit the scheme reference
in your
This request parameter allows you to take a repeat payment with our APIs, linking to an agreement established with a different PSP.
You now receive an exemption result and reason in yourriskProfile
in your request.
You now receive an exemption result and reason in yourriskProfile
in your request.
You now receive a verificationFailed
result in your
The paymentInstrument.cardHolderName
field is no longer mandatory in v6 payment requests.
You can now submit your riskProfile
to our
You can now usepayments:migrateRecurringAuthorize
endpoint to make a payment.
You can now usepayments:migrateCardOnFileAuthorize
endpoint to make a payment.
You can optionally supply billingAddress
details in the paymentInstrument
for
We now return AVS results in riskFactors
for our
This request parameter allows you to take a repeat payment with our APIs, linking to an agreement established with a different PSP.
- you can now submit the scheme
reference
in the requests for ourmigrateRecurringAuthorize ,migrateCardOnFileAuthorize andmigrateCardOnFileSale endpoints
- we are now returning a
payments:cancel
action link in the response for thepartialSettle
request
We have extended our
- you can now submit "+" in the
transactionReference
field
This change caters for the new mandate (July 2020) to allow merchants with MCC 7995, 7800, 7801, 7802 and 9406 to submit CVC in card on file requests.
- You can now submit the card/checkout
paymentInstrument
which allows you to submit CVC alongside a token for thepayments:cardonFileAuthorize ,payments:migrateCardOnFileSale andpayments:migrateCardOnFileAuthorize endpoints
the response for our wallet payment requests (Apple Pay/ Google Pay) now includes thepaymentInstrument
payments:reversal
action links now returned forrecurring andcard on file sale resources
- You can now submit
intent
for allcard on file resources
- We are returning
riskFactors
in our refused responses
- You can now submit
cvc
for requests using tokens
which flags payments with purpose of repaying debtdebtRepayment
indicator
- Subsequent authorization action links now included in successful
card on file and recurring payment responses
New links are:
- From
500
-serviceUnavailable
to400
-expiredCard
The following characters are now allowed:
- _/!@#$%()*=-.:;?[]-{}&~`
- 0123456789
- ABCDEFGHIJKLMNOPQRSTUVWXYZ
- abcdefghijklmnopqrstuvwxyz