- Home
- All APIs
- Access Worldpay
- Hosted Payment Pages
- Non-breaking change definition
Non-breaking change definition
To ensure resilience when integrating into our Hosted Payment Pages API, you must consider that we might make the following changes without moving to another version:
In Responses:
Elements within the response body can be sent in any order.
Example:
{
"apple": "gala",
"pear": "conference"
}
{ "apple": "gala", "pear": "conference" }
or
{
"pear": "conference",
"apple": "gala"
}
{ "pear": "conference", "apple": "gala" }
A new element is now included in your response.
Example:
Before
{
"apple": "gala",
"pear": "conference"
}
{ "apple": "gala", "pear": "conference" }
After
{
"apple": "gala",
"pear": "conference",
"melon": "honeydew"
}
{ "apple": "gala", "pear": "conference", "melon": "honeydew" }
Additional action links and URI resources are now returned within your response.
Example:
Before
{
"_links": {
"service:action1": {
"href": "https://access.worldpay.com/service/action1"
},
"service:action2": {
"href": "https://access.worldpay.com/service/action2"
}
}
}
{ "_links": { "service:action1": { "href": "https://access.worldpay.com/service/action1" }, "service:action2": { "href": "https://access.worldpay.com/service/action2" } } }
After
{
"_links": {
"service:action1": {
"href": "https://access.worldpay.com/service/action1"
},
"service:action2": {
"href": "https://access.worldpay.com/service/action2"
},
"service:action3": {
"href": "https://access.worldpay.com/service/action3"
}
}
}
{ "_links": { "service:action1": { "href": "https://access.worldpay.com/service/action1" }, "service:action2": { "href": "https://access.worldpay.com/service/action2" }, "service:action3": { "href": "https://access.worldpay.com/service/action3" } } }
Additional
Additional
A new HTTP header is now added to our response.
In Requests
Important: Sending any elements not recorded in our documentation will return an error.
Elements within the request body can be sent in any order.
Example:
{
"apple": "gala",
"pear": "conference"
}
{ "apple": "gala", "pear": "conference" }
or
{
"pear": "conference",
"apple": "gala"
}
{ "pear": "conference", "apple": "gala" }
New elements that are not mandatory can now be sent. For example merchant.mcc
in our Payments API or description
in our Tokens API.
Example:
Before
{
"apple": "gala",
"pear": "conference"
}
{ "apple": "gala", "pear": "conference" }
After
{
"apple": "gala",
"pear": "conference",
"melon": "honeydew"
}
{ "apple": "gala", "pear": "conference", "melon": "honeydew" }
The value of an element now allows for an increased number of characters.
Example:
Before
{
"phrase": "the quick brown fox"
}
{ "phrase": "the quick brown fox" }
After
{
"phrase": "the quick brown fox jumps over the lazy dog"
}
{ "phrase": "the quick brown fox jumps over the lazy dog" }
Changes in
Example:
A "time" value which previously allowed only hours and minutes, now also optionally allows seconds.
Before
{
"time": "11:50"
}
{ "time": "11:50" }
After
{
"time": "11:50:59"
}
{ "time": "11:50:59" }
We may expand the range of values we accept. This means requests that previously resulted in a validation error may now succeed.
For example, previously allowed range value was 10-50. New range is 10-100.
Element value options have now increased.
Example:
Previously allowed value options are apple
, pear
and melon
. You could now also submit mango
.
Before
{
"fruit": "apple"
}
{ "fruit": "apple" }
After
{
"fruit": "mango"
}
{ "fruit": "mango" }
Note: For any changes that fall outside the above definition, Worldpay creates a new version. Go to our