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 API Principles to ensure a resilient integration.

Versioning log

Note

Version 4 is the first major version used by merchants.

Version 7 (02/20/2024)

New endpoints

We have created a migration guide which consolidates the changes for an easier upgrade from version 6 to version 7.


Version 6 (11/14/2019)

Reasons for entering into a repeat payment agreement
  • header change to "Content-Type: application/vnd.worldpay.payments-v6+json"
  • new mandatory field intent for all recurring resources
  • removed code and type from error messages

Version 5 (08/14/2019)

3DS2 support
  • header change to "Content-Type: application/vnd.worldpay.payments-v5+json"
  • new mandatory field type
  • new mandatory field version
  • xid to transactionId

Version 4 (02/05/2019)

New mandatory field
  • Header change to "Content-Type: application/vnd.worldpay.payments-v0.4+json"
  • New mandatory field entityReference

Change log (Non-breaking changes)

Merchant Initiated Transactions (04/30/2024)

More details

We have now added support for Merchant Initiated Transactions (MIT) to Card Payments Version 7.


Funds transfers (04/30/2024)

More details

You can now submit funds transfers (otherwise known as Account Funding Transactions or AFTs) using the instruction.fundsTransfer object in your authorization request. Non-purchase money movements from a Visa or Mastercard to another account should typically use this.


Latin America Installments (04/04/2024)

More details

You can now submit Latin America installment payments using the instruction.customerAgreement object in your authorization request. This allows your customers to opt to pay the full value in installments.


Latin America Document Reference (04/04/2024)

More details

You can now submit the customer.documentReference in your authorization request. This is used in some Latin America regions to verify the identity of the cardholder using a tax or document reference. It is strongly recommended to include this for Brazil domestic processing.


Recipient fields (MCC 6012) (04/04/2024)

More details

You can now submit the recipient object in your authorization request. If you are using MCC 6012 in Europe, you should include data about the recipient of financial services within this object.


Consumer Bill Payment flag (04/04/2024)

More details

You can now submit a consumerBillPayment flag in your authorization request. If you are registered with Visa as a Consumer of the Bill Payment Service (CBPS), you must set this to true for any payments associated with the CBPS.


3DS support for Cartes Bancaires (01/10/2024)

More details

We now provide additional values in the authentication and 3DS verification responses when the card brand is Cartes Bancaires. These additional values must then be applied in the authorization request.


Raw code in refused responses (11/28/2023)

More details

You can now receive a rawCode in all refusal responses. See raw response codes for more information.


Payment instrument returned for cards and tokens (11/06/2023)

More details

You now receive a paymentInstrument object in authorized responses to your authorization request, and Sent for Settlement responses to your sale request for card/plain, card/token, and card/checkout.


Card network token support for authorization and migrate card on file authorization endpoint (v6) (11/06/2023)

More details

You can now use our card/networkToken paymentInstrument with our one time authorization and migrateCardOnFileAuthorize endpoints.


Apple Pay decrypted support for authorization endpoint (v6) (11/06/2023)

More details

You can now use our card/networkToken+applepay paymentInstrument with our one time authorization endpoint.


New intent for card on file endpoints (07/06/2023)

More details

You can now submit a new intent value of subscription in your card on file request.


More details

The response of a partial refund request returns a link to allow you to perform another partial refund. The json path to the link in the response is $._links.payments:partialRefund.href.


New Masterard test values (04/20/2023)

More details

We have added a new set of Mastercard refusalAdvice magic values. This enables to you to test the different refusal outcomes in your Payment response.


New Payment Facilitator fields (03/14/2023)

More details

You can now supply payment facilitator subMerchant email and telephone number in your authorization request.


Payment Facilitator field state validation change (03/14/2023)

More details

The payment facilitator state field in the authorization request now supports 1-3 alphanumeric characters.


2022

MOTO payments (v6) (11/29/2022)

More details

You now have an option to specify a payment channel as moto to accept Mail Order Telephone Order (MOTO) payments with our authorize, migrateCardOnFileAuthorize and migrateCardOnFileSale endpoints.


riskProfile in card on file (with verification) payment requests (v6) (07/04/2022)

More details

You can now submit your riskProfile to our card on file (with verification) endpoint in your payment requests. You then receive an exemption result and reason in the response.

Use it to apply the SCA exemption in the payment request and update the FraudSight data model to benefit future payments.



2021

Card network token for card on file sale endpoint (v6) (11/09/2021)

More details

You can now use our card/networkToken paymentInstrument in our `payments:migrateCardOnFileSale endpoint.


Optional scheme reference parameter for token requests (v6) (09/10/2021)

More details

You can now submit the scheme reference in your migrateCardOnFile token and migrateCardOnFileSale token requests.

This request parameter allows you to take a repeat payment with our APIs, linking to an agreement established with a different PSP.


Additional exemption result for card on file payments (v6) (06/18/2021)

More details

You now receive an exemption result and reason in your card on file sale and card on file authorization response if you have provided a riskProfile in your request.


Additional exemption result for one off payments(v6) (05/25/2021)

More details

You now receive an exemption result and reason in your authorization response if you have provided a riskProfile in your request.


Additional risk factor result (v6) (04/09/2021)

More details

You now receive a verificationFailed result in your authorization response if the issuer identifies a conflict.


Cardholder name is now an optional field (v6) (03/09/2021)

More details

The paymentInstrument.cardHolderName field is no longer mandatory in v6 payment requests.


riskProfile in payment requests (v6) (01/21/2021)

More details

You can now submit your riskProfile to our migrate card on file (without verification) and one time endpoints in your payment requests. Use it to apply the SCA exemption in the payment request and update the FraudSight data model to benefit future payments.



2020

Apple Pay decrypted for recurring (v6) (11/27/2020)

More details

You can now use Apple Pay decrypted in our payments:migrateRecurringAuthorize endpoint to make a payment.


Apple Pay decrypted for card on file (v6) (11/17/2020)

More details

You can now use Apple Pay decrypted in our payments:migrateCardOnFileAuthorize endpoint to make a payment.


Additional element for Mobile Wallet requests (v6) (10/06/2020)

More details

You can optionally supply billingAddress details in the paymentInstrument for Mobile Wallet payment requests.


Additional element for Mobile Wallet responses (v6) (09/22/2020)

More details

We now return AVS results in riskFactors for our Mobile Wallet payment responses.


New optional request parameter for repeat payments (v6) (05/28/2020)

More details

This request parameter allows you to take a repeat payment with our APIs, linking to an agreement established with a different PSP.


More details

Additional allowed character for transactionReference (v6) (05/05/2020)

More details

We have extended our formatting rules.

  • you can now submit "+" in the transactionReference field

New paymentInstrument for card on file payments (v5 + v6) (04/24/2020)

More details

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.


Additional fields in wallet response (v6) (04/16/2020)

More details
  • the response for our wallet payment requests (Apple Pay/ Google Pay) now includes the paymentInstrument

More details

New optional field (v6) (02/11/2020)

More details

Additional fields in response (v6) (02/04/2020)

More details
  • We are returning riskFactors in our refused responses

CVC for token requests (v6) (01/28/2020)

More details
  • You can now submit cvc for requests using tokens

New optional field (v6) (01/16/2020)

More details

More details


2019

Extended error description for card expiry (v5) (11/13/2019)

More details
  • From
    500 - serviceUnavailable
    to
    400 - expiredCard

Formatting update for transactionReference (v5) (10/15/2019)

More details

The following characters are now allowed:

  • _/!@#$%()*=-.:;?[]-{}&~`
  • 0123456789
  • ABCDEFGHIJKLMNOPQRSTUVWXYZ
  • abcdefghijklmnopqrstuvwxyz