Changelog
The change log describes updates to the Web Services API in chronological order from release 24.1 (version 79). For more information on the gateway API versioning see the Versioning page.
Release 24.9, November 2024
Added
-
cruise.departureDate in the CREATE_OR_UPDATE_RISK_ASSESSMENT request. It contains the cruise departure or sail date that is required when cruise industry data is provided. -
transactionProcessingResponse.stan in the CREATE_OR_UPDATE_RISK_ASSESSMENT request. It contains the System Trace Audit Number (STAN) for the transaction. -
transactionProcessingResponse.rrn in the CREATE_OR_UPDATE_RISK_ASSESSMENT request. It indicates the reference generated by the acquirer for a specific merchant interaction. -
customer.firstName in the CREATE_OR_UPDATE_RISK_ASSESSMENT request. It contains the payer's first name. -
customer.lastName in the CREATE_OR_UPDATE_RISK_ASSESSMENT request. It contains the payer's last name.
Changed
-
authentication.3ds2 in the CREATE_OR_UPDATE_RISK_ASSESSMENT request. It contains the details of the payer authentication using 3-D Secure authentication version 2. -
authentication.3ds2.transactionStatus in the CREATE_OR_UPDATE_RISK_ASSESSMENT request. It contains the result of payer authentication with the issuer. -
authentication.3ds2.statusReasonCode in the CREATE_OR_UPDATE_RISK_ASSESSMENT request. It contains the code indicating the reason for the transaction status returned in authentication.3ds2.transactionStatus. -
authentication.3ds2.protocolVersion in the CREATE_OR_UPDATE_RISK_ASSESSMENT request. It indicates the version of the EMV 3-D Secure protocol used to perform 3-D Secure authentication, in the format specified by EMVCo.
Release 24.8, October 2024
Added
-
interaction.displayControl.paymentMethod.{paymentMethod}.displaySequence, the order in which the payment methods will be listed in Checkout for the merchants on INITIATE_CHECKOUT. -
order.subMerchant.marketplaceId, field and corresponding validations same as AUTHORIZE on INITIATE_AUTHENTICATION request and INITIATE_AUTHENTICATION, AUTHENTICATE_PAYER response. -
order.subMerchant.governmentCountryCode, field and corresponding validations same as AUTHORIZE on INITIATE_AUTHENTICATION request and INITIATE_AUTHENTICATION, AUTHENTICATE_PAYER response.
Changed
-
Added AUTHENTICATION_OUTAGE enumeration value to authentication.psd2.exemption on AUTHORIZE, PAY, UPDATE_SESSION request and RETRIVE_TRANSACTION, RETRIEVE_SESSION, RETRIEVE_ORDER response. The value indicates that the transaction is exempt because the authentication was not possible due to a technical outage.
Release 24.8, October 2024
Added
-
order.statementDescriptor.websiteUrl, statement descriptor block that contains the website URL on AUTHORIZE, PAY, UPDATE_SESSION, STANDALONE CAPTURE, STANDALONE REFUND, AUTENTICATE PAYER request and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION response. -
order.subMerchant.websiteUrl, sub merchant block that contains the website URL on AUTHORIZE, PAY, UPDATE_SESSION, STANDALONE CAPTURE, STANDALONE REFUND, VERIFY, INITIATE AUTHENTICATION request and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION response. -
order.merchantPartnerIdCode, field at order level that contains the merchant partner ID code on AUTHORIZE, PAY, UPDATE_SESSION, CAPTURE, REFUND, VERIFY, INITIATE AUTHENTICATION request and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION response. -
transaction.serviceLocation.city, field at transaction level that contains the service location city name on AUTHORIZE, PAY, UPDATE_SESSION, CAPTURE, REFUND, VERIFY, INITIATE AUTHENTICATION request and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION response. -
transaction.serviceLocation.stateProvinceCode, field at transaction level that contains the service location state province code on AUTHORIZE, PAY, UPDATE_SESSION, CAPTURE, REFUND, VERIFY, INITIATE AUTHENTICATION request and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION response. -
transaction.serviceLocation.country, field at transaction level that contains the service location country on AUTHORIZE, PAY, UPDATE_SESSION, CAPTURE, REFUND, VERIFY, INITIATE AUTHENTICATION request and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION response. -
transaction.serviceLocation.postCodeZip, field at transaction level that contains the service location postcode ZIP on AUTHORIZE, PAY, UPDATE_SESSION, CAPTURE, REFUND, VERIFY, INITIATE AUTHENTICATION request and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION response.
Release 24.7, September 2024
Added or Changed
-
order.statementDescriptor.websiteUrl, the URL of the merchant's descriptor website, on AUTHORIZE, PAY, UPDATE_SESSION, standalone CAPTURE, standalone REFUND, AUTHENTICATE PAYER requests, and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION responses. -
order.subMerchant.websiteUrl, the URL of the sub-merchant's website on AUTHORIZE, PAY, UPDATE_SESSION, standalone CAPTURE, standalone REFUND, VERIFY, INITIATE AUTHENTICATION request, and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION responses. -
order.merchantPartnerIdCode, the code that represents a partnership agreement, between you and the issuer on AUTHORIZE, PAY, UPDATE_SESSION, CAPTURE, REFUND, VERIFY, AUTHENTICATE PAYER requests, and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION responses. -
transaction.serviceLocation, parameter group when transaction service location is different than your registered business location, on AUTHORIZE, PAY, UPDATE_SESSION, CAPTURE, REFUND, VERIFY, INITIATE AUTHENTICATION request and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION responses. -
transaction.serviceLocation.city, the city where the cardholder received the service, on AUTHORIZE, PAY, UPDATE_SESSION, CAPTURE, REFUND, VERIFY, INITIATE AUTHENTICATION requests, and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION responses. -
transaction.serviceLocation.stateProvinceCode, the state or province where the cardholder received the service, AUTHORIZE, PAY, UPDATE_SESSION, CAPTURE, REFUND, VERIFY, INITIATE AUTHENTICATION requests and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION responses. -
transaction.serviceLocation.country, the country where the cardholder received the service, on AUTHORIZE, PAY, UPDATE_SESSION, CAPTURE, REFUND, VERIFY, INITIATE AUTHENTICATION requests and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION responses. -
transaction.serviceLocation.postCodeZip, the zip or postal code where the cardholder received the service, on AUTHORIZE, PAY, UPDATE_SESSION, CAPTURE, REFUND, VERIFY, INITIATE AUTHENTICATION requests and RETRIEVE_TRANSACTION, RETRIEVE_ORDER, RETRIEVE_SESSION responses.
Release 24.6, August 2024
Added
-
interaction.displayControl.paymentMethod.{paymentMethod}.displaySequence, contains the order of the payment methods of the customer, on INITIATE_CHECKOUT.
Changed
-
browserPayment.operation, added ACCOUNTSETUP enumeration value, on INITIATE_BROWSER_PAYMENT request, and RETRIEVE_SESSION, RETRIEVE_TRANSACTION responses. -
transaction[n].browserPayment.operation, added ACCOUNTSETUP enumeration value, on RETRIEVE_ORDER response. -
browserPayment.consent, added a new parameter group, on INITIATE_BROWSER_PAYMENT requests and RETRIEVE_SESSION, RETRIEVE_ORDER, RETRIEVE_TRANSACTION responses. -
browserPayment.consent.storePayerAccount, added a new field, on INITIATE_BROWSER_PAYMENT requests and RETRIEVE_SESSION, RETRIEVE_ORDER, RETRIEVE_TRANSACTION responses. -
sourceOfFunds.browserPayment.type, added ACH_FINICITY value, on INITIATE_BROWSER_PAYMENT, PAYMENT_OPTIONS_INQUIRY requests and RETRIEVE_SESSION, RETRIEVE_ORDER, RETRIEVE_TRANSACTION, PAYMENT_OPTIONS_INQUIRY responses. -
browserPayment.serviceAttributes[n].name, added new PAYER_ID field on INITIATE_BROWSER_PAYMENT, PAYMENT_OPTIONS_INQUIRY requests and RETRIEVE_SESSION, RETRIEVE_ORDER, RETRIEVE_TRANSACTION, PAYMENT_OPTIONS_INQUIRY responses. -
browserPayment.serviceAttributes[n].value, added new field, on INITIATE_BROWSER_PAYMENT, PAYMENT_OPTIONS_INQUIRY requests and RETRIEVE_SESSION, RETRIEVE_ORDER, RETRIEVE_TRANSACTION, PAYMENT_OPTIONS_INQUIRY responses.
Release 24.6, August 2024
Changed
-
authentication.3ds2.authenticationScheme, added new UNIONPAY enumeration value, on AUTHORIZE, PAY, VERIFY, Standalone CAPTURE, UPDATE_SESSION.
Release 24.6, August 2024
Changed
-
subMerchant.authentication[n].3DS2.requestorId and subMerchant.authentication[n].3DS2.requestorName,updated descriptions include UnionPay, on RETRIEVE_ORDER responses.
Release 24.6, August 2024
Changed
-
transaction[n].order.subMerchant.authentication[n].3DS2.requestorId and transaction[n].order.subMerchant.authentication[n].3DS2.requestorName, updated descriptions include UnionPay, on RETRIEVE_ORDER responses. order.subMerchant.authentication[n].3DS2.requestorId and order.subMerchant.authentication[n].3DS2.requestorName, updated descriptions include UnionPay, on RETRIEVE_TRANSACTION responses.
Release 24.6, August 2024
Changed
order.subMerchant.authentication[n].3DS2.requestorId, unique identifier assigned to the merchant by the card scheme directory server when the merchant registered to use 3-D Secure authentication version 2 with their acquirer, on INITIATE_AUTHENTICATION, UPDATE_SESSION requests and INITIATE_AUTHENTICATION, AUTHENTICATE_PAYER, RETRIEVE_SESSION responses.order.subMerchant.authentication[n].3DS2.requestorName, unique name assigned to the merchant by the card scheme directory server when the merchant registered to use 3-D Secure authentication version 2 with their acquirer, on INITIATE_AUTHENTICATION, UPDATE_SESSION requests and INITIATE_AUTHENTICATION, AUTHENTICATE_PAYER, RETRIEVE_SESSION responses.
Release 24.5, July 2024
Changed
-
Modified browserPayment.preferredLanguage field name to browserPayment.locale. browserPayment.locale, maximum length of field updated from 35 to 5 characters on INITIATE_BROWSER_PAYMENT request and RETRIEVE_TRANSACTION response.
Release 24.4, June 2024
Added
-
paymentTypes.card.3DSecureSchemes[n].3DSecureScheme, UP3DS merchant privilege can be successfully turned on or off if API partner has unionPay3ds2 privilege, on PAYMENT_OPTIONS_INQUIRY response.
Release 24.3, May 2024
Changed
-
sourceOfFunds.type, added SCHEME_TOKEN enumeration value, on VERIFY. transaction.transit.knownFare.type, known Fare Transit fields now applicable, on PAY.
Release 24.2, May 2024
Added
sourceOfFunds.provided.card.maskedFpan.sourceOfFunds.type.sourceOfFunds.provided.card.devicePayment.3DSecure.onlinePaymentCryptogram (Version 51 till 71).sourceOfFunds.provided.card.devicePayment.3DSecure.eciIndicator (Version 51 till 71).sourceOfFunds.provided.card.devicePayment.onlinePaymentCryptogram (Version 71 and above).sourceOfFunds.provided.card.devicePayment.eciIndicator (Version 71 and above) on VERIFY.
Verification Operation on the WS API is enhanced to support Scheme Token from Version 51 onwards.
Release 24.1, March 2024
Changed
-
IPv6 address can now be provided and used for all EMV 3DS payer authentication and is mapped to Authentication requests to SI server for all authentication schemes and 2C2P for ITMX. Updated maximum length from 15 to 45 characters. device.ipAddress on AUTHENTICATE_PAYER, UPDATE_SESSION. -
IPv6 address can be provided on WS API requests, echoed back in response, but is not used. Updated maximum length from 15 to 45 characters. IPv6 address can be provided on WS API requests, echoed back in response, but is not used. Updated maximum length from 15 to 45 characters. device.ipAddress on INITIATE_BROWSER_PAYMENT, AUTHORIZE, PAY, VERIFY, TOKENIZE (Create or Update Token), REFUND, CAPTURE, DISBURSEMENT.