Versioning and Change log

This log details any breaking and non-breaking API changes we have released for our Hosted Payment Pages (HPP).

Info

Make yourself familiar with our non-breaking change definition to ensure a resilient integration.

Versioning log

Our HPP API is currently on version 1. We will record any upcoming breaking changes here.

Change log (Non-breaking changes)


Restructured event tokenCreated (08 May 2024)

More details

We have renamed:

  • createdAt to eventTimestamp
  • notificationId to eventId
  • data to eventDetails

From

{
  "eventType": "tokenCreated",
  "notificationId": "ff8b7423-6907-4e54-8063-558d26dfa1ed",
  "eventCount": 1,
  "version": "2.0",
  "createdAt": "2024-01-19T20:40:30.037Z",
  "data": {
    "transactionReference": "3368e96a-58a2-4c79-9065-ab697d386732",
    "tokenCreatedAt": "2024-01-19T20:49:30Z",
    "tokenPaymentInstrument": {
      "type": "card/tokenized",
      "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXckVkRHdJSjFNQzR5VkE5NHhYUldzYz0ifQ"
    },
    "tokenId": "9925760692793807595",
    "description": "Token Description",
    "tokenExpiryDateTime": "2028-01-19T20:49:30Z",
    "namespace": "SHOPPER_ID_1234567890",
    "schemeTransactionReference": "000000000000020005060720116005060",
    "paymentInstrument": {
      "type": "card/masked",
      "cardNumber": "4444********1111",
      "cardHolderName": "Sherlock Holmes",
      "cardExpiryDate": {
        "month": 1,
        "year": 2025
      },
      "bin": "444433",
      "brand": "VISA",
      "fundingType": "credit",
      "countryCode": "US",
      "billingAddress": {
        "address1": "221B Baker Street",
          "address2": "Marylebone",
          "address3": "Westminster",
          "postalCode": "NW1 6XE",
          "city": "London",
          "state": "Greater London",
          "countryCode": "GB"
      }
    }
  }
}

To

{
    "eventType": "tokenCreated",
    "notificationId": "27e63cba-1f98-44d3-946d-afb6aca3d5e5",
    "createdAt": "2024-05-07T18:20:12.111Z",
    "eventTimestamp": "2024-04-23T18:51:28Z",
    "eventId": "124179fe-7490-4128-b4f4-016bc0588b73",
    "eventDetails":
    {
        "transactionReference": "Testing123",
        "tokenCreatedAt": "2024-04-23T18:51:28Z",
        "tokenPaymentInstrument":
        {
            "type": "card/tokenized",
            "href": "https://preprod.access.worldpay.com/tokens/eyJrIjoxLCJkIjoibHdJNmQxN01QQ096Rm9QZzhBMS9TK3lqV21QdjBEUk9ORkRqMnRMeTMvUT0ifQ"
        },
        "tokenId": "9981080858023992994",
        "description": "Created token without payment on 2024-04-23",
        "tokenExpiryDateTime": "2024-04-30T18:51:27Z",
        "paymentInstrument":
        {
            "type": "card/masked",
            "cardNumber": "4622********0875",
            "cardHolderName": "Sherlock Holmes",
            "cardExpiryDate":
            {
                "month": 1,
                "year": 2025
            },
            "bin": "462294",
            "brand": "VISA",
            "fundingType": "credit",
            "countryCode": "GB",
            "billingAddress": {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            }
        }
    }
}

Additional IPs (07 March 2024)

More details

We have added additional IPs for outgoing traffic. You must whitelist all of our IPs on your Web Application Firewall (WAF) to allow webhooks to be received by 8th April 2024. The new IP addresses are:

3.11.50.124
3.11.213.43
3.14.190.43
3.121.172.32
3.125.11.252
3.126.98.120
3.139.153.185
3.139.255.63
13.200.51.10
13.200.56.25
13.232.151.127
34.236.63.10
34.253.172.98
35.170.209.108
35.177.246.6
52.4.68.25
52.51.12.88
108.129.30.203

Token support (02 January 2024)

More details

You can now save your customer's card details for future use by creating a token.


New conditional field in request (15 October 2023)

More details

You can now submit the expiry in a request. This allows you to configure the duration your customer can access the payment link.

An example of when you might use this, is issuing invoices or putting a hold time on an order.