This log details any breaking and non-breaking API changes we have released for our Payments service.
Make yourself familiar with our API principles to ensure a resilient integration.
New breaking versions of the API are listed here.
Initial release
Use the value 2024-06-01 in the header parameter WP-Api-Version. See API Reference for details
New features that are 'non-breaking' are listed below. For a robust integration please see our API principles.
More details
SCA exemptions in authentication
You can now set aninstruction.exemption.capabilityvalue ofauthenticationOnlyorauthorizationAndAuthenticationto allow exemptions in authentication (3DS) to be returned. See details3DS support for encrypted Google Pay payments
You can now useinstruction.threeDSwith encrypted Google Pay payments.PAN_ONLY(non Android device tokens) payments can now automatically be prompted for 3DS authentication. See detailsPayment facilitator sub-merchant URL
You can now send amerchant.paymentFacilitator.subMerchant.urlkey:value in your payment request. This allows you to be compliant with scheme requirements.Additional 3DS outcome details in response
We now include additional details on3dsUnavailableoutcome in the response. This includeseciandversion. See the full response body.Customer's ipAddress is now used in authorization
We now use theinstruction.customer.ipAddresskey:value in the authorization process for Customer Initiated Transactions. Previously the value was only used for 3DS authentication.
More details
We can now auto-apply an authenticationOutage exemption in authorization when we receive an authenticationOutage outcome from 3DS due to downstream issues (Visa/Mastercard etc).
This is currently not enabled by default, speak to your Implementation Manager to be set up for authenticationOutage responses.
More details
Account updater support
You can now request real-time account updates (Visa cards only) when using a previously stored card usinginstruction.requestAccountUpdater. If the supplied card has been updated, we will return updated card details in theupdatedPaymentInstrumentobject in the authorization response.sequencesupport in partial settle request
You can now provide thesequence.numberandsequence.totalkey:values in the partial settle request. This represents the sequence number and total number of expected partial settlement requests for the payment.Relaxed email field validation to accept
"+"character
You can now provide email address values containing the"+"character in front of the"@"(e.g.paymentsAPI+test@worldpay.com).
More details
Co-branded card support
You can now submit apreferredCardBrandvalue allowing the transaction to be processed through either of its payment networks.Cartes Bancaires support
You can now submit a payment request using a Cartes Bancaires card brand.Additional 3DS outcome details in response
We now include additional details from the 3DS authentication in the response. This includeseci,version,statusanddsTransactionId. See the full response body.Sender date of birth for funds transfers (AFTs)
You can now send the date of birth of the sender in your funds transfer (AFT) requests. This is required for some cross border funding transactions.Relax validation to support
motopayments with a Checkout SDK session
You can now send a"channel": "moto"payment request along with apaymentInstrument.typeofcheckout.Revenue boost indicator added to response
updatedPaymentInstrument.appliedNetworkTokenis set totruewhen a network token is automatically applied
More details
You can now send a fundsTransfer object in your payment requests. This unlocks the ability to process AFTs compliant with card scheme requirements. AFTs are used to transfer funds from a card account to another destination, rather than for the provision of goods or services.
More details
You can now submit a Customer Initiated Transaction (CIT) using a Network Token provisioned by Worldpay without providing a cryptogram.
More details
You can now request SCA exemptions in authorization from Worldpay and have them automatically applied in the payment.
More details
You can now process Mail Order/Telephone Order payments by submitting "channel": "moto" key:value.
More details
You can now facilitate transactions on behalf of your sub-merchants using the merchant.paymentFacilitator object.
More details
You can now set settlement.cancelOn.cvcNotMatched or settlement.cancelOn.avsNotMatched to disabled in auto settlement flow to prevent payment outcome of sentForCancellation.
2024
More details
You can now submit a paymentInstrument.type of networkToken in a stored card flow. You must provide the paymentInstrument.cryptogram value as part of the request.
More details
You can now setup installment plans by submitting a customerAgreement.type of installment. A typical use case would be, to spread the cost of a larger payment over time.
Additionally, this unlocks installment payments in Latin America.
You can now setup also unscheduled MIT agreements by submitting a customerAgreement.type of unscheduled. A typical use case for this, might be an automatic top-up when the account value falls below a threshold.
More details
We have documented code samples showing you how to integrate 3DS within a Payments API flow, in a React Native application.
More details
You can now set up a subscription payment and make subsequent recurring payments. This includes a subscription agreement with no initial value (e.g. free trial).
More details
You can now store a card for future Customer Initiated Transactions (CITs) without an initial payment. You can use this for adding a card to an ecommerce account.
More details
You can specify threeDS.deviceData.channel as browser to indicate the integration for web or native for iOS/Android. We strongly recommend you provide this to keep authentication rates as high as possible.
More details
You can now provide, debtRepayment, consumerBillPayment and recipient information in your payment request