Changelog

The change log describes updates to the Web Services API in chronological order. For more information on the gateway API versioning see the Versioning page.

August 2024

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'transaction/items/authentication/3ds2/sdk/oobAppSupportsRedirectUrl' to the response
Added the optional property 'transaction/items/authorizationResponse/authenticationFrameworkIndicator' to the response
Added the optional property 'transaction/items/authorizationResponse/sourceReasonCode' to the response

Operations

Retrieve Transaction , Authenticate Payer , Initiate Authentication , Confirm , Initiate , Update , Authorize , Capture , Disbursement , Pay , Referral , Refund , Update Authorization , Verify , Void , Assess Risk

Non-Breaking changes

Added the optional property 'authentication/3ds2/sdk/oobAppSupportsRedirectUrl' to the response
Added the optional property 'authorizationResponse/authenticationFrameworkIndicator' to the response
Added the optional property 'authorizationResponse/sourceReasonCode' to the response
Added the new optional request property ' Capture /authorizationResponse/authenticationFrameworkIndicator'
Added the new optional request property ' Capture /authorizationResponse/sourceReasonCode'
Added the new optional request property ' Capture /referenceOrderId'
Added the optional property ' Retrieve Transaction /authentication/3ds2/sdk/oobAppSupportsRedirectUrl' to the response
Added the optional property ' Retrieve Transaction /authorizationResponse/authenticationFrameworkIndicator' to the response
Added the optional property ' Retrieve Transaction /authorizationResponse/sourceReasonCode' to the response
Added the optional property ' Authenticate Payer /authentication/3ds2/sdk/oobAppSupportsRedirectUrl' to the response

Operations

Retrieve Risk Assessment , Create or Update Risk Assessment

Non-Breaking changes

Added the new optional request property 'authentication/3ds2'
Added the new optional request property 'cruise/departureDate'
Added the new optional request property 'customer/firstName'
Added the new optional request property 'customer/lastName'
Added the new optional request property 'transactionProcessingResponse/rrn'
Added the new optional request property 'transactionProcessingResponse/stan'

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Non-Breaking changes

Added the optional property 'authorizationResponse/authenticationFrameworkIndicator' to the response
Added the optional property 'authorizationResponse/sourceReasonCode' to the response
Added the optional property ' Retrieve Session /authorizationResponse/authenticationFrameworkIndicator' to the response
Added the optional property ' Retrieve Session /authorizationResponse/sourceReasonCode' to the response
Added the new optional request property 'authorizationResponse/authenticationFrameworkIndicator'
Added the new optional request property 'authorizationResponse/sourceReasonCode'
Added the optional property 'authorizationResponse/authenticationFrameworkIndicator' to the response
Added the optional property 'authorizationResponse/sourceReasonCode' to the response

August 2024

Version 85

Operations

Retrieve Order

Breaking changes

Added the new 'AUTHENTICATION_OUTAGE' enum value to the 'transaction/items/authentication/psd2/exemption' response property
Added the new 'FIRST_RIDE_RISK' enum value to the 'transaction/items/transaction/transit/aggregatedFare/type' response property
Added the new 'FIRST_RIDE_RISK' enum value to the 'transaction/items/transaction/transit/knownFare/type' response property

Operations

Breaking changes

Added the new 'AUTHENTICATION_OUTAGE' enum value to the 'authentication/psd2/exemption' response property
Added the new 'FIRST_RIDE_RISK' enum value to the 'transaction/transit/aggregatedFare/type' response property
Added the new 'FIRST_RIDE_RISK' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'AUTHENTICATION_OUTAGE' enum value to the ' Retrieve Transaction /authentication/psd2/exemption' response property
Added the new 'FIRST_RIDE_RISK' enum value to the ' Retrieve Transaction /transaction/transit/aggregatedFare/type' response property
Added the new 'FIRST_RIDE_RISK' enum value to the ' Retrieve Transaction /transaction/transit/knownFare/type' response property

Non-Breaking changes

Added the new optional request property ' Initiate Authentication /order/subMerchant/governmentCountryCode'
Added the new optional request property ' Initiate Authentication /order/subMerchant/marketplaceId'
Added the new 'AUTHENTICATION_OUTAGE' enum value to the request property ' Authorize /authentication/psd2/exemption'
Added the new 'AUTHENTICATION_OUTAGE' enum value to the request property ' Pay /authentication/psd2/exemption'
Added the new 'FIRST_RIDE_RISK' enum value to the request property ' Capture /transaction/transit/aggregatedFare/type'
Added the new 'FIRST_RIDE_RISK' enum value to the request property ' Capture /transaction/transit/knownFare/type'
Added the optional property ' Authenticate Payer /order/subMerchant/governmentCountryCode' to the response
Added the optional property ' Authenticate Payer /order/subMerchant/marketplaceId' to the response
Added the optional property ' Initiate Authentication /order/subMerchant/governmentCountryCode' to the response
Added the optional property ' Initiate Authentication /order/subMerchant/marketplaceId' to the response

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Added the new 'AUTHENTICATION_OUTAGE' enum value to the 'authentication/psd2/exemption' response property
Added the new 'FIRST_RIDE_RISK' enum value to the 'transaction/transit/aggregatedFare/type' response property
Added the new 'FIRST_RIDE_RISK' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'AUTHENTICATION_OUTAGE' enum value to the ' Retrieve Session /authentication/psd2/exemption' response property
Added the new 'FIRST_RIDE_RISK' enum value to the ' Retrieve Session /transaction/transit/aggregatedFare/type' response property
Added the new 'FIRST_RIDE_RISK' enum value to the ' Retrieve Session /transaction/transit/knownFare/type' response property
Added the new 'AUTHENTICATION_OUTAGE' enum value to the 'authentication/psd2/exemption' response property
Added the new 'FIRST_RIDE_RISK' enum value to the 'transaction/transit/aggregatedFare/type' response property
Added the new 'FIRST_RIDE_RISK' enum value to the 'transaction/transit/knownFare/type' response property

Non-Breaking changes

Added the optional property 'schemeTokenProvisioningMode' to the response
Added the optional property ' Retrieve Session /schemeTokenProvisioningMode' to the response
Added the new optional request property 'schemeTokenProvisioningMode'
Added the new 'AUTHENTICATION_OUTAGE' enum value to the request property 'authentication/psd2/exemption'
Added the new 'FIRST_RIDE_RISK' enum value to the request property 'transaction/transit/aggregatedFare/type'
Added the new 'FIRST_RIDE_RISK' enum value to the request property 'transaction/transit/knownFare/type'
Added the optional property 'schemeTokenProvisioningMode' to the response

Operations

Create or Update Token (with system-generated token)

Non-Breaking changes

Added the new optional request property 'schemeTokenProvisioningMode'
Added the optional property 'schemeToken/status' to the response
Added the optional property 'schemeToken/statusTime' to the response
Added the optional property 'schemeTokenProvisioningMode' to the response

Operations

Delete Token , Retrieve Token , Create or Update Token

Non-Breaking changes

Added the new optional 'query' request parameter 'schemeToken'
Added the new optional 'query' request parameter 'schemeToken.preferredCryptogramType'
Added the new optional 'query' request parameter 'schemeToken.retrievePaymentData'
Added the optional property 'schemeToken/status' to the response
Added the optional property 'schemeToken/statusTime' to the response
Added the optional property 'sourceOfFunds/provided/card/devicePayment' to the response
Added the optional property 'sourceOfFunds/provided/card/securityCode' to the response
Added the new optional request property 'schemeTokenProvisioningMode'
Added the optional property 'schemeToken/status' to the response
Added the optional property 'schemeToken/statusTime' to the response
Added the optional property 'schemeTokenProvisioningMode' to the response

July 2024

Version 84

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'merchantPartnerIdCode' to the response
Added the optional property 'statementDescriptor/address/stateProvinceCode' to the response
Added the optional property 'statementDescriptor/websiteUrl' to the response
Added the optional property 'subMerchant/websiteUrl' to the response
Added the optional property 'transaction/items/order/merchantPartnerIdCode' to the response
Added the optional property 'transaction/items/order/statementDescriptor/address/stateProvinceCode' to the response
Added the optional property 'transaction/items/order/statementDescriptor/websiteUrl' to the response
Added the optional property 'transaction/items/order/subMerchant/websiteUrl' to the response
Added the optional property 'transaction/items/transaction/serviceLocation' to the response
Removed the 'AMEX_EXPRESS_CHECKOUT' enum value from the 'transaction/items/order/walletProvider' response property
Removed the 'AMEX_EXPRESS_CHECKOUT' enum value from the 'walletProvider' response property
Removed the 'MASTERPASS_ONLINE' enum value from the 'transaction/items/order/walletProvider' response property
Removed the 'MASTERPASS_ONLINE' enum value from the 'walletProvider' response property
Removed the 'VISA_CHECKOUT' enum value from the 'transaction/items/order/walletProvider' response property
Removed the 'VISA_CHECKOUT' enum value from the 'walletProvider' response property
The 'subMerchant/identifier' response's property pattern was removed
The 'transaction/items/order/subMerchant/identifier' response's property pattern was removed

Operations

Breaking changes

Removed the enum value 'AMEX_EXPRESS_CHECKOUT' of the request property ' Verify /order/walletProvider'
Removed the enum value 'AMEX_EXPRESS_CHECKOUT' of the request property ' Authorize /order/walletProvider'
Removed the enum value 'AMEX_EXPRESS_CHECKOUT' of the request property ' Capture /order/walletProvider'
Removed the enum value 'AMEX_EXPRESS_CHECKOUT' of the request property ' Pay /order/walletProvider'
Removed the enum value 'MASTERPASS_ONLINE' of the request property ' Verify /order/walletProvider'
Removed the enum value 'MASTERPASS_ONLINE' of the request property ' Authorize /order/walletProvider'
Removed the enum value 'MASTERPASS_ONLINE' of the request property ' Capture /order/walletProvider'
Removed the enum value 'MASTERPASS_ONLINE' of the request property ' Pay /order/walletProvider'
Removed the enum value 'VISA_CHECKOUT' of the request property ' Verify /order/walletProvider'
Removed the enum value 'VISA_CHECKOUT' of the request property ' Authorize /order/walletProvider'
Removed the enum value 'VISA_CHECKOUT' of the request property ' Capture /order/walletProvider'
Removed the enum value 'VISA_CHECKOUT' of the request property ' Pay /order/walletProvider'
Changed the pattern of the request property ' Refund /sourceOfFunds/provided/card/track2'
Changed the pattern of the request property ' Verify /sourceOfFunds/provided/card/track2'
Changed the pattern of the request property ' Authorize /sourceOfFunds/provided/card/track2'
Changed the pattern of the request property ' Capture /sourceOfFunds/provided/card/track2'
Changed the pattern of the request property ' Pay /sourceOfFunds/provided/card/track2'

Non-Breaking changes

Added the optional property 'order/merchantPartnerIdCode' to the response
Added the optional property 'order/statementDescriptor/address/stateProvinceCode' to the response
Added the optional property 'order/statementDescriptor/websiteUrl' to the response
Added the optional property 'order/subMerchant/websiteUrl' to the response
Added the optional property 'transaction/serviceLocation' to the response
Removed the 'AMEX_EXPRESS_CHECKOUT' enum value from the 'order/walletProvider' response property
Removed the 'MASTERPASS_ONLINE' enum value from the 'order/walletProvider' response property
Removed the 'VISA_CHECKOUT' enum value from the 'order/walletProvider' response property
The 'order/subMerchant/identifier' response's property pattern was removed
Added the new optional request property ' Refund /order/merchantPartnerIdCode'
Added the new optional request property ' Refund /order/statementDescriptor/websiteUrl'
Added the new optional request property ' Refund /order/subMerchant/websiteUrl'
Added the new optional request property ' Refund /transaction/serviceLocation'
Added the new optional request property ' Verify /order/merchantPartnerIdCode'
Added the new optional request property ' Verify /order/subMerchant/websiteUrl'
Added the new optional request property ' Verify /transaction/serviceLocation'
Added the new optional request property ' Authenticate Payer /order/statementDescriptor/address/stateProvinceCode'
Added the new optional request property ' Authenticate Payer /order/statementDescriptor/websiteUrl'
Added the new optional request property ' Initiate Authentication /order/merchantPartnerIdCode'
Added the new optional request property ' Initiate Authentication /transaction/serviceLocation'
Added the new optional request property ' Authorize /order/merchantPartnerIdCode'
Added the new optional request property ' Authorize /order/statementDescriptor/websiteUrl'
Added the new optional request property ' Authorize /order/subMerchant/websiteUrl'
Added the new optional request property ' Authorize /transaction/serviceLocation'
Added the new optional request property ' Capture /order/merchantPartnerIdCode'
Added the new optional request property ' Capture /order/statementDescriptor/websiteUrl'
Added the new optional request property ' Capture /order/subMerchant/websiteUrl'
Added the new optional request property ' Capture /transaction/serviceLocation'
Added the new optional request property ' Pay /order/merchantPartnerIdCode'
Added the new optional request property ' Pay /order/statementDescriptor/websiteUrl'
Added the new optional request property ' Pay /order/subMerchant/websiteUrl'
Added the new optional request property ' Pay /transaction/serviceLocation'
The ' Refund /sourceOfFunds/provided/card/p2pe/initializationVector' request property's maxLength was increased from '16' to '32'
The ' Refund /sourceOfFunds/provided/card/p2pe/keySerialNumber' request property's maxLength was increased from '20' to '24'
The ' Verify /sourceOfFunds/provided/card/p2pe/initializationVector' request property's maxLength was increased from '16' to '32'
The ' Verify /sourceOfFunds/provided/card/p2pe/keySerialNumber' request property's maxLength was increased from '20' to '24'
The ' Authorize /sourceOfFunds/provided/card/p2pe/initializationVector' request property's maxLength was increased from '16' to '32'
The ' Authorize /sourceOfFunds/provided/card/p2pe/keySerialNumber' request property's maxLength was increased from '20' to '24'
The ' Capture /sourceOfFunds/provided/card/p2pe/initializationVector' request property's maxLength was increased from '16' to '32'
The ' Capture /sourceOfFunds/provided/card/p2pe/keySerialNumber' request property's maxLength was increased from '20' to '24'
The ' Pay /sourceOfFunds/provided/card/p2pe/initializationVector' request property's maxLength was increased from '16' to '32'
The ' Pay /sourceOfFunds/provided/card/p2pe/keySerialNumber' request property's maxLength was increased from '20' to '24'
Removed the pattern from the request property ' Verify /order/subMerchant/identifier'
Removed the pattern from the request property ' Authorize /order/subMerchant/identifier'
Removed the pattern from the request property ' Pay /order/subMerchant/identifier'
Added the optional property ' Retrieve Transaction /order/merchantPartnerIdCode' to the response
Added the optional property ' Retrieve Transaction /order/statementDescriptor/address/stateProvinceCode' to the response
Added the optional property ' Retrieve Transaction /order/statementDescriptor/websiteUrl' to the response
Added the optional property ' Retrieve Transaction /order/subMerchant/websiteUrl' to the response
Added the optional property ' Retrieve Transaction /transaction/serviceLocation' to the response
Added the optional property ' Authenticate Payer /order/merchantPartnerIdCode' to the response
Added the optional property ' Authenticate Payer /order/statementDescriptor/address/stateProvinceCode' to the response
Added the optional property ' Authenticate Payer /order/statementDescriptor/websiteUrl' to the response
Added the optional property ' Authenticate Payer /transaction/serviceLocation' to the response
Added the optional property ' Initiate Authentication /order/merchantPartnerIdCode' to the response
Added the optional property ' Initiate Authentication /transaction/serviceLocation' to the response
Removed the 'AMEX_EXPRESS_CHECKOUT' enum value from the ' Retrieve Transaction /order/walletProvider' response property
Removed the 'MASTERPASS_ONLINE' enum value from the ' Retrieve Transaction /order/walletProvider' response property
Removed the 'VISA_CHECKOUT' enum value from the ' Retrieve Transaction /order/walletProvider' response property
The ' Retrieve Transaction /order/subMerchant/identifier' response's property pattern was removed

Operations

Payment Options Inquiry

Non-Breaking changes

Added the optional property 'paymentTypes/card/walletProviders/items/secureRemoteCommerce/capabilities' to the response

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Removed the enum value 'AMEX_EXPRESS_CHECKOUT' of the request property 'order/walletProvider'
Removed the enum value 'MASTERPASS_ONLINE' of the request property 'order/walletProvider'
Removed the enum value 'VISA_CHECKOUT' of the request property 'order/walletProvider'

Non-Breaking changes

Added the optional property 'order/authenticationStatus' to the response
Added the optional property 'order/authenticationType' to the response
Added the optional property 'order/merchantPartnerIdCode' to the response
Added the optional property 'order/statementDescriptor/websiteUrl' to the response
Added the optional property 'transaction/serviceLocation' to the response
Removed the 'AMEX_EXPRESS_CHECKOUT' enum value from the 'order/walletProvider' response property
Removed the 'MASTERPASS_ONLINE' enum value from the 'order/walletProvider' response property
Removed the 'VISA_CHECKOUT' enum value from the 'order/walletProvider' response property
Added the optional property ' Retrieve Session /order/authenticationStatus' to the response
Added the optional property ' Retrieve Session /order/authenticationType' to the response
Added the optional property ' Retrieve Session /order/merchantPartnerIdCode' to the response
Added the optional property ' Retrieve Session /order/statementDescriptor/websiteUrl' to the response
Added the optional property ' Retrieve Session /transaction/serviceLocation' to the response
Removed the 'AMEX_EXPRESS_CHECKOUT' enum value from the ' Retrieve Session /order/walletProvider' response property
Removed the 'MASTERPASS_ONLINE' enum value from the ' Retrieve Session /order/walletProvider' response property
Removed the 'VISA_CHECKOUT' enum value from the ' Retrieve Session /order/walletProvider' response property
Added the new optional request property 'order/merchantPartnerIdCode'
Added the new optional request property 'order/statementDescriptor/websiteUrl'
Added the new optional request property 'transaction/serviceLocation'
Added the optional property 'order/authenticationStatus' to the response
Added the optional property 'order/authenticationType' to the response
Added the optional property 'order/merchantPartnerIdCode' to the response
Added the optional property 'order/statementDescriptor/websiteUrl' to the response
Added the optional property 'transaction/serviceLocation' to the response
Removed the 'AMEX_EXPRESS_CHECKOUT' enum value from the 'order/walletProvider' response property
Removed the 'MASTERPASS_ONLINE' enum value from the 'order/walletProvider' response property
Removed the 'VISA_CHECKOUT' enum value from the 'order/walletProvider' response property

May 2024

Version 83

Operations

Retrieve Order

Breaking changes

Removed the optional property 'transaction/items/authorizationResponse/sli' from the response
Added the new 'ACCOUNTSETUP' enum value to the 'transaction/items/browserPayment/operation' response property

Non-Breaking changes

Added the optional property 'transaction/items/browserPayment/consent' to the response
Added the optional property 'transaction/items/browserPayment/serviceAttributes' to the response

Operations

Breaking changes

Removed the optional property 'authorizationResponse/sli' from the response
Added the new 'ACCOUNTSETUP' enum value to the 'browserPayment/operation' response property
Removed the optional property ' Retrieve Transaction /authorizationResponse/sli' from the response
Added the new 'ACCOUNTSETUP' enum value to the ' Retrieve Transaction /browserPayment/operation' response property

Non-Breaking changes

Added the optional property 'browserPayment/consent' to the response
Added the optional property 'browserPayment/serviceAttributes' to the response
Added the new optional request property ' Initiate /browserPayment/consent'
Added the new optional request property ' Initiate /browserPayment/serviceAttributes'
Added the new 'ACCOUNTSETUP' enum value to the request property ' Initiate /browserPayment/operation'
Added the optional property ' Retrieve Transaction /browserPayment/consent' to the response
Added the optional property ' Retrieve Transaction /browserPayment/serviceAttributes' to the response

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Added the new 'ACCOUNTSETUP' enum value to the 'browserPayment/operation' response property
Added the new 'ACCOUNTSETUP' enum value to the ' Retrieve Session /browserPayment/operation' response property
Added the new 'ACCOUNTSETUP' enum value to the 'browserPayment/operation' response property

Non-Breaking changes

Added the optional property 'browserPayment/consent' to the response
Added the optional property 'browserPayment/serviceAttributes' to the response
Added the optional property ' Retrieve Session /browserPayment/consent' to the response
Added the optional property ' Retrieve Session /browserPayment/serviceAttributes' to the response
Added the new optional request property 'browserPayment/consent'
Added the new optional request property 'browserPayment/serviceAttributes'
Added the new 'ACCOUNTSETUP' enum value to the request property 'browserPayment/operation'
Added the optional property 'browserPayment/consent' to the response
Added the optional property 'browserPayment/serviceAttributes' to the response

May 2024

Version 82

Same as Version 81

February 2024

Version 81

Operations

Retrieve Order

Breaking changes

Removed the optional property 'transaction/items/browserPayment/preferredLanguage' from the response

Non-Breaking changes

Added the optional property 'transaction/items/authorizationResponse/sli' to the response
Added the optional property 'transaction/items/browserPayment/locale' to the response

Operations

Breaking changes

Removed the optional property 'browserPayment/preferredLanguage' from the response
Removed the request property ' Initiate /browserPayment/preferredLanguage'
Removed the optional property ' Retrieve Transaction /browserPayment/preferredLanguage' from the response

Non-Breaking changes

Added the optional property 'authorizationResponse/sli' to the response
Added the optional property 'browserPayment/locale' to the response
Added the new optional request property ' Initiate /browserPayment/locale'
Added the optional property ' Retrieve Transaction /authorizationResponse/sli' to the response
Added the optional property ' Retrieve Transaction /browserPayment/locale' to the response

Operations

Payment Options Inquiry

Breaking changes

Added the new 'UNIONPAY' enum value to the 'paymentTypes/card/3DSecureSchemes/items/3DSecureScheme' response property

Operations

Retrieve Risk Assessment , Create or Update Risk Assessment

Non-Breaking changes

Added the new optional request property 'order/merchantCategoryCode'
Added the new optional request property 'order/subMerchant'
Added the new optional request property 'posTerminal'
Added the new optional request property 'transactionProcessingResponse/authorizationMethod'

Operations

Initiate Checkout

Non-Breaking changes

Added the new optional request property ' Initiate Checkout /interaction/displayControl/paymentMethod'

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Removed the optional property 'browserPayment/preferredLanguage' from the response
Removed the optional property ' Retrieve Session /browserPayment/preferredLanguage' from the response
Removed the request property 'browserPayment/preferredLanguage'
Removed the optional property 'browserPayment/preferredLanguage' from the response

Non-Breaking changes

Added the optional property 'browserPayment/locale' to the response
Added the optional property ' Retrieve Session /browserPayment/locale' to the response
Added the new optional request property 'browserPayment/locale'
Added the optional property 'browserPayment/locale' to the response

January 2024

Version 80

Operations

Retrieve Order

Breaking changes

Removed the optional property 'accountFunding/recipient/country' from the response
Removed the optional property 'accountFunding/recipient/dateOfBirth' from the response
Removed the optional property 'accountFunding/recipient/postCodeZip' from the response
Removed the optional property 'accountFunding/recipient/stateProvinceCode' from the response
Removed the optional property 'transaction/items/accountFunding/recipient/country' from the response
Removed the optional property 'transaction/items/accountFunding/recipient/dateOfBirth' from the response
Removed the optional property 'transaction/items/accountFunding/recipient/postCodeZip' from the response
Removed the optional property 'transaction/items/accountFunding/recipient/stateProvinceCode' from the response
Added the new 'STORED_VALUE_WALLET_USER_ID' enum value to the 'accountFunding/recipient/account/identifierType' response property
Added the new 'STORED_VALUE_WALLET_USER_ID' enum value to the 'transaction/items/accountFunding/recipient/account/identifierType' response property

Non-Breaking changes

Added the optional property 'accountFunding/recipient/address' to the response
Added the optional property 'accountFunding/recipient/identification' to the response
Added the optional property 'transaction/items/accountFunding/recipient/address' to the response
Added the optional property 'transaction/items/accountFunding/recipient/identification' to the response
Added the optional property 'transaction/items/customer/account/authentication' to the response
Added the optional property 'transaction/items/customer/account/history' to the response
Added the optional property 'transaction/items/customer/identification' to the response
Added the optional property 'transaction/items/customer/middleName' to the response

Operations

Breaking changes

Removed the optional property 'accountFunding/recipient/country' from the response
Removed the optional property 'accountFunding/recipient/dateOfBirth' from the response
Removed the optional property 'accountFunding/recipient/postCodeZip' from the response
Removed the optional property 'accountFunding/recipient/stateProvinceCode' from the response
Added the new 'STORED_VALUE_WALLET_USER_ID' enum value to the 'accountFunding/recipient/account/identifierType' response property
Removed the request property ' Refund /accountFunding/recipient/country'
Removed the request property ' Refund /accountFunding/recipient/dateOfBirth'
Removed the request property ' Refund /accountFunding/recipient/postCodeZip'
Removed the request property ' Refund /accountFunding/recipient/stateProvinceCode'
Removed the request property ' Verify /accountFunding/recipient/country'
Removed the request property ' Verify /accountFunding/recipient/dateOfBirth'
Removed the request property ' Verify /accountFunding/recipient/postCodeZip'
Removed the request property ' Verify /accountFunding/recipient/stateProvinceCode'
Removed the request property ' Authorize /accountFunding/recipient/country'
Removed the request property ' Authorize /accountFunding/recipient/dateOfBirth'
Removed the request property ' Authorize /accountFunding/recipient/postCodeZip'
Removed the request property ' Authorize /accountFunding/recipient/stateProvinceCode'
Removed the request property ' Capture /accountFunding/recipient/country'
Removed the request property ' Capture /accountFunding/recipient/dateOfBirth'
Removed the request property ' Capture /accountFunding/recipient/postCodeZip'
Removed the request property ' Capture /accountFunding/recipient/stateProvinceCode'
Removed the request property ' Pay /accountFunding/recipient/country'
Removed the request property ' Pay /accountFunding/recipient/dateOfBirth'
Removed the request property ' Pay /accountFunding/recipient/postCodeZip'
Removed the request property ' Pay /accountFunding/recipient/stateProvinceCode'
Removed the optional property ' Retrieve Transaction /accountFunding/recipient/country' from the response
Removed the optional property ' Retrieve Transaction /accountFunding/recipient/dateOfBirth' from the response
Removed the optional property ' Retrieve Transaction /accountFunding/recipient/postCodeZip' from the response
Removed the optional property ' Retrieve Transaction /accountFunding/recipient/stateProvinceCode' from the response
Added the new 'STORED_VALUE_WALLET_USER_ID' enum value to the ' Retrieve Transaction /accountFunding/recipient/account/identifierType' response property

Non-Breaking changes

Added the optional property 'accountFunding/recipient/address' to the response
Added the optional property 'accountFunding/recipient/identification' to the response
Added the optional property 'customer/account/authentication' to the response
Added the optional property 'customer/account/history' to the response
Added the optional property 'customer/identification' to the response
Added the optional property 'customer/middleName' to the response
Added the new optional request property ' Refund /accountFunding/recipient/address'
Added the new optional request property ' Refund /accountFunding/recipient/identification'
Added the new optional request property ' Refund /customer/identification'
Added the new optional request property ' Refund /customer/middleName'
Added the new optional request property ' Verify /accountFunding/recipient/address'
Added the new optional request property ' Verify /accountFunding/recipient/identification'
Added the new optional request property ' Verify /customer/account'
Added the new optional request property ' Verify /customer/identification'
Added the new optional request property ' Verify /customer/middleName'
Added the new optional request property ' Authorize /accountFunding/recipient/address'
Added the new optional request property ' Authorize /accountFunding/recipient/identification'
Added the new optional request property ' Authorize /customer/identification'
Added the new optional request property ' Authorize /customer/middleName'
Added the new optional request property ' Capture /accountFunding/recipient/address'
Added the new optional request property ' Capture /accountFunding/recipient/identification'
Added the new optional request property ' Capture /customer/identification'
Added the new optional request property ' Capture /customer/middleName'
Added the new optional request property ' Pay /accountFunding/recipient/address'
Added the new optional request property ' Pay /accountFunding/recipient/identification'
Added the new optional request property ' Pay /customer/identification'
Added the new optional request property ' Pay /customer/middleName'
Added the new 'STORED_VALUE_WALLET_USER_ID' enum value to the request property ' Refund /accountFunding/recipient/account/identifierType'
Added the new 'STORED_VALUE_WALLET_USER_ID' enum value to the request property ' Verify /accountFunding/recipient/account/identifierType'
Added the new 'STORED_VALUE_WALLET_USER_ID' enum value to the request property ' Authorize /accountFunding/recipient/account/identifierType'
Added the new 'STORED_VALUE_WALLET_USER_ID' enum value to the request property ' Capture /accountFunding/recipient/account/identifierType'
Added the new 'STORED_VALUE_WALLET_USER_ID' enum value to the request property ' Pay /accountFunding/recipient/account/identifierType'
Added the optional property ' Retrieve Transaction /accountFunding/recipient/address' to the response
Added the optional property ' Retrieve Transaction /accountFunding/recipient/identification' to the response
Added the optional property ' Retrieve Transaction /customer/account/authentication' to the response
Added the optional property ' Retrieve Transaction /customer/account/history' to the response
Added the optional property ' Retrieve Transaction /customer/identification' to the response
Added the optional property ' Retrieve Transaction /customer/middleName' to the response

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Non-Breaking changes

Added the optional property 'accountFunding/recipient/address' to the response
Added the optional property 'accountFunding/recipient/identification' to the response
Added the optional property 'customer/identification' to the response
Added the optional property 'customer/middleName' to the response
Added the optional property ' Retrieve Session /accountFunding/recipient/address' to the response
Added the optional property ' Retrieve Session /accountFunding/recipient/identification' to the response
Added the optional property ' Retrieve Session /customer/identification' to the response
Added the optional property ' Retrieve Session /customer/middleName' to the response
Added the new optional request property 'accountFunding/recipient/address'
Added the new optional request property 'accountFunding/recipient/identification'
Added the new optional request property 'customer/identification'
Added the new optional request property 'customer/middleName'
Added the optional property 'accountFunding/recipient/address' to the response
Added the optional property 'accountFunding/recipient/identification' to the response
Added the optional property 'customer/identification' to the response
Added the optional property 'customer/middleName' to the response

November 2023

Version 79

Operations

Retrieve Order

Breaking changes

The 'device/ipAddress' response property's maxLength was increased from '15' to '45'
The 'transaction/items/device/ipAddress' response property's maxLength was increased from '15' to '45'
The 'device/ipAddress' response's property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The 'transaction/items/device/ipAddress' response's property type/format changed from 'string'/'' to 'string'/'ipv4v6'

Operations

Breaking changes

The 'device/ipAddress' response property's maxLength was increased from '15' to '45'
The 'device/ipAddress' response's property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The ' Refund /device/ipAddress' request property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The ' Verify /device/ipAddress' request property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The ' Authenticate Payer /device/ipAddress' request property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The ' Initiate /device/ipAddress' request property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The ' Authorize /device/ipAddress' request property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The ' Capture /device/ipAddress' request property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The ' Disbursement /device/ipAddress' request property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The ' Pay /device/ipAddress' request property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The ' Retrieve Transaction /device/ipAddress' response property's maxLength was increased from '15' to '45'
The ' Authenticate Payer /device/ipAddress' response property's maxLength was increased from '15' to '45'
The ' Retrieve Transaction /device/ipAddress' response's property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The ' Authenticate Payer /device/ipAddress' response's property type/format changed from 'string'/'' to 'string'/'ipv4v6'

Non-Breaking changes

The ' Refund /device/ipAddress' request property's maxLength was increased from '15' to '45'
The ' Verify /device/ipAddress' request property's maxLength was increased from '15' to '45'
The ' Authenticate Payer /device/ipAddress' request property's maxLength was increased from '15' to '45'
The ' Initiate /device/ipAddress' request property's maxLength was increased from '15' to '45'
The ' Authorize /device/ipAddress' request property's maxLength was increased from '15' to '45'
The ' Capture /device/ipAddress' request property's maxLength was increased from '15' to '45'
The ' Disbursement /device/ipAddress' request property's maxLength was increased from '15' to '45'
The ' Pay /device/ipAddress' request property's maxLength was increased from '15' to '45'

Operations

Payment Options Inquiry

Non-Breaking changes

Added the optional property 'paymentTypes/browserPayment/items/description' to the response
Added the optional property 'paymentTypes/browserPayment/items/paymentPlanOffer' to the response
Added the required property 'paymentTypes/browserPayment/items/supportedCountries' to the response

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

The 'device/ipAddress' response property's maxLength was increased from '15' to '45'
The 'authentication/methodNotificationUrl' response property's maxLength was unset from '2083'
The 'device/ipAddress' response's property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The ' Retrieve Session /device/ipAddress' response property's maxLength was increased from '15' to '45'
The ' Retrieve Session /authentication/methodNotificationUrl' response property's maxLength was unset from '2083'
The ' Retrieve Session /device/ipAddress' response's property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The 'device/ipAddress' request property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The 'device/ipAddress' response property's maxLength was increased from '15' to '45'
The 'authentication/methodNotificationUrl' response property's maxLength was unset from '2083'
The 'device/ipAddress' response's property type/format changed from 'string'/'' to 'string'/'ipv4v6'

Non-Breaking changes

The 'device/ipAddress' request property's maxLength was increased from '15' to '45'

Operations

Create or Update Token (with system-generated token)

Breaking changes

The 'device/ipAddress' request property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The 'device/ipAddress' response property's maxLength was increased from '15' to '45'
The 'device/ipAddress' response's property type/format changed from 'string'/'' to 'string'/'ipv4v6'

Non-Breaking changes

The 'device/ipAddress' request property's maxLength was increased from '15' to '45'

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

The 'device/ipAddress' request property type/format changed from 'string'/'' to 'string'/'ipv4v6'
The 'device/ipAddress' response property's maxLength was increased from '15' to '45'
The 'device/ipAddress' response's property type/format changed from 'string'/'' to 'string'/'ipv4v6'

Non-Breaking changes

The 'device/ipAddress' request property's maxLength was increased from '15' to '45'

October 2023

Version 78

Operations

Retrieve Order

Breaking changes

Added the new 'AGREEMENT_CANCELLATION' enum value to the 'transaction/items/authentication/purpose' response property

Operations

Breaking changes

Added the new 'AGREEMENT_CANCELLATION' enum value to the 'authentication/purpose' response property
Added the new 'AGREEMENT_CANCELLATION' enum value to the ' Retrieve Transaction /authentication/purpose' response property
Added the new 'AGREEMENT_CANCELLATION' enum value to the ' Initiate Authentication /authentication/purpose' response property

Non-Breaking changes

Added the new optional request property ' Initiate Authentication /authentication/methodNotificationUrl'
Added the new 'AGREEMENT_CANCELLATION' enum value to the request property ' Initiate Authentication /authentication/purpose'

Operations

Initiate Checkout

Non-Breaking changes

Added the new optional request property ' Initiate Checkout /authentication/methodNotificationUrl'

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Added the new 'AGREEMENT_CANCELLATION' enum value to the 'authentication/purpose' response property
Added the new 'AGREEMENT_CANCELLATION' enum value to the ' Retrieve Session /authentication/purpose' response property
Added the new 'AGREEMENT_CANCELLATION' enum value to the 'authentication/purpose' response property

Non-Breaking changes

Added the optional property 'authentication/methodNotificationUrl' to the response
Added the optional property ' Retrieve Session /authentication/methodNotificationUrl' to the response
Added the new optional request property 'authentication/methodNotificationUrl'
Added the new 'AGREEMENT_CANCELLATION' enum value to the request property 'authentication/purpose'
Added the optional property 'authentication/methodNotificationUrl' to the response

September 2023

Version 77

Operations

Retrieve Order

Breaking changes

Added the new 'RESUBMIT_WITH_PIN' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'REVIEW_AUTHENTICATION_RESULT' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'REVIEW_RISK_STATUS' enum value to the 'transaction/items/response/gatewayRecommendation' response property

Non-Breaking changes

Added the optional property 'transaction/items/posTerminal/singleTapIndicator' to the response
Removed the 'REVIEW' enum value from the 'transaction/items/response/gatewayRecommendation' response property

Operations

Breaking changes

Added the new 'RESUBMIT_WITH_PIN' enum value to the 'response/gatewayRecommendation' response property
Added the new 'REVIEW_AUTHENTICATION_RESULT' enum value to the 'response/gatewayRecommendation' response property
Added the new 'REVIEW_RISK_STATUS' enum value to the 'response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_PIN' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'REVIEW_AUTHENTICATION_RESULT' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'REVIEW_RISK_STATUS' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property

Non-Breaking changes

Added the optional property 'posTerminal/singleTapIndicator' to the response
Removed the 'REVIEW' enum value from the 'response/gatewayRecommendation' response property
Added the new optional request property ' Authenticate Payer /order/item'
Added the new optional request property ' Authenticate Payer /transaction'
Added the new optional request property ' Authorize /posTerminal/singleTapIndicator'
Added the new optional request property ' Authorize /transaction/targetTransactionId'
Added the new optional request property ' Pay /posTerminal/singleTapIndicator'
Added the new optional request property ' Pay /transaction/targetTransactionId'
Added the optional property ' Retrieve Transaction /posTerminal/singleTapIndicator' to the response
Added the optional property ' Authenticate Payer /order/item' to the response
Added the optional property ' Authenticate Payer /transaction/merchantNote' to the response
Removed the 'REVIEW' enum value from the ' Retrieve Transaction /response/gatewayRecommendation' response property

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Non-Breaking changes

Added the optional property 'posTerminal/singleTapIndicator' to the response
Added the optional property ' Retrieve Session /posTerminal/singleTapIndicator' to the response
Added the new optional request property 'posTerminal/singleTapIndicator'
Added the optional property 'posTerminal/singleTapIndicator' to the response

July 2023

Version 76

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'transaction/items/authentication/3ds2/acsReference' to the response
Added the optional property 'transaction/items/authentication/3ds2/authenticationScheme' to the response
Added the optional property 'transaction/items/authentication/3ds2/dsReference' to the response

Operations

Non-Breaking changes

Added the optional property 'authentication/3ds2/acsReference' to the response
Added the optional property 'authentication/3ds2/authenticationScheme' to the response
Added the optional property 'authentication/3ds2/dsReference' to the response
Added the new optional request property ' Verify /authentication/3ds2/acsReference'
Added the new optional request property ' Verify /authentication/3ds2/acsTransactionId'
Added the new optional request property ' Verify /authentication/3ds2/authenticationScheme'
Added the new optional request property ' Verify /authentication/3ds2/dsReference'
Added the new optional request property ' Authorize /authentication/3ds2/acsReference'
Added the new optional request property ' Authorize /authentication/3ds2/acsTransactionId'
Added the new optional request property ' Authorize /authentication/3ds2/authenticationScheme'
Added the new optional request property ' Authorize /authentication/3ds2/dsReference'
Added the new optional request property ' Capture /authentication/3ds2/acsReference'
Added the new optional request property ' Capture /authentication/3ds2/acsTransactionId'
Added the new optional request property ' Capture /authentication/3ds2/authenticationScheme'
Added the new optional request property ' Capture /authentication/3ds2/dsReference'
Added the new optional request property ' Pay /authentication/3ds2/acsReference'
Added the new optional request property ' Pay /authentication/3ds2/acsTransactionId'
Added the new optional request property ' Pay /authentication/3ds2/authenticationScheme'
Added the new optional request property ' Pay /authentication/3ds2/dsReference'
Added the optional property ' Retrieve Transaction /authentication/3ds2/acsReference' to the response
Added the optional property ' Retrieve Transaction /authentication/3ds2/authenticationScheme' to the response
Added the optional property ' Retrieve Transaction /authentication/3ds2/dsReference' to the response
Added the optional property ' Authenticate Payer /authentication/3ds2/authenticationScheme' to the response
Added the optional property ' Authenticate Payer /authentication/3ds2/dsReference' to the response
Added the optional property ' Initiate Authentication /authentication/3ds2/authenticationScheme' to the response

Operations

Payment Options Inquiry

Breaking changes

Added the new 'MADA_SECURE' enum value to the 'paymentTypes/card/3DSecureSchemes/items/3DSecureScheme' response property

Non-Breaking changes

Added the optional property 'paymentTypes/paypal/capabilities' to the response

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Non-Breaking changes

Added the optional property 'authentication/3ds2/acsReference' to the response
Added the optional property 'authentication/3ds2/acsTransactionId' to the response
Added the optional property 'authentication/3ds2/authenticationScheme' to the response
Added the optional property 'authentication/3ds2/dsReference' to the response
Added the optional property ' Retrieve Session /authentication/3ds2/acsReference' to the response
Added the optional property ' Retrieve Session /authentication/3ds2/acsTransactionId' to the response
Added the optional property ' Retrieve Session /authentication/3ds2/authenticationScheme' to the response
Added the optional property ' Retrieve Session /authentication/3ds2/dsReference' to the response
Added the new optional request property 'authentication/3ds2/acsReference'
Added the new optional request property 'authentication/3ds2/acsTransactionId'
Added the new optional request property 'authentication/3ds2/authenticationScheme'
Added the new optional request property 'authentication/3ds2/dsReference'
Added the optional property 'authentication/3ds2/acsReference' to the response
Added the optional property 'authentication/3ds2/acsTransactionId' to the response
Added the optional property 'authentication/3ds2/authenticationScheme' to the response
Added the optional property 'authentication/3ds2/dsReference' to the response

May 2023

Version 75

Operations

SubmitExternalSrcConfirmation , Create or Update Browser Payment Token

Breaking changes

Added ' submitexternalsrcconfirmation_merchant_response, create_or_update_browser_payment_token_response' to the response body 'oneOf' list
Removed the required property 'browserPayment' from the response
Removed the required property 'merchant' from the response
Removed the required property 'result' from the response
Removed the request property 'apiOperation'
Removed the request property 'browserPayment'
Removed the request property 'correlationId'
Removed the request property 'session'
Removed the request property 'shipping'
Removed the request property 'sourceOfFunds'
Removed the request property 'subMerchant'
Removed the request property 'token'
Removed the optional property 'correlationId' from the response
Removed the optional property 'response' from the response
Removed the optional property 'session' from the response
Removed the optional property 'subMerchant' from the response

Non-Breaking changes

Api operation id 'Tokenization: Create or Update Browser Payment Token' removed and replaced with 'Merchant: SubmitExternalSrcConfirmation OR Tokenization: Create or Update Browser Payment Token'
Api tag 'Merchant' added
Added ' submitexternalsrcconfirmation_merchant_request, create_or_update_browser_payment_token_request' to the request body 'oneOf' list

Operations

Assess Risk , Authorize , Pay

Non-Breaking changes

Added the new optional request property ' Assess Risk /transaction/relatedTransactions'
Added the new optional request property ' Authorize /transaction/relatedTransactions'
Added the new optional request property ' Pay /transaction/relatedTransactions'

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Non-Breaking changes

Added the optional property 'transaction/relatedTransactions' to the response
Added the optional property ' Retrieve Session /transaction/relatedTransactions' to the response
Added the new optional request property 'transaction/relatedTransactions'
Added the optional property 'transaction/relatedTransactions' to the response

March 2023

Version 74

Operations

Create or Update Browser Payment Token

Breaking changes

Added the new required request property 'sourceOfFunds/provided/trustly/bankAccountCountryCode'

Non-Breaking changes

Added the new optional request property 'sourceOfFunds/browserPayment'
Added the new optional request property 'sourceOfFunds/provided/browserPayment'
Added the new optional request property 'sourceOfFunds/provided/epsUeberweisung'
Added the new optional request property 'sourceOfFunds/provided/klarnaPayLater'
Added the new optional request property 'sourceOfFunds/provided/klarnaPayNow'
Added the new optional request property 'sourceOfFunds/provided/payU'
Added the new optional request property 'sourceOfFunds/provided/payconiq'
Added the new optional request property 'sourceOfFunds/provided/paysafecard'
Added the new optional request property 'sourceOfFunds/provided/sofort'
Added the new 'BROWSER_PAYMENT' enum value to the request property 'sourceOfFunds/type'
Added the new 'EPS_UEBERWEISUNG' enum value to the request property 'sourceOfFunds/type'
Added the new 'MULTIBANCO' enum value to the request property 'sourceOfFunds/type'
Added the new 'PAYCONIQ' enum value to the request property 'sourceOfFunds/type'
Added the new 'PAYSAFECARD' enum value to the request property 'sourceOfFunds/type'
Added the new 'PAYU' enum value to the request property 'sourceOfFunds/type'

Operations

Retrieve Order

Breaking changes

The 'device/browser' response property's maxLength was increased from '255' to '2048'
The 'transaction/items/device/browser' response property's maxLength was increased from '255' to '2048'
Added the new 'CHECK_TRANSACTION_STATUS_LATER' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'CONTACT_PAYMENT_PROVIDER' enum value to the 'transaction/items/response/gatewayRecommendation' response property

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/browserPayment' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/browserPayment' to the response
Added the optional property 'transaction/items/transaction/resubmission' to the response

Operations

Breaking changes

The 'device/browser' response property's maxLength was increased from '255' to '2048'
Removed the enum value 'FTT' of the request property ' Assess Risk /currencyConversion/provider'
Removed the enum value 'GLOBAL_PAYMENTS' of the request property ' Assess Risk /currencyConversion/provider'
Removed the enum value 'IBM' of the request property ' Assess Risk /currencyConversion/provider'
Removed the enum value 'INDUSTRY_PRACTICE' of the request property ' Assess Risk /agreement/type'
Removed the enum value 'TRAVELEX_CURRENCY_SELECT' of the request property ' Assess Risk /currencyConversion/provider'
Removed the enum value 'UNICREDIT' of the request property ' Assess Risk /currencyConversion/provider'
The ' Retrieve Transaction /device/browser' response property's maxLength was increased from '255' to '2048'
The ' Authenticate Payer /device/browser' response property's maxLength was increased from '255' to '2048'
Added the new 'CHECK_TRANSACTION_STATUS_LATER' enum value to the 'response/gatewayRecommendation' response property
Added the new 'CONTACT_PAYMENT_PROVIDER' enum value to the 'response/gatewayRecommendation' response property
Added the new 'CHECK_TRANSACTION_STATUS_LATER' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'CONTACT_PAYMENT_PROVIDER' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/browserPayment' to the response
Added the optional property 'transaction/resubmission' to the response
Added the new optional request property ' Refund /sourceOfFunds/provided/browserPayment'
Added the new optional request property ' Refund /transaction/resubmission'
Added the new optional request property ' Assess Risk /agreement/customData'
Added the new optional request property ' Assess Risk /agreement/minimumAmountPerPayment'
Added the new optional request property ' Assess Risk /agreement/startDate'
Added the new optional request property ' Assess Risk /referenceOrderId'
Added the new optional request property ' Assess Risk /transaction/payerConsentForStoringCardDetails'
Added the new optional request property ' Assess Risk /transaction/resubmission'
Added the new optional request property ' Initiate /sourceOfFunds/provided/browserPayment'
Added the new optional request property ' Authorize /transaction/resubmission'
Added the new optional request property ' Capture /transaction/resubmission'
Added the new optional request property ' Pay /transaction/resubmission'
Added the new 'PARTIAL_SHIPMENT' enum value to the request property ' Assess Risk /order/industryPracticePaymentReason'
The ' Refund /device/browser' request property's maxLength was increased from '255' to '2048'
The ' Verify /device/browser' request property's maxLength was increased from '255' to '2048'
The ' Assess Risk /device/browser' request property's maxLength was increased from '255' to '2048'
The ' Authenticate Payer /device/browser' request property's maxLength was increased from '255' to '2048'
The ' Initiate /device/browser' request property's maxLength was increased from '255' to '2048'
The ' Authorize /device/browser' request property's maxLength was increased from '255' to '2048'
The ' Capture /device/browser' request property's maxLength was increased from '255' to '2048'
The ' Disbursement /device/browser' request property's maxLength was increased from '255' to '2048'
The ' Pay /device/browser' request property's maxLength was increased from '255' to '2048'
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/browserPayment' to the response
Added the optional property ' Retrieve Transaction /transaction/resubmission' to the response

Operations

Payment Options Inquiry

Breaking changes

Added the new 'CARD_TYPE_SELECTION' enum value to the 'paymentTypes/card/capabilities/items/capability' response property

Non-Breaking changes

Added the new optional request property 'interaction'
Added the optional property 'paymentTypes/browserPayment/items/additionalPayerData' to the response
Added the optional property 'paymentTypes/browserPayment/items/standardPayerData' to the response
Added the optional property 'paymentTypes/card/defaultCardType' to the response
The response property 'paymentTypes/browserPayment/items/displayName' became required
The response property 'paymentTypes/browserPayment/items/type' became required

Operations

Retrieve Risk Assessment , Create or Update Risk Assessment

Non-Breaking changes

Added the new optional request property 'customer/account'
The 'device/browser' request property's maxLength was increased from '255' to '2048'

Operations

Initiate Checkout

Non-Breaking changes

Added the new optional request property ' Initiate Checkout /paymentLink/errorUrl'
Added the optional property ' Initiate Checkout /paymentLink/errorUrl' to the response

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

The 'device/browser' response property's maxLength was increased from '255' to '2048'
The ' Retrieve Session /device/browser' response property's maxLength was increased from '255' to '2048'
The 'device/browser' response property's maxLength was increased from '255' to '2048'

Non-Breaking changes

Added the optional property 'interaction' to the response
Added the optional property 'sourceOfFunds/provided/browserPayment' to the response
Added the optional property 'transaction/resubmission' to the response
Added the optional property ' Retrieve Session /interaction' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/browserPayment' to the response
Added the optional property ' Retrieve Session /transaction/resubmission' to the response
Added the new optional request property 'interaction'
Added the new optional request property 'sourceOfFunds/provided/browserPayment'
Added the new optional request property 'transaction/resubmission'
The 'device/browser' request property's maxLength was increased from '255' to '2048'
Added the optional property 'interaction' to the response
Added the optional property 'sourceOfFunds/provided/browserPayment' to the response
Added the optional property 'transaction/resubmission' to the response

Operations

Create or Update Token (with system-generated token)

Non-Breaking changes

Added the new optional request property 'referenceOrderId'
Added the new optional request property 'sourceOfFunds/provided/browserPayment'
Added the optional property 'referenceOrderId' to the response
Added the optional property 'sourceOfFunds/provided/browserPayment' to the response
Added the optional property 'sourceOfFunds/provided/card/deviceSpecificExpiry' to the response
Added the optional property 'sourceOfFunds/provided/card/deviceSpecificNumber' to the response

Operations

Delete Token , Retrieve Token , Create or Update Token

Non-Breaking changes

Added the optional property 'referenceOrderId' to the response
Added the optional property 'sourceOfFunds/provided/browserPayment' to the response
Added the optional property 'sourceOfFunds/provided/card/deviceSpecificExpiry' to the response
Added the optional property 'sourceOfFunds/provided/card/deviceSpecificNumber' to the response
Added the new optional request property 'referenceOrderId'
Added the new optional request property 'sourceOfFunds/provided/browserPayment'
Added the optional property 'referenceOrderId' to the response
Added the optional property 'sourceOfFunds/provided/browserPayment' to the response
Added the optional property 'sourceOfFunds/provided/card/deviceSpecificExpiry' to the response
Added the optional property 'sourceOfFunds/provided/card/deviceSpecificNumber' to the response

Operations

Search Tokens

Non-Breaking changes

Added the optional property 'page/token/items/sourceOfFunds/provided/browserPayment' to the response

January 2023

Version 73

Operations

Cancel Agreement , Notify Scheduled Payment , Retrieve Agreement

Non-Breaking changes

Endpoint added

Operations

Retrieve Order

Breaking changes

Added the new 'BROWSER_PAYMENT' enum value to the 'sourceOfFunds/type' response property
Added the new 'BROWSER_PAYMENT' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'PARTIAL_SHIPMENT' enum value to the 'industryPracticePaymentReason' response property
Added the new 'PARTIAL_SHIPMENT' enum value to the 'transaction/items/order/industryPracticePaymentReason' response property

Non-Breaking changes

Added the optional property 'agreement/customData' to the response
Added the optional property 'agreement/minimumAmountPerPayment' to the response
Added the optional property 'agreement/startDate' to the response
Added the optional property 'referenceOrderId' to the response
Added the optional property 'transaction/items/agreement/customData' to the response
Added the optional property 'transaction/items/agreement/minimumAmountPerPayment' to the response
Added the optional property 'transaction/items/agreement/startDate' to the response
Added the optional property 'transaction/items/browserPayment/bankMessage' to the response
Added the optional property 'transaction/items/browserPayment/bankReferenceNumber' to the response
Added the optional property 'transaction/items/browserPayment/timeDelayToConfirmPayment' to the response
Added the optional property 'transaction/items/referenceOrderId' to the response
Removed the 'FTT' enum value from the 'currencyConversion/provider' response property
Removed the 'FTT' enum value from the 'transaction/items/currencyConversion/provider' response property
Removed the 'GLOBAL_PAYMENTS' enum value from the 'currencyConversion/provider' response property
Removed the 'GLOBAL_PAYMENTS' enum value from the 'transaction/items/currencyConversion/provider' response property
Removed the 'IBM' enum value from the 'currencyConversion/provider' response property
Removed the 'IBM' enum value from the 'transaction/items/currencyConversion/provider' response property
Removed the 'INDUSTRY_PRACTICE' enum value from the 'agreement/type' response property
Removed the 'INDUSTRY_PRACTICE' enum value from the 'transaction/items/agreement/type' response property
Removed the 'TRAVELEX_CURRENCY_SELECT' enum value from the 'currencyConversion/provider' response property
Removed the 'TRAVELEX_CURRENCY_SELECT' enum value from the 'transaction/items/currencyConversion/provider' response property
Removed the 'UNICREDIT' enum value from the 'currencyConversion/provider' response property
Removed the 'UNICREDIT' enum value from the 'transaction/items/currencyConversion/provider' response property

Operations

Breaking changes

Removed the enum value 'FTT' of the request property ' Refund /currencyConversion/provider'
Removed the enum value 'FTT' of the request property ' Initiate Authentication /currencyConversion/provider'
Removed the enum value 'FTT' of the request property ' Authorize /currencyConversion/provider'
Removed the enum value 'FTT' of the request property ' Capture /currencyConversion/provider'
Removed the enum value 'FTT' of the request property ' Pay /currencyConversion/provider'
Removed the enum value 'GLOBAL_PAYMENTS' of the request property ' Refund /currencyConversion/provider'
Removed the enum value 'GLOBAL_PAYMENTS' of the request property ' Initiate Authentication /currencyConversion/provider'
Removed the enum value 'GLOBAL_PAYMENTS' of the request property ' Authorize /currencyConversion/provider'
Removed the enum value 'GLOBAL_PAYMENTS' of the request property ' Capture /currencyConversion/provider'
Removed the enum value 'GLOBAL_PAYMENTS' of the request property ' Pay /currencyConversion/provider'
Removed the enum value 'IBM' of the request property ' Refund /currencyConversion/provider'
Removed the enum value 'IBM' of the request property ' Initiate Authentication /currencyConversion/provider'
Removed the enum value 'IBM' of the request property ' Authorize /currencyConversion/provider'
Removed the enum value 'IBM' of the request property ' Capture /currencyConversion/provider'
Removed the enum value 'IBM' of the request property ' Pay /currencyConversion/provider'
Removed the enum value 'INDUSTRY_PRACTICE' of the request property ' Refund /agreement/type'
Removed the enum value 'INDUSTRY_PRACTICE' of the request property ' Verify /agreement/type'
Removed the enum value 'INDUSTRY_PRACTICE' of the request property ' Authenticate Payer /agreement/type'
Removed the enum value 'INDUSTRY_PRACTICE' of the request property ' Authorize /agreement/type'
Removed the enum value 'INDUSTRY_PRACTICE' of the request property ' Capture /agreement/type'
Removed the enum value 'INDUSTRY_PRACTICE' of the request property ' Pay /agreement/type'
Removed the enum value 'TRAVELEX_CURRENCY_SELECT' of the request property ' Refund /currencyConversion/provider'
Removed the enum value 'TRAVELEX_CURRENCY_SELECT' of the request property ' Initiate Authentication /currencyConversion/provider'
Removed the enum value 'TRAVELEX_CURRENCY_SELECT' of the request property ' Authorize /currencyConversion/provider'
Removed the enum value 'TRAVELEX_CURRENCY_SELECT' of the request property ' Capture /currencyConversion/provider'
Removed the enum value 'TRAVELEX_CURRENCY_SELECT' of the request property ' Pay /currencyConversion/provider'
Removed the enum value 'UNICREDIT' of the request property ' Refund /currencyConversion/provider'
Removed the enum value 'UNICREDIT' of the request property ' Initiate Authentication /currencyConversion/provider'
Removed the enum value 'UNICREDIT' of the request property ' Authorize /currencyConversion/provider'
Removed the enum value 'UNICREDIT' of the request property ' Capture /currencyConversion/provider'
Removed the enum value 'UNICREDIT' of the request property ' Pay /currencyConversion/provider'
Added the new 'BROWSER_PAYMENT' enum value to the 'sourceOfFunds/type' response property
Added the new 'PARTIAL_SHIPMENT' enum value to the 'order/industryPracticePaymentReason' response property
Removed the optional property ' Authenticate Payer /currencyConversion/payerReceiptText' from the response
Removed the optional property ' Initiate Authentication /currencyConversion/payerReceiptText' from the response
Added the new 'BROWSER_PAYMENT' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the new 'PARTIAL_SHIPMENT' enum value to the ' Retrieve Transaction /order/industryPracticePaymentReason' response property

Non-Breaking changes

Added the optional property 'agreement/customData' to the response
Added the optional property 'agreement/minimumAmountPerPayment' to the response
Added the optional property 'agreement/startDate' to the response
Added the optional property 'browserPayment/bankMessage' to the response
Added the optional property 'browserPayment/bankReferenceNumber' to the response
Added the optional property 'browserPayment/timeDelayToConfirmPayment' to the response
Added the optional property 'referenceOrderId' to the response
Removed the 'FTT' enum value from the 'currencyConversion/provider' response property
Removed the 'GLOBAL_PAYMENTS' enum value from the 'currencyConversion/provider' response property
Removed the 'IBM' enum value from the 'currencyConversion/provider' response property
Removed the 'INDUSTRY_PRACTICE' enum value from the 'agreement/type' response property
Removed the 'TRAVELEX_CURRENCY_SELECT' enum value from the 'currencyConversion/provider' response property
Removed the 'UNICREDIT' enum value from the 'currencyConversion/provider' response property
Added the new optional request property ' Refund /agreement/customData'
Added the new optional request property ' Refund /agreement/minimumAmountPerPayment'
Added the new optional request property ' Refund /agreement/startDate'
Added the new optional request property ' Verify /agreement/customData'
Added the new optional request property ' Verify /agreement/minimumAmountPerPayment'
Added the new optional request property ' Verify /agreement/startDate'
Added the new optional request property ' Authenticate Payer /agreement/customData'
Added the new optional request property ' Authenticate Payer /agreement/minimumAmountPerPayment'
Added the new optional request property ' Authenticate Payer /agreement/startDate'
Added the new optional request property ' Authorize /agreement/customData'
Added the new optional request property ' Authorize /agreement/minimumAmountPerPayment'
Added the new optional request property ' Authorize /agreement/startDate'
Added the new optional request property ' Authorize /referenceOrderId'
Added the new optional request property ' Capture /agreement/customData'
Added the new optional request property ' Capture /agreement/minimumAmountPerPayment'
Added the new optional request property ' Capture /agreement/startDate'
Added the new optional request property ' Pay /agreement/customData'
Added the new optional request property ' Pay /agreement/minimumAmountPerPayment'
Added the new optional request property ' Pay /agreement/startDate'
Added the new optional request property ' Pay /referenceOrderId'
Added the new 'BROWSER_PAYMENT' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'PARTIAL_SHIPMENT' enum value to the request property ' Refund /order/industryPracticePaymentReason'
Added the new 'PARTIAL_SHIPMENT' enum value to the request property ' Authorize /order/industryPracticePaymentReason'
Added the new 'PARTIAL_SHIPMENT' enum value to the request property ' Capture /order/industryPracticePaymentReason'
Added the new 'PARTIAL_SHIPMENT' enum value to the request property ' Pay /order/industryPracticePaymentReason'
Added the optional property ' Retrieve Transaction /agreement/customData' to the response
Added the optional property ' Retrieve Transaction /agreement/minimumAmountPerPayment' to the response
Added the optional property ' Retrieve Transaction /agreement/startDate' to the response
Added the optional property ' Retrieve Transaction /browserPayment/bankMessage' to the response
Added the optional property ' Retrieve Transaction /browserPayment/bankReferenceNumber' to the response
Added the optional property ' Retrieve Transaction /browserPayment/timeDelayToConfirmPayment' to the response
Added the optional property ' Retrieve Transaction /referenceOrderId' to the response
Added the optional property ' Authenticate Payer /agreement/customData' to the response
Added the optional property ' Authenticate Payer /agreement/minimumAmountPerPayment' to the response
Added the optional property ' Authenticate Payer /agreement/startDate' to the response
Removed the 'FTT' enum value from the ' Retrieve Transaction /currencyConversion/provider' response property
Removed the 'FTT' enum value from the ' Authenticate Payer /currencyConversion/provider' response property
Removed the 'FTT' enum value from the ' Initiate Authentication /currencyConversion/provider' response property
Removed the 'GLOBAL_PAYMENTS' enum value from the ' Retrieve Transaction /currencyConversion/provider' response property
Removed the 'GLOBAL_PAYMENTS' enum value from the ' Authenticate Payer /currencyConversion/provider' response property
Removed the 'GLOBAL_PAYMENTS' enum value from the ' Initiate Authentication /currencyConversion/provider' response property
Removed the 'IBM' enum value from the ' Retrieve Transaction /currencyConversion/provider' response property
Removed the 'IBM' enum value from the ' Authenticate Payer /currencyConversion/provider' response property
Removed the 'IBM' enum value from the ' Initiate Authentication /currencyConversion/provider' response property
Removed the 'INDUSTRY_PRACTICE' enum value from the ' Retrieve Transaction /agreement/type' response property
Removed the 'INDUSTRY_PRACTICE' enum value from the ' Authenticate Payer /agreement/type' response property
Removed the 'TRAVELEX_CURRENCY_SELECT' enum value from the ' Retrieve Transaction /currencyConversion/provider' response property
Removed the 'TRAVELEX_CURRENCY_SELECT' enum value from the ' Authenticate Payer /currencyConversion/provider' response property
Removed the 'TRAVELEX_CURRENCY_SELECT' enum value from the ' Initiate Authentication /currencyConversion/provider' response property
Removed the 'UNICREDIT' enum value from the ' Retrieve Transaction /currencyConversion/provider' response property
Removed the 'UNICREDIT' enum value from the ' Authenticate Payer /currencyConversion/provider' response property
Removed the 'UNICREDIT' enum value from the ' Initiate Authentication /currencyConversion/provider' response property

Operations

Payment Options Inquiry

Non-Breaking changes

Added the new optional request property 'disclosureConfigRequired'
Added the optional property 'disclosureStatements' to the response
Added the optional property 'order/merchantCharge/cardBrand' to the response
Added the optional property 'order/merchantCharge/fixedAmount' to the response
Added the optional property 'order/merchantCharge/fundingMethod' to the response
Added the optional property 'order/merchantCharge/maximumFixedAmount' to the response
Added the optional property 'order/merchantCharge/maximumOrderAmount' to the response
Added the optional property 'order/merchantCharge/maximumPercentAmount' to the response
Added the optional property 'order/merchantCharge/minimumOrderAmount' to the response
Added the optional property 'order/merchantCharge/percent' to the response

Operations

Initiate Checkout

Breaking changes

Removed the enum value 'INDUSTRY_PRACTICE' of the request property ' Initiate Checkout /agreement/type'

Non-Breaking changes

Added the new optional request property ' Initiate Checkout /agreement/customData'
Added the new optional request property ' Initiate Checkout /agreement/minimumAmountPerPayment'
Added the new optional request property ' Initiate Checkout /agreement/startDate'

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Removed the enum value 'FTT' of the request property 'currencyConversion/provider'
Removed the enum value 'GLOBAL_PAYMENTS' of the request property 'currencyConversion/provider'
Removed the enum value 'IBM' of the request property 'currencyConversion/provider'
Removed the enum value 'INDUSTRY_PRACTICE' of the request property 'agreement/type'
Removed the enum value 'TRAVELEX_CURRENCY_SELECT' of the request property 'currencyConversion/provider'
Removed the enum value 'UNICREDIT' of the request property 'currencyConversion/provider'
Added the new 'BROWSER_PAYMENT' enum value to the 'sourceOfFunds/type' response property
Added the new 'PARTIAL_SHIPMENT' enum value to the 'order/industryPracticePaymentReason' response property
Added the new 'BROWSER_PAYMENT' enum value to the ' Retrieve Session /sourceOfFunds/type' response property
Added the new 'PARTIAL_SHIPMENT' enum value to the ' Retrieve Session /order/industryPracticePaymentReason' response property
Added the new 'BROWSER_PAYMENT' enum value to the 'sourceOfFunds/type' response property
Added the new 'PARTIAL_SHIPMENT' enum value to the 'order/industryPracticePaymentReason' response property

Non-Breaking changes

Added the optional property 'agreement/customData' to the response
Added the optional property 'agreement/minimumAmountPerPayment' to the response
Added the optional property 'agreement/startDate' to the response
Added the optional property 'disclosureConfigRequired' to the response
Added the optional property 'referenceOrderId' to the response
Removed the 'FTT' enum value from the 'currencyConversion/provider' response property
Removed the 'GLOBAL_PAYMENTS' enum value from the 'currencyConversion/provider' response property
Removed the 'IBM' enum value from the 'currencyConversion/provider' response property
Removed the 'INDUSTRY_PRACTICE' enum value from the 'agreement/type' response property
Removed the 'TRAVELEX_CURRENCY_SELECT' enum value from the 'currencyConversion/provider' response property
Removed the 'UNICREDIT' enum value from the 'currencyConversion/provider' response property
Added the optional property ' Retrieve Session /agreement/customData' to the response
Added the optional property ' Retrieve Session /agreement/minimumAmountPerPayment' to the response
Added the optional property ' Retrieve Session /agreement/startDate' to the response
Added the optional property ' Retrieve Session /disclosureConfigRequired' to the response
Added the optional property ' Retrieve Session /referenceOrderId' to the response
Removed the 'FTT' enum value from the ' Retrieve Session /currencyConversion/provider' response property
Removed the 'GLOBAL_PAYMENTS' enum value from the ' Retrieve Session /currencyConversion/provider' response property
Removed the 'IBM' enum value from the ' Retrieve Session /currencyConversion/provider' response property
Removed the 'INDUSTRY_PRACTICE' enum value from the ' Retrieve Session /agreement/type' response property
Removed the 'TRAVELEX_CURRENCY_SELECT' enum value from the ' Retrieve Session /currencyConversion/provider' response property
Removed the 'UNICREDIT' enum value from the ' Retrieve Session /currencyConversion/provider' response property
Added the new optional request property 'agreement/customData'
Added the new optional request property 'agreement/minimumAmountPerPayment'
Added the new optional request property 'agreement/startDate'
Added the new optional request property 'disclosureConfigRequired'
Added the new optional request property 'referenceOrderId'
Added the new 'BROWSER_PAYMENT' enum value to the request property 'sourceOfFunds/type'
Added the new 'PARTIAL_SHIPMENT' enum value to the request property 'order/industryPracticePaymentReason'
Added the optional property 'agreement/customData' to the response
Added the optional property 'agreement/minimumAmountPerPayment' to the response
Added the optional property 'agreement/startDate' to the response
Added the optional property 'disclosureConfigRequired' to the response
Added the optional property 'referenceOrderId' to the response
Removed the 'FTT' enum value from the 'currencyConversion/provider' response property
Removed the 'GLOBAL_PAYMENTS' enum value from the 'currencyConversion/provider' response property
Removed the 'IBM' enum value from the 'currencyConversion/provider' response property
Removed the 'INDUSTRY_PRACTICE' enum value from the 'agreement/type' response property
Removed the 'TRAVELEX_CURRENCY_SELECT' enum value from the 'currencyConversion/provider' response property
Removed the 'UNICREDIT' enum value from the 'currencyConversion/provider' response property

December 2022

Version 72

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'transaction/items/payerConsentForStoringCardDetails' to the response

Operations

Breaking changes

Removed the request property ' Assess Risk /order/netAmount'
Removed the request property ' Assess Risk /order/surchargeAmount'

Non-Breaking changes

Added the optional property 'payerConsentForStoringCardDetails' to the response
Added the new optional request property ' Verify /transaction/payerConsentForStoringCardDetails'
Added the new optional request property ' Authorize /transaction/payerConsentForStoringCardDetails'
Added the new optional request property ' Pay /transaction/payerConsentForStoringCardDetails'
Added the optional property ' Retrieve Transaction /payerConsentForStoringCardDetails' to the response

Operations

Initiate Checkout

Non-Breaking changes

Added the new optional request property ' Initiate Checkout /interaction/saveCardForCredentialOnFile'

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Removed the optional property 'order/surchargeAmount' from the response
Removed the optional property ' Retrieve Session /order/surchargeAmount' from the response
Removed the request property 'order/surchargeAmount'
Removed the optional property 'order/surchargeAmount' from the response

Non-Breaking changes

Added the optional property 'transaction/payerConsentForStoringCardDetails' to the response
Added the optional property ' Retrieve Session /transaction/payerConsentForStoringCardDetails' to the response
Added the new optional request property 'transaction/payerConsentForStoringCardDetails'
Added the optional property 'transaction/payerConsentForStoringCardDetails' to the response

October 2022

Version 71

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Breaking changes

Removed the request property 'sourceOfFunds/provided/card/devicePayment/3DSecure'

Non-Breaking changes

Added the new optional request property 'sourceOfFunds/provided/card/devicePayment/eciIndicator'
Added the new optional request property 'sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram'

Operations

Retrieve Order

Breaking changes

Added the new 'PAYCONIQ' enum value to the 'sourceOfFunds/type' response property
Added the new 'PAYCONIQ' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'authentication/status' to the response
Added the optional property 'sourceOfFunds/provided/payconiq' to the response
Added the optional property 'transaction/items/appPayment' to the response
Added the optional property 'transaction/items/authentication/status' to the response
Added the optional property 'transaction/items/browserPayment/openBankingBankTransfer' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/payconiq' to the response

Operations

Breaking changes

Added the new 'PAYCONIQ' enum value to the 'sourceOfFunds/type' response property
Removed the request property ' Verify /sourceOfFunds/provided/card/devicePayment/3DSecure'
Removed the request property ' Assess Risk /order/item/items/serialNumbers'
Removed the request property ' Assess Risk /sourceOfFunds/provided/card/devicePayment/3DSecure'
Removed the request property ' Authenticate Payer /sourceOfFunds/provided/card/devicePayment/3DSecure'
Removed the request property ' Initiate Authentication /sourceOfFunds/provided/card/devicePayment/3DSecure'
Removed the request property ' Authorize /order/item/items/serialNumbers'
Removed the request property ' Authorize /sourceOfFunds/provided/card/devicePayment/3DSecure'
Removed the request property ' Disbursement /sourceOfFunds/provided/card/devicePayment/3DSecure'
Removed the request property ' Pay /order/item/items/serialNumbers'
Removed the request property ' Pay /sourceOfFunds/provided/card/devicePayment/3DSecure'
Added the new 'PAYCONIQ' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'appPayment' to the response
Added the optional property 'authentication/status' to the response
Added the optional property 'browserPayment/openBankingBankTransfer' to the response
Added the optional property 'sourceOfFunds/provided/payconiq' to the response
Added the new optional request property ' Verify /order/gratuityAmount'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/devicePayment/eciIndicator'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram'
Added the new optional request property ' Assess Risk /sourceOfFunds/provided/card/devicePayment/eciIndicator'
Added the new optional request property ' Assess Risk /sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram'
Added the new optional request property ' Authenticate Payer /order/gratuityAmount'
Added the new optional request property ' Authenticate Payer /sourceOfFunds/provided/card/devicePayment/eciIndicator'
Added the new optional request property ' Authenticate Payer /sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram'
Added the new optional request property ' Initiate Authentication /sourceOfFunds/provided/card/devicePayment/eciIndicator'
Added the new optional request property ' Initiate Authentication /sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram'
Added the new optional request property ' Confirm /order/gratuityAmount'
Added the new optional request property ' Initiate /appPayment'
Added the new optional request property ' Initiate /browserPayment/openBankingBankTransfer'
Added the new optional request property ' Initiate /order/gratuityAmount'
Added the new optional request property ' Initiate /sourceOfFunds/provided/payconiq'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/devicePayment/eciIndicator'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram'
Added the new optional request property ' Disbursement /customer/account'
Added the new optional request property ' Disbursement /sourceOfFunds/provided/card/devicePayment/eciIndicator'
Added the new optional request property ' Disbursement /sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/devicePayment/eciIndicator'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram'
Added the new 'PAYCONIQ' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the optional property ' Retrieve Transaction /appPayment' to the response
Added the optional property ' Retrieve Transaction /authentication/status' to the response
Added the optional property ' Retrieve Transaction /browserPayment/openBankingBankTransfer' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/payconiq' to the response
Added the optional property ' Authenticate Payer /authentication/status' to the response

Operations

Payment Options Inquiry

Non-Breaking changes

Added the new optional request property 'browserPayment'
Added the new optional request property 'order/merchantCharge'
Added the new 'BROWSER_PAYMENT' enum value to the request property 'paymentType'
Added the new 'PAYCONIQ' enum value to the request property 'paymentType'
Added the optional property 'order/merchantCharge' to the response
Added the optional property 'paymentTypes/browserPayment' to the response
Added the optional property 'paymentTypes/openBankingBankTransfer/capabilities' to the response
Added the required property 'paymentTypes/payconiq' to the response

Operations

Retrieve Risk Assessment , Create or Update Risk Assessment

Breaking changes

Removed the request property 'sourceOfFunds/provided/card/devicePayment/3DSecure'

Non-Breaking changes

Added the new optional request property 'sourceOfFunds/provided/card/devicePayment/eciIndicator'
Added the new optional request property 'sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram'

Operations

Initiate Checkout

Breaking changes

Added the new required request property ' Initiate Checkout /order/merchantCharge/type'
The ' Initiate Checkout /order/merchantCharge' request property type/format changed from ''/'' to 'object'/''

Non-Breaking changes

Added the new optional request property ' Initiate Checkout /order/gratuityAmount'
Added the new optional request property ' Initiate Checkout /order/item/items/detail/acquirerCustom'
Added the new optional request property ' Initiate Checkout /order/item/items/detail/commodityCode'
Added the new optional request property ' Initiate Checkout /order/item/items/detail/unitDiscountRate'
Added the new optional request property ' Initiate Checkout /order/item/items/detail/unspsc'
Added the new optional request property ' Initiate Checkout /order/item/items/detail/upc'
Added the new optional request property ' Initiate Checkout /order/item/items/unitOfMeasure'

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Removed the optional property 'sourceOfFunds/provided/card/devicePayment/3DSecure' from the response
Added the new 'BROWSER_PAYMENT' enum value to the 'paymentType' response property
Added the new 'PAYCONIQ' enum value to the 'paymentType' response property
Added the new 'PAYCONIQ' enum value to the 'sourceOfFunds/type' response property
Removed the optional property ' Retrieve Session /sourceOfFunds/provided/card/devicePayment/3DSecure' from the response
Added the new 'BROWSER_PAYMENT' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'PAYCONIQ' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'PAYCONIQ' enum value to the ' Retrieve Session /sourceOfFunds/type' response property
Removed the request property 'sourceOfFunds/provided/card/devicePayment/3DSecure'
Removed the optional property 'sourceOfFunds/provided/card/devicePayment/3DSecure' from the response
Added the new 'BROWSER_PAYMENT' enum value to the 'paymentType' response property
Added the new 'PAYCONIQ' enum value to the 'paymentType' response property
Added the new 'PAYCONIQ' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'appPayment' to the response
Added the optional property 'browserPayment/openBankingBankTransfer' to the response
Added the optional property 'browserPayment/type' to the response
Added the optional property 'sourceOfFunds/provided/card/devicePayment/eciIndicator' to the response
Added the optional property 'sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram' to the response
Added the optional property 'sourceOfFunds/provided/payconiq' to the response
Added the optional property ' Retrieve Session /appPayment' to the response
Added the optional property ' Retrieve Session /browserPayment/openBankingBankTransfer' to the response
Added the optional property ' Retrieve Session /browserPayment/type' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/card/devicePayment/eciIndicator' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/payconiq' to the response
Added the new optional request property 'appPayment'
Added the new optional request property 'browserPayment/openBankingBankTransfer'
Added the new optional request property 'browserPayment/type'
Added the new optional request property 'sourceOfFunds/provided/card/devicePayment/eciIndicator'
Added the new optional request property 'sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram'
Added the new optional request property 'sourceOfFunds/provided/payconiq'
Added the new 'BROWSER_PAYMENT' enum value to the request property 'paymentType'
Added the new 'PAYCONIQ' enum value to the request property 'paymentType'
Added the new 'PAYCONIQ' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'appPayment' to the response
Added the optional property 'browserPayment/openBankingBankTransfer' to the response
Added the optional property 'browserPayment/type' to the response
Added the optional property 'sourceOfFunds/provided/card/devicePayment/eciIndicator' to the response
Added the optional property 'sourceOfFunds/provided/card/devicePayment/onlinePaymentCryptogram' to the response
Added the optional property 'sourceOfFunds/provided/payconiq' to the response

August 2022

Version 70

Operations

Item Payment Plan Offers

Breaking changes

The 'paymentPlanProduct/additionalProperties/paymentPlanProductId' response property's maxLength was increased from '10' to '60'

Operations

Retrieve Order

Breaking changes

Removed the required property 'paymentPlan/finalAmount' from the response
Removed the required property 'paymentPlan/interestRate' from the response
Removed the required property 'paymentPlan/numberOfDeferrals' from the response
Removed the required property 'paymentPlan/paymentAmount' from the response
Removed the required property 'paymentPlan/planId' from the response
Removed the optional property 'transaction/items/authentication/psd2/whitelistStatus' from the response
Removed the optional property 'transaction/items/constraints/paymentPlans/numberOfDeferrals' from the response
Removed the optional property 'transaction/items/paymentPlan' from the response
Added the new 'RESUBMIT_WITH_PAYER_AUTHENTICATION' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'TRUSTED_MERCHANT' enum value to the 'transaction/items/authentication/psd2/exemption' response property

Non-Breaking changes

Added the optional property 'accountFunding/recipient/middleName' to the response
Added the optional property 'agreement/retailer' to the response
Added the optional property 'payment' to the response
Added the optional property 'paymentPlan/cashAward' to the response
Added the optional property 'paymentPlan/interest' to the response
Added the optional property 'sourceOfFunds/browserPayment' to the response
Added the optional property 'transaction/items/accountFunding/recipient/middleName' to the response
Added the optional property 'transaction/items/agreement/retailer' to the response
Added the optional property 'transaction/items/authentication/psd2/trustedMerchantStatus' to the response
Added the optional property 'transaction/items/browserPayment/redirectHtml' to the response
Added the optional property 'transaction/items/constraints/paymentPlans/deferralPeriod' to the response
Added the optional property 'transaction/items/payment' to the response
Added the optional property 'transaction/items/sourceOfFunds/browserPayment' to the response
Added the optional property 'transaction/items/transaction/paymentPlan' to the response
The response property 'paymentPlan/receiptText' became required
Removed the 'WHITELISTED_MERCHANT' enum value from the 'transaction/items/authentication/psd2/exemption' response property
Added the required property 'paymentPlan/deferralPeriod' to the response
Added the required property 'paymentPlan/feeAmount' to the response
Added the required property 'paymentPlan/firstPaymentAmount' to the response
Added the required property 'paymentPlan/name' to the response
Added the required property 'paymentPlan/subsequentPaymentAmount' to the response
Added the required property 'paymentPlan/totalAmount' to the response

Operations

Breaking changes

Added the new required request property ' Assess Risk /paymentPlan/offerId'
Added the new required request property ' Authorize /paymentPlan/offerId'
Added the new required request property ' Pay /paymentPlan/offerId'
Removed the enum value 'INDUSTRY_PRACTICE' of the request property ' Initiate /agreement/type'
Removed the enum value 'REQUEST_WHITELISTING' of the request property ' Authenticate Payer /authentication/challengePreference'
Removed the enum value 'WHITELISTED_MERCHANT' of the request property ' Assess Risk /authentication/psd2/exemption'
Removed the enum value 'WHITELISTED_MERCHANT' of the request property ' Authenticate Payer /authentication/psd2/exemption'
Removed the enum value 'WHITELISTED_MERCHANT' of the request property ' Authorize /authentication/psd2/exemption'
Removed the enum value 'WHITELISTED_MERCHANT' of the request property ' Pay /authentication/psd2/exemption'
Removed the optional property 'authentication/psd2/whitelistStatus' from the response
Removed the optional property 'constraints/paymentPlans/numberOfDeferrals' from the response
Removed the optional property 'paymentPlan' from the response
Added the new 'RESUBMIT_WITH_PAYER_AUTHENTICATION' enum value to the 'response/gatewayRecommendation' response property
Added the new 'TRUSTED_MERCHANT' enum value to the 'authentication/psd2/exemption' response property
Removed the request property ' Assess Risk /constraints/paymentPlans/numberOfDeferrals'
Removed the request property ' Assess Risk /paymentPlan/numberOfDeferrals'
Removed the request property ' Assess Risk /paymentPlan/numberOfPayments'
Removed the request property ' Assess Risk /paymentPlan/planId'
Removed the request property ' Authorize /constraints/paymentPlans/numberOfDeferrals'
Removed the request property ' Authorize /paymentPlan/numberOfDeferrals'
Removed the request property ' Authorize /paymentPlan/numberOfPayments'
Removed the request property ' Authorize /paymentPlan/planId'
Removed the request property ' Pay /constraints/paymentPlans/numberOfDeferrals'
Removed the request property ' Pay /paymentPlan/numberOfDeferrals'
Removed the request property ' Pay /paymentPlan/numberOfPayments'
Removed the request property ' Pay /paymentPlan/planId'
Removed the optional property ' Retrieve Transaction /authentication/psd2/whitelistStatus' from the response
Removed the optional property ' Retrieve Transaction /constraints/paymentPlans/numberOfDeferrals' from the response
Removed the optional property ' Retrieve Transaction /paymentPlan' from the response
Removed the optional property ' Authenticate Payer /authentication/psd2/whitelistStatus' from the response
Added the new 'DO_NOT_PROCEED_ABANDON_ORDER' enum value to the ' Authenticate Payer /response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_ALTERNATIVE_PAYMENT_DETAILS' enum value to the ' Authenticate Payer /response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_ALTERNATIVE_PAYMENT_DETAILS' enum value to the ' Initiate Authentication /response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_PAYER_AUTHENTICATION' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'TRUSTED_MERCHANT' enum value to the ' Retrieve Transaction /authentication/psd2/exemption' response property
Added the new 'TRUSTED_MERCHANT' enum value to the ' Authenticate Payer /authentication/psd2/exemption' response property

Non-Breaking changes

Added the optional property 'accountFunding/recipient/middleName' to the response
Added the optional property 'agreement/retailer' to the response
Added the optional property 'authentication/psd2/trustedMerchantStatus' to the response
Added the optional property 'browserPayment/redirectHtml' to the response
Added the optional property 'constraints/paymentPlans/deferralPeriod' to the response
Added the optional property 'payment' to the response
Added the optional property 'sourceOfFunds/browserPayment' to the response
Added the optional property 'transaction/paymentPlan' to the response
Removed the 'WHITELISTED_MERCHANT' enum value from the 'authentication/psd2/exemption' response property
Added the new optional request property ' Refund /accountFunding'
Added the new optional request property ' Refund /agreement/retailer'
Added the new optional request property ' Refund /order/purchaseType'
Added the new optional request property ' Refund /payment'
Added the new optional request property ' Update Authorization /payment'
Added the new optional request property ' Verify /accountFunding/recipient/middleName'
Added the new optional request property ' Verify /agreement/retailer'
Added the new optional request property ' Verify /payment'
Added the new optional request property ' Assess Risk /accountFunding/recipient/middleName'
Added the new optional request property ' Assess Risk /agreement/retailer'
Added the new optional request property ' Assess Risk /constraints/paymentPlans/deferralPeriod'
Added the new optional request property ' Assess Risk /order/item/items/serialNumbers'
Added the new optional request property ' Assess Risk /payment'
Added the new optional request property ' Authenticate Payer /accountFunding/recipient/middleName'
Added the new optional request property ' Authenticate Payer /agreement/retailer'
Added the new optional request property ' Authenticate Payer /payment'
Added the new optional request property ' Initiate /sourceOfFunds/browserPayment'
Added the new optional request property ' Authorize /accountFunding/recipient/middleName'
Added the new optional request property ' Authorize /agreement/retailer'
Added the new optional request property ' Authorize /constraints/paymentPlans/deferralPeriod'
Added the new optional request property ' Authorize /order/item/items/serialNumbers'
Added the new optional request property ' Authorize /payment'
Added the new optional request property ' Capture /accountFunding'
Added the new optional request property ' Capture /agreement/retailer'
Added the new optional request property ' Capture /order/purchaseType'
Added the new optional request property ' Capture /payment'
Added the new optional request property ' Pay /accountFunding/recipient/middleName'
Added the new optional request property ' Pay /agreement/retailer'
Added the new optional request property ' Pay /constraints/paymentPlans/deferralPeriod'
Added the new optional request property ' Pay /order/item/items/serialNumbers'
Added the new optional request property ' Pay /payment'
Added the new 'INDUSTRY_PRACTICE' enum value to the request property ' Verify /agreement/type'
Added the new 'REQUEST_TRUSTED_MERCHANT_LISTING' enum value to the request property ' Authenticate Payer /authentication/challengePreference'
Added the new 'TRUSTED_MERCHANT' enum value to the request property ' Assess Risk /authentication/psd2/exemption'
Added the new 'TRUSTED_MERCHANT' enum value to the request property ' Authenticate Payer /authentication/psd2/exemption'
Added the new 'TRUSTED_MERCHANT' enum value to the request property ' Authorize /authentication/psd2/exemption'
Added the new 'TRUSTED_MERCHANT' enum value to the request property ' Pay /authentication/psd2/exemption'
The ' Refund /airline/ticket/issue/city' request property's maxLength was increased from '18' to '100'
The ' Capture /airline/ticket/issue/city' request property's maxLength was increased from '18' to '100'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property ' Refund /airline/ticket/issue/city'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property ' Capture /airline/ticket/issue/city'
Added the optional property ' Retrieve Transaction /accountFunding/recipient/middleName' to the response
Added the optional property ' Retrieve Transaction /agreement/retailer' to the response
Added the optional property ' Retrieve Transaction /authentication/psd2/trustedMerchantStatus' to the response
Added the optional property ' Retrieve Transaction /browserPayment/redirectHtml' to the response
Added the optional property ' Retrieve Transaction /constraints/paymentPlans/deferralPeriod' to the response
Added the optional property ' Retrieve Transaction /payment' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/browserPayment' to the response
Added the optional property ' Retrieve Transaction /transaction/paymentPlan' to the response
Added the optional property ' Authenticate Payer /accountFunding/recipient/middleName' to the response
Added the optional property ' Authenticate Payer /agreement/retailer' to the response
Added the optional property ' Authenticate Payer /authentication/psd2/trustedMerchantStatus' to the response
Added the optional property ' Authenticate Payer /payment' to the response
Removed the 'WHITELISTED_MERCHANT' enum value from the ' Retrieve Transaction /authentication/psd2/exemption' response property
Removed the 'WHITELISTED_MERCHANT' enum value from the ' Authenticate Payer /authentication/psd2/exemption' response property

Operations

Payment Options Inquiry

Breaking changes

Api removed without deprecation

Non-Breaking changes

Endpoint added

Operations

Plan Offers Inquiry

Breaking changes

Removed the request property 'session'

Operations

Retrieve Risk Assessment , Create or Update Risk Assessment

Non-Breaking changes

The 'airline/ticket/issue/city' request property's maxLength was increased from '18' to '100'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property 'airline/ticket/issue/city'

Operations

Initiate Checkout

Breaking changes

Removed the enum value 'REQUEST_WHITELISTING' of the request property ' Initiate Checkout /authentication/challengePreference'
Removed the enum value 'WHITELISTED_MERCHANT' of the request property ' Initiate Checkout /authentication/psd2/exemption'
Removed the request property ' Initiate Checkout /constraints/paymentPlans/numberOfDeferrals'

Non-Breaking changes

Added the new optional request property ' Initiate Checkout /accountFunding/recipient/middleName'
Added the new optional request property ' Initiate Checkout /agreement/retailer'
Added the new optional request property ' Initiate Checkout /constraints/paymentPlans/deferralPeriod'
Added the new optional request property ' Initiate Checkout /order/item/items/serialNumbers'
Added the new optional request property ' Initiate Checkout /payment'
Added the new optional request property ' Initiate Checkout /serialNumbers'
Added the new 'REQUEST_TRUSTED_MERCHANT_LISTING' enum value to the request property ' Initiate Checkout /authentication/challengePreference'
Added the new 'TRUSTED_MERCHANT' enum value to the request property ' Initiate Checkout /authentication/psd2/exemption'

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Removed the enum value 'REQUEST_WHITELISTING' of the request property 'authentication/challengePreference'
Removed the enum value 'WHITELISTED_MERCHANT' of the request property 'authentication/psd2/exemption'
Removed the optional property 'constraints/paymentPlans/numberOfDeferrals' from the response
Removed the optional property 'paymentPlan/numberOfDeferrals' from the response
Removed the optional property 'paymentPlan/numberOfPayments' from the response
Removed the optional property 'paymentPlan/planId' from the response
Added the new 'REQUEST_TRUSTED_MERCHANT_LISTING' enum value to the 'authentication/challengePreference' response property
Added the new 'TRUSTED_MERCHANT' enum value to the 'authentication/psd2/exemption' response property
Removed the optional property ' Retrieve Session /constraints/paymentPlans/numberOfDeferrals' from the response
Removed the optional property ' Retrieve Session /paymentPlan/numberOfDeferrals' from the response
Removed the optional property ' Retrieve Session /paymentPlan/numberOfPayments' from the response
Removed the optional property ' Retrieve Session /paymentPlan/planId' from the response
Added the new 'REQUEST_TRUSTED_MERCHANT_LISTING' enum value to the ' Retrieve Session /authentication/challengePreference' response property
Added the new 'TRUSTED_MERCHANT' enum value to the ' Retrieve Session /authentication/psd2/exemption' response property
Removed the request property 'constraints/paymentPlans/numberOfDeferrals'
Removed the request property 'paymentPlan/numberOfDeferrals'
Removed the request property 'paymentPlan/numberOfPayments'
Removed the request property 'paymentPlan/planId'
Removed the optional property 'constraints/paymentPlans/numberOfDeferrals' from the response
Removed the optional property 'paymentPlan/numberOfDeferrals' from the response
Removed the optional property 'paymentPlan/numberOfPayments' from the response
Removed the optional property 'paymentPlan/planId' from the response
Added the new 'REQUEST_TRUSTED_MERCHANT_LISTING' enum value to the 'authentication/challengePreference' response property
Added the new 'TRUSTED_MERCHANT' enum value to the 'authentication/psd2/exemption' response property

Non-Breaking changes

Added the optional property 'accountFunding/recipient/middleName' to the response
Added the optional property 'agreement/retailer' to the response
Added the optional property 'constraints/paymentPlans/deferralPeriod' to the response
Added the optional property 'order/item/items/serialNumbers' to the response
Added the optional property 'payerLocale' to the response
Added the optional property 'payment' to the response
Added the optional property 'paymentPlan/offerId' to the response
Added the optional property 'paymentPlanProduct' to the response
Added the optional property 'sourceOfFunds/browserPayment' to the response
Removed the 'REQUEST_WHITELISTING' enum value from the 'authentication/challengePreference' response property
Removed the 'WHITELISTED_MERCHANT' enum value from the 'authentication/psd2/exemption' response property
Added the optional property ' Retrieve Session /accountFunding/recipient/middleName' to the response
Added the optional property ' Retrieve Session /agreement/retailer' to the response
Added the optional property ' Retrieve Session /constraints/paymentPlans/deferralPeriod' to the response
Added the optional property ' Retrieve Session /order/item/items/serialNumbers' to the response
Added the optional property ' Retrieve Session /payerLocale' to the response
Added the optional property ' Retrieve Session /payment' to the response
Added the optional property ' Retrieve Session /paymentPlan/offerId' to the response
Added the optional property ' Retrieve Session /paymentPlanProduct' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/browserPayment' to the response
Removed the 'REQUEST_WHITELISTING' enum value from the ' Retrieve Session /authentication/challengePreference' response property
Removed the 'WHITELISTED_MERCHANT' enum value from the ' Retrieve Session /authentication/psd2/exemption' response property
Added the new optional request property 'accountFunding/recipient/middleName'
Added the new optional request property 'agreement/retailer'
Added the new optional request property 'constraints/paymentPlans/deferralPeriod'
Added the new optional request property 'order/item/items/serialNumbers'
Added the new optional request property 'payerLocale'
Added the new optional request property 'payment'
Added the new optional request property 'paymentPlan/offerId'
Added the new optional request property 'paymentPlanProduct'
Added the new optional request property 'sourceOfFunds/browserPayment'
Added the new 'REQUEST_TRUSTED_MERCHANT_LISTING' enum value to the request property 'authentication/challengePreference'
Added the new 'TRUSTED_MERCHANT' enum value to the request property 'authentication/psd2/exemption'
Added the optional property 'accountFunding/recipient/middleName' to the response
Added the optional property 'agreement/retailer' to the response
Added the optional property 'constraints/paymentPlans/deferralPeriod' to the response
Added the optional property 'order/item/items/serialNumbers' to the response
Added the optional property 'payerLocale' to the response
Added the optional property 'payment' to the response
Added the optional property 'paymentPlan/offerId' to the response
Added the optional property 'paymentPlanProduct' to the response
Added the optional property 'sourceOfFunds/browserPayment' to the response
Removed the 'REQUEST_WHITELISTING' enum value from the 'authentication/challengePreference' response property
Removed the 'WHITELISTED_MERCHANT' enum value from the 'authentication/psd2/exemption' response property

Operations

Shopping Options Inquiry

Breaking changes

The 'paymentPlanOffer/additionalProperties/paymentPlanProductId' response property's maxLength was increased from '10' to '60'
The 'paymentPlanProduct/additionalProperties/paymentPlanProductId' response property's maxLength was increased from '10' to '60'

Operations

Delete Token , Retrieve Token , Create or Update Token

Non-Breaking changes

Added the optional property 'usage/lastUpdated/source' to the response

Operations

Search Tokens

Non-Breaking changes

Added the optional property 'page/token/items/subMerchant' to the response

August 2022

Version 69

Operations

Item Payment Plan Offers

Breaking changes

Removed the request property 'session'

Operations

Retrieve Order

Breaking changes

Added the new 'INDUSTRY_PRACTICE' enum value to the 'agreement/type' response property
Added the new 'INDUSTRY_PRACTICE' enum value to the 'transaction/items/agreement/type' response property

Non-Breaking changes

Added the optional property 'industryPracticePaymentReason' to the response
Added the optional property 'transaction/items/order/industryPracticePaymentReason' to the response
Added the optional property 'transaction/items/response/accountUpdater' to the response

Operations

Breaking changes

Added the new 'INDUSTRY_PRACTICE' enum value to the 'agreement/type' response property
Added the new 'INDUSTRY_PRACTICE' enum value to the ' Retrieve Transaction /agreement/type' response property
Added the new 'INDUSTRY_PRACTICE' enum value to the ' Authenticate Payer /agreement/type' response property

Non-Breaking changes

Added the optional property 'order/industryPracticePaymentReason' to the response
Added the optional property 'response/accountUpdater' to the response
Added the new optional request property ' Refund /order/industryPracticePaymentReason'
Added the new optional request property ' Assess Risk /order/industryPracticePaymentReason'
Added the new optional request property ' Authorize /order/industryPracticePaymentReason'
Added the new optional request property ' Capture /order/industryPracticePaymentReason'
Added the new optional request property ' Pay /order/industryPracticePaymentReason'
Added the new 'DEBT_RECOVERY_MERCHANT_INITIATED' enum value to the request property ' Assess Risk /transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_MERCHANT_INITIATED' enum value to the request property ' Pay /transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_PAYER_INITIATED' enum value to the request property ' Assess Risk /transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_PAYER_INITIATED' enum value to the request property ' Pay /transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_TAP_INITIATED' enum value to the request property ' Assess Risk /transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_TAP_INITIATED' enum value to the request property ' Pay /transaction/transit/knownFare/type'
Added the new 'FARE_DEFERRED_AUTHORIZATION' enum value to the request property ' Assess Risk /transaction/transit/knownFare/type'
Added the new 'FARE_DEFERRED_AUTHORIZATION' enum value to the request property ' Pay /transaction/transit/knownFare/type'
Added the new 'INDUSTRY_PRACTICE' enum value to the request property ' Refund /agreement/type'
Added the new 'INDUSTRY_PRACTICE' enum value to the request property ' Assess Risk /agreement/type'
Added the new 'INDUSTRY_PRACTICE' enum value to the request property ' Authenticate Payer /agreement/type'
Added the new 'INDUSTRY_PRACTICE' enum value to the request property ' Confirm /agreement/type'
Added the new 'INDUSTRY_PRACTICE' enum value to the request property ' Initiate /agreement/type'
Added the new 'INDUSTRY_PRACTICE' enum value to the request property ' Authorize /agreement/type'
Added the new 'INDUSTRY_PRACTICE' enum value to the request property ' Capture /agreement/type'
Added the new 'INDUSTRY_PRACTICE' enum value to the request property ' Pay /agreement/type'
The ' Assess Risk /airline/ticket/issue/city' request property's maxLength was increased from '18' to '100'
The ' Pay /airline/ticket/issue/city' request property's maxLength was increased from '18' to '100'
Removed the pattern from the request property ' Refund /order/subMerchant/identifier'
Removed the pattern from the request property ' Capture /order/subMerchant/identifier'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property ' Assess Risk /airline/ticket/issue/city'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property ' Pay /airline/ticket/issue/city'
Added the optional property ' Retrieve Transaction /order/industryPracticePaymentReason' to the response
Added the optional property ' Retrieve Transaction /response/accountUpdater' to the response
Added the optional property ' Initiate Authentication /response/accountUpdater' to the response

Operations

Retrieve Risk Assessment , Create or Update Risk Assessment

Non-Breaking changes

Added the new 'INDUSTRY_PRACTICE' enum value to the request property 'agreement/type'

Operations

Initiate Checkout

Breaking changes

The ' Initiate Checkout /order/item/items/detail' request property type/format changed from ''/'' to 'object'/''

Non-Breaking changes

Added the new optional request property ' Initiate Checkout /order/discount'
Added the new optional request property ' Initiate Checkout /order/item/items/detail/tax'
Added the new optional request property ' Initiate Checkout /order/item/items/detail/unitTaxRate'
Added the new optional request property ' Initiate Checkout /order/item/items/detail/unitTaxType'
Added the new optional request property ' Initiate Checkout /order/item/items/unitDiscountAmount'
Added the new 'DEBT_RECOVERY_MERCHANT_INITIATED' enum value to the request property ' Initiate Checkout /transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_PAYER_INITIATED' enum value to the request property ' Initiate Checkout /transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_TAP_INITIATED' enum value to the request property ' Initiate Checkout /transaction/transit/knownFare/type'
Added the new 'FARE_DEFERRED_AUTHORIZATION' enum value to the request property ' Initiate Checkout /transaction/transit/knownFare/type'
Added the new 'INDUSTRY_PRACTICE' enum value to the request property ' Initiate Checkout /agreement/type'
The ' Initiate Checkout /airline/ticket/issue/city' request property's maxLength was increased from '18' to '100'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property ' Initiate Checkout /airline/ticket/issue/city'

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Removed the optional property 'item' from the response
Removed the optional property 'payerlocale' from the response
Added the new 'INDUSTRY_PRACTICE' enum value to the 'agreement/type' response property
Removed the optional property ' Retrieve Session /item' from the response
Removed the optional property ' Retrieve Session /payerlocale' from the response
Added the new 'INDUSTRY_PRACTICE' enum value to the ' Retrieve Session /agreement/type' response property
Removed the request property 'item'
Removed the request property 'payerlocale'
Removed the optional property 'item' from the response
Removed the optional property 'payerlocale' from the response
Added the new 'INDUSTRY_PRACTICE' enum value to the 'agreement/type' response property

Non-Breaking changes

Added the optional property 'order/industryPracticePaymentReason' to the response
Added the optional property ' Retrieve Session /order/industryPracticePaymentReason' to the response
Added the new optional request property 'order/industryPracticePaymentReason'
Added the new 'INDUSTRY_PRACTICE' enum value to the request property 'agreement/type'
Added the optional property 'order/industryPracticePaymentReason' to the response

Operations

Create or Update Token (with system-generated token)

Breaking changes

The 'usage/lastUpdated' response's property type/format changed from 'string'/'date-time' to 'object'/''
Removed the optional property 'usage/lastUpdatedBy' from the response
Removed the optional property 'usage/lastUsed' from the response

Non-Breaking changes

Added the optional property 'usage/lastUpdated/merchantId' to the response
Added the optional property 'usage/lastUpdated/time' to the response
Added the optional property 'usage/lastUsedTime' to the response

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

The 'usage/lastUpdated' response's property type/format changed from 'string'/'date-time' to 'object'/''
The 'usage/lastUpdated' response's property type/format changed from 'string'/'date-time' to 'object'/''
Removed the optional property 'usage/lastUpdatedBy' from the response
Removed the optional property 'usage/lastUsed' from the response
Removed the optional property 'usage/lastUpdatedBy' from the response
Removed the optional property 'usage/lastUsed' from the response

Non-Breaking changes

Added the optional property 'usage/lastUpdated/merchantId' to the response
Added the optional property 'usage/lastUpdated/time' to the response
Added the optional property 'usage/lastUsedTime' to the response
Added the optional property 'usage/lastUpdated/merchantId' to the response
Added the optional property 'usage/lastUpdated/time' to the response
Added the optional property 'usage/lastUsedTime' to the response

Operations

Search Tokens

Breaking changes

The 'page/token/items/usage/lastUpdated' response's property type/format changed from 'string'/'date-time' to 'object'/''
Removed the optional property 'page/token/items/usage/lastUpdatedBy' from the response
Removed the optional property 'page/token/items/usage/lastUsed' from the response

Non-Breaking changes

Added the optional property 'page/token/items/usage/lastUpdated/merchantId' to the response
Added the optional property 'page/token/items/usage/lastUpdated/time' to the response
Added the optional property 'page/token/items/usage/lastUsedTime' to the response

July 2022

Version 68

Operations

Retrieve Order

Breaking changes

The 'airline/ticket/issue/city' response property's maxLength was increased from '18' to '100'
The 'transaction/items/airline/ticket/issue/city' response property's maxLength was increased from '18' to '100'
Added the new 'DEBT_RECOVERY_MERCHANT_INITIATED' enum value to the 'transaction/items/transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_PAYER_INITIATED' enum value to the 'transaction/items/transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_TAP_INITIATED' enum value to the 'transaction/items/transaction/transit/knownFare/type' response property
Added the new 'FARE_DEFERRED_AUTHORIZATION' enum value to the 'transaction/items/transaction/transit/knownFare/type' response property

Non-Breaking changes

The 'airline/ticket/issue/city' response's property pattern '^[0-9a-zA-Z]*$' was removed
The 'transaction/items/airline/ticket/issue/city' response's property pattern '^[0-9a-zA-Z]*$' was removed

Operations

Breaking changes

The 'airline/ticket/issue/city' response property's maxLength was increased from '18' to '100'
The ' Retrieve Transaction /airline/ticket/issue/city' response property's maxLength was increased from '18' to '100'
Added the new 'DEBT_RECOVERY_MERCHANT_INITIATED' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_PAYER_INITIATED' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_TAP_INITIATED' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'FARE_DEFERRED_AUTHORIZATION' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_MERCHANT_INITIATED' enum value to the ' Retrieve Transaction /transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_PAYER_INITIATED' enum value to the ' Retrieve Transaction /transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_TAP_INITIATED' enum value to the ' Retrieve Transaction /transaction/transit/knownFare/type' response property
Added the new 'FARE_DEFERRED_AUTHORIZATION' enum value to the ' Retrieve Transaction /transaction/transit/knownFare/type' response property

Non-Breaking changes

The 'airline/ticket/issue/city' response's property pattern '^[0-9a-zA-Z]*$' was removed
Added the new 'DEBT_RECOVERY_MERCHANT_INITIATED' enum value to the request property ' Authorize /transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_MERCHANT_INITIATED' enum value to the request property ' Capture /transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_PAYER_INITIATED' enum value to the request property ' Authorize /transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_PAYER_INITIATED' enum value to the request property ' Capture /transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_TAP_INITIATED' enum value to the request property ' Authorize /transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_TAP_INITIATED' enum value to the request property ' Capture /transaction/transit/knownFare/type'
Added the new 'FARE_DEFERRED_AUTHORIZATION' enum value to the request property ' Authorize /transaction/transit/knownFare/type'
Added the new 'FARE_DEFERRED_AUTHORIZATION' enum value to the request property ' Capture /transaction/transit/knownFare/type'
The ' Authorize /airline/ticket/issue/city' request property's maxLength was increased from '18' to '100'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property ' Authorize /airline/ticket/issue/city'
The ' Retrieve Transaction /airline/ticket/issue/city' response's property pattern '^[0-9a-zA-Z]*$' was removed

Operations

Payment Options Inquiry

Non-Breaking changes

Added the new enum value 'PAYSAFECARD' to the 'query' request parameter 'paymentType'
Added the new enum value 'PAYU' to the 'query' request parameter 'paymentType'
Added the optional property 'paymentTypes/payU' to the response
Added the optional property 'paymentTypes/paysafecard' to the response

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

The 'airline/ticket/issue/city' response property's maxLength was increased from '18' to '100'
The ' Retrieve Session /airline/ticket/issue/city' response property's maxLength was increased from '18' to '100'
The 'airline/ticket/issue/city' response property's maxLength was increased from '18' to '100'
Added the new 'DEBT_RECOVERY_MERCHANT_INITIATED' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_PAYER_INITIATED' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_TAP_INITIATED' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'FARE_DEFERRED_AUTHORIZATION' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'PAYSAFECARD' enum value to the 'paymentType' response property
Added the new 'PAYU' enum value to the 'paymentType' response property
Added the new 'DEBT_RECOVERY_MERCHANT_INITIATED' enum value to the ' Retrieve Session /transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_PAYER_INITIATED' enum value to the ' Retrieve Session /transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_TAP_INITIATED' enum value to the ' Retrieve Session /transaction/transit/knownFare/type' response property
Added the new 'FARE_DEFERRED_AUTHORIZATION' enum value to the ' Retrieve Session /transaction/transit/knownFare/type' response property
Added the new 'PAYSAFECARD' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'PAYU' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'DEBT_RECOVERY_MERCHANT_INITIATED' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_PAYER_INITIATED' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'DEBT_RECOVERY_TAP_INITIATED' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'FARE_DEFERRED_AUTHORIZATION' enum value to the 'transaction/transit/knownFare/type' response property
Added the new 'PAYSAFECARD' enum value to the 'paymentType' response property
Added the new 'PAYU' enum value to the 'paymentType' response property

Non-Breaking changes

The 'airline/ticket/issue/city' response's property pattern '^[0-9a-zA-Z]*$' was removed
The ' Retrieve Session /airline/ticket/issue/city' response's property pattern '^[0-9a-zA-Z]*$' was removed
Added the new 'DEBT_RECOVERY_MERCHANT_INITIATED' enum value to the request property 'transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_PAYER_INITIATED' enum value to the request property 'transaction/transit/knownFare/type'
Added the new 'DEBT_RECOVERY_TAP_INITIATED' enum value to the request property 'transaction/transit/knownFare/type'
Added the new 'FARE_DEFERRED_AUTHORIZATION' enum value to the request property 'transaction/transit/knownFare/type'
Added the new 'PAYSAFECARD' enum value to the request property 'paymentType'
Added the new 'PAYU' enum value to the request property 'paymentType'
The 'airline/ticket/issue/city' request property's maxLength was increased from '18' to '100'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property 'airline/ticket/issue/city'
The 'airline/ticket/issue/city' response's property pattern '^[0-9a-zA-Z]*$' was removed

Operations

Create or Update Token (with system-generated token)

Breaking changes

Added the new 'DIRECT_DEBIT_CANADA' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the new optional request property 'sourceOfFunds/provided/directDebitCanada'
Added the new optional request property 'subMerchant'
Added the new 'DIRECT_DEBIT_CANADA' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'sourceOfFunds/provided/directDebitCanada' to the response
Added the optional property 'subMerchant' to the response
Removed the 'BANAMEX_COSTCO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'BANKAXEPT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'BED_BATH_AND_BEYOND' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARNET' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARTE_BANCAIRE' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CITIBANK_PRIVATE_LABEL_CARD' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO_MEMBER_CREDIT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CRATE_AND_BARREL' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'EBT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'EFTPOS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'ELO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'FARMERS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_JCB' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_MAESTRO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_VISA' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'LASER' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'OTHER' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'PAGOBANCOMAT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'Q_CARD' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'SORIANA' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'TRUE_REWARDS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

Added the new 'DIRECT_DEBIT_CANADA' enum value to the 'sourceOfFunds/type' response property
Added the new 'DIRECT_DEBIT_CANADA' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/directDebitCanada' to the response
Added the new optional request property 'sourceOfFunds/provided/directDebitCanada'
Added the new 'DIRECT_DEBIT_CANADA' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'sourceOfFunds/provided/directDebitCanada' to the response

Operations

Search Tokens

Breaking changes

Added the new 'DIRECT_DEBIT_CANADA' enum value to the 'page/token/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'page/token/items/sourceOfFunds/provided/directDebitCanada' to the response

April 2022

Version 67

Operations

Create or Update Browser Payment Token

Non-Breaking changes

Added the new optional request property 'subMerchant'
Added the optional property 'subMerchant' to the response

Operations

Balance Inquiry

Breaking changes

Added the pattern to the request property 'order/subMerchant/identifier'

Non-Breaking changes

Added the new optional request property 'order/subMerchant/disputeContactPhone'
Added the new optional request property 'order/subMerchant/governmentCountryCode'
Added the new optional request property 'order/subMerchant/marketplaceId'
Added the optional property 'order/subMerchant/address/stateProvinceCode' to the response
Added the optional property 'order/subMerchant/disputeContactPhone' to the response
Added the optional property 'order/subMerchant/governmentCountryCode' to the response
Added the optional property 'order/subMerchant/marketplaceId' to the response
The response property 'order/subMerchant/identifier' became required
The response property 'order/subMerchant/tradingName' became required
The 'order/subMerchant/identifier' response's property pattern was added

Operations

Item Payment Plan Offers

Non-Breaking changes

Endpoint added

Operations

Retrieve Order

Breaking changes

Removed the optional property 'sourceOfFunds/provided/sofort/country' from the response
Removed the optional property 'transaction/items/sourceOfFunds/provided/sofort/country' from the response
Added the new 'EPS_UEBERWEISUNG' enum value to the 'sourceOfFunds/type' response property
Added the new 'EPS_UEBERWEISUNG' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'PAYSAFECARD' enum value to the 'sourceOfFunds/type' response property
Added the new 'PAYSAFECARD' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'PAYU' enum value to the 'sourceOfFunds/type' response property
Added the new 'PAYU' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

For the 'query' request parameter 'responseControls', the type/format was generalized from 'object'/'' to ''/''
Added the optional property 'accountFunding/recipient/stateProvinceCode' to the response
Added the optional property 'dutyAmount' to the response
Added the optional property 'merchantCharge' to the response
Added the optional property 'shippingAndHandlingTaxAmount' to the response
Added the optional property 'shippingAndHandlingTaxRate' to the response
Added the optional property 'sourceOfFunds/provided/epsUeberweisung' to the response
Added the optional property 'sourceOfFunds/provided/klarnaPayLater' to the response
Added the optional property 'sourceOfFunds/provided/payU' to the response
Added the optional property 'sourceOfFunds/provided/paysafecard' to the response
Added the optional property 'sourceOfFunds/provided/sofort/bankAccountCountryCode' to the response
Added the optional property 'subMerchant/authentication' to the response
Added the optional property 'transaction/items/accountFunding/recipient/stateProvinceCode' to the response
Added the optional property 'transaction/items/order/merchantCharge' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/epsUeberweisung' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/klarnaPayLater' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/payU' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/paysafecard' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/sofort/bankAccountCountryCode' to the response
Removed the 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value from the 'purchaseType' response property
Removed the 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value from the 'transaction/items/order/purchaseType' response property
The 'accountFunding/recipient/country' response's property pattern '^[A-Z]*$' was added
The 'subMerchant/identifier' response's property pattern was added
The 'transaction/items/accountFunding/recipient/country' response's property pattern '^[A-Z]*$' was added
The 'transaction/items/order/subMerchant/identifier' response's property pattern was added

Operations

Breaking changes

Removed the enum value 'PREPAID_PAYMENT_INSTRUMENT_LOADING' of the request property ' Verify /order/purchaseType'
Removed the enum value 'PREPAID_PAYMENT_INSTRUMENT_LOADING' of the request property ' Assess Risk /order/purchaseType'
Removed the enum value 'PREPAID_PAYMENT_INSTRUMENT_LOADING' of the request property ' Authenticate Payer /order/purchaseType'
Removed the enum value 'PREPAID_PAYMENT_INSTRUMENT_LOADING' of the request property ' Authorize /order/purchaseType'
Removed the enum value 'PREPAID_PAYMENT_INSTRUMENT_LOADING' of the request property ' Pay /order/purchaseType'
The ' Verify /accountFunding/recipient/country' request property's minLength was increased from '1' to '3'
The ' Assess Risk /accountFunding/recipient/country' request property's minLength was increased from '1' to '3'
The ' Authenticate Payer /accountFunding/recipient/country' request property's minLength was increased from '1' to '3'
The ' Authorize /accountFunding/recipient/country' request property's minLength was increased from '1' to '3'
The ' Pay /accountFunding/recipient/country' request property's minLength was increased from '1' to '3'
Removed the optional property 'sourceOfFunds/provided/sofort/country' from the response
Added the new 'EPS_UEBERWEISUNG' enum value to the 'sourceOfFunds/type' response property
Added the new 'PAYSAFECARD' enum value to the 'sourceOfFunds/type' response property
Added the new 'PAYU' enum value to the 'sourceOfFunds/type' response property
Added the pattern to the request property ' Refund /order/subMerchant/identifier'
Added the pattern to the request property ' Verify /order/subMerchant/identifier'
Added the pattern to the request property ' Assess Risk /order/subMerchant/identifier'
Added the pattern to the request property ' Initiate Authentication /order/subMerchant/identifier'
Added the pattern to the request property ' Authorize /order/subMerchant/identifier'
Added the pattern to the request property ' Capture /order/subMerchant/identifier'
Added the pattern to the request property ' Pay /order/subMerchant/identifier'
Added the pattern '^[A-Z]*$' to the request property ' Verify /accountFunding/recipient/country'
Added the pattern '^[A-Z]*$' to the request property ' Assess Risk /accountFunding/recipient/country'
Added the pattern '^[A-Z]*$' to the request property ' Authenticate Payer /accountFunding/recipient/country'
Added the pattern '^[A-Z]*$' to the request property ' Authorize /accountFunding/recipient/country'
Added the pattern '^[A-Z]*$' to the request property ' Pay /accountFunding/recipient/country'
Removed the request property ' Update Authorization /order/surchargeAmount'
Removed the request property ' Authenticate Payer /order/surchargeAmount'
Removed the request property ' Initiate /sourceOfFunds/provided/sofort/bic'
Removed the request property ' Authorize /order/surchargeAmount'
Removed the request property ' Capture /order/surchargeAmount'
Removed the request property ' Pay /order/surchargeAmount'
Removed the optional property ' Retrieve Transaction /sourceOfFunds/provided/sofort/country' from the response
Removed the optional property ' Authenticate Payer /authentication/redirect/customized' from the response
Removed the optional property ' Authenticate Payer /authentication/redirectHtml' from the response
Removed the optional property ' Authenticate Payer /customer/account/authentication/data' from the response
Removed the optional property ' Initiate Authentication /authentication/redirect/customized' from the response
Removed the optional property ' Initiate Authentication /authentication/redirectHtml' from the response
Removed the optional property ' Initiate Authentication /sourceOfFunds/provided/sofort/country' from the response
Added the new 'EPS_UEBERWEISUNG' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the new 'PAYSAFECARD' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the new 'PAYU' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property

Non-Breaking changes

For the 'query' request parameter 'responseControls', the type/format was generalized from 'object'/'' to ''/''
Added the optional property 'accountFunding/recipient/stateProvinceCode' to the response
Added the optional property 'order/merchantCharge' to the response
Added the optional property 'sourceOfFunds/provided/epsUeberweisung' to the response
Added the optional property 'sourceOfFunds/provided/klarnaPayLater' to the response
Added the optional property 'sourceOfFunds/provided/payU' to the response
Added the optional property 'sourceOfFunds/provided/paysafecard' to the response
Added the optional property 'sourceOfFunds/provided/sofort/bankAccountCountryCode' to the response
Removed the 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value from the 'order/purchaseType' response property
The 'accountFunding/recipient/country' response's property pattern '^[A-Z]*$' was added
The 'order/subMerchant/identifier' response's property pattern was added
Added the new optional request property ' Refund /sourceOfFunds/provided/paysafecard'
Added the new optional request property ' Update Authorization /order/merchantCharge'
Added the new optional request property ' Verify /accountFunding/recipient/stateProvinceCode'
Added the new optional request property ' Assess Risk /accountFunding/recipient/stateProvinceCode'
Added the new optional request property ' Assess Risk /order/item/items/image'
Added the new optional request property ' Assess Risk /order/merchantCharge'
Added the new optional request property ' Authenticate Payer /accountFunding/recipient/stateProvinceCode'
Added the new optional request property ' Authenticate Payer /customer/taxRegistrationId'
Added the new optional request property ' Authenticate Payer /device/ani'
Added the new optional request property ' Authenticate Payer /device/aniCallType'
Added the new optional request property ' Authenticate Payer /device/fingerprint'
Added the new optional request property ' Authenticate Payer /device/hostname'
Added the new optional request property ' Authenticate Payer /device/mobilePhoneModel'
Added the new optional request property ' Authenticate Payer /order/acceptPartialAmount'
Added the new optional request property ' Authenticate Payer /order/certainty'
Added the new optional request property ' Authenticate Payer /order/custom'
Added the new optional request property ' Authenticate Payer /order/customerNote'
Added the new optional request property ' Authenticate Payer /order/customerOrderDate'
Added the new optional request property ' Authenticate Payer /order/customerReference'
Added the new optional request property ' Authenticate Payer /order/description'
Added the new optional request property ' Authenticate Payer /order/invoiceNumber'
Added the new optional request property ' Authenticate Payer /order/localTaxRegistrationId'
Added the new optional request property ' Authenticate Payer /order/marketplace'
Added the new optional request property ' Authenticate Payer /order/merchantCharge'
Added the new optional request property ' Authenticate Payer /order/owningEntity'
Added the new optional request property ' Authenticate Payer /order/requestorName'
Added the new optional request property ' Authenticate Payer /order/taxRegistrationId'
Added the new optional request property ' Authenticate Payer /order/taxStatus'
Added the new optional request property ' Authenticate Payer /order/transactionFiltering'
Added the new optional request property ' Authenticate Payer /order/walletIndicator'
Added the new optional request property ' Initiate /sourceOfFunds/provided/epsUeberweisung'
Added the new optional request property ' Initiate /sourceOfFunds/provided/klarnaPayLater'
Added the new optional request property ' Initiate /sourceOfFunds/provided/payU'
Added the new optional request property ' Initiate /sourceOfFunds/provided/paysafecard'
Added the new optional request property ' Initiate /sourceOfFunds/provided/sofort/bankAccountCountryCode'
Added the new optional request property ' Authorize /accountFunding/recipient/stateProvinceCode'
Added the new optional request property ' Authorize /order/item/items/image'
Added the new optional request property ' Authorize /order/merchantCharge'
Added the new optional request property ' Capture /order/merchantCharge'
Added the new optional request property ' Pay /accountFunding/recipient/stateProvinceCode'
Added the new optional request property ' Pay /order/item/items/image'
Added the new optional request property ' Pay /order/merchantCharge'
Added the new 'EPS_UEBERWEISUNG' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'PAYSAFECARD' enum value to the request property ' Refund /sourceOfFunds/type'
Added the new 'PAYSAFECARD' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'PAYU' enum value to the request property ' Initiate /sourceOfFunds/type'
The ' Authenticate Payer /customer/account/authentication/data' request property's maxLength was increased from '2048' to '20000'
Added the optional property ' Retrieve Transaction /accountFunding/recipient/stateProvinceCode' to the response
Added the optional property ' Retrieve Transaction /order/merchantCharge' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/epsUeberweisung' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/klarnaPayLater' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/payU' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/paysafecard' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/sofort/bankAccountCountryCode' to the response
Added the optional property ' Authenticate Payer /accountFunding/recipient/stateProvinceCode' to the response
Added the optional property ' Authenticate Payer /authentication/redirect/customizedHtml' to the response
Added the optional property ' Authenticate Payer /authentication/redirect/html' to the response
Added the optional property ' Authenticate Payer /customer/taxRegistrationId' to the response
Added the optional property ' Authenticate Payer /device/ani' to the response
Added the optional property ' Authenticate Payer /device/aniCallType' to the response
Added the optional property ' Authenticate Payer /device/hostname' to the response
Added the optional property ' Authenticate Payer /device/mobilePhoneModel' to the response
Added the optional property ' Authenticate Payer /order/acceptPartialAmount' to the response
Added the optional property ' Authenticate Payer /order/certainty' to the response
Added the optional property ' Authenticate Payer /order/custom' to the response
Added the optional property ' Authenticate Payer /order/customerNote' to the response
Added the optional property ' Authenticate Payer /order/customerOrderDate' to the response
Added the optional property ' Authenticate Payer /order/customerReference' to the response
Added the optional property ' Authenticate Payer /order/description' to the response
Added the optional property ' Authenticate Payer /order/invoiceNumber' to the response
Added the optional property ' Authenticate Payer /order/localTaxRegistrationId' to the response
Added the optional property ' Authenticate Payer /order/marketplace' to the response
Added the optional property ' Authenticate Payer /order/merchantCharge' to the response
Added the optional property ' Authenticate Payer /order/owningEntity' to the response
Added the optional property ' Authenticate Payer /order/requestorName' to the response
Added the optional property ' Authenticate Payer /order/taxRegistrationId' to the response
Added the optional property ' Authenticate Payer /order/taxStatus' to the response
Added the optional property ' Authenticate Payer /order/transactionFiltering' to the response
Added the optional property ' Authenticate Payer /order/walletIndicator' to the response
Added the optional property ' Initiate Authentication /authentication/redirect/customizedHtml' to the response
Added the optional property ' Initiate Authentication /authentication/redirect/html' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/epsUeberweisung' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/klarnaPayLater' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/payU' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/paysafecard' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/sofort/bankAccountCountryCode' to the response
Removed the 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value from the ' Retrieve Transaction /order/purchaseType' response property
The ' Retrieve Transaction /accountFunding/recipient/country' response's property pattern '^[A-Z]*$' was added
The ' Retrieve Transaction /order/subMerchant/identifier' response's property pattern was added
The ' Authenticate Payer /accountFunding/recipient/country' response's property pattern '^[A-Z]*$' was added
The ' Authenticate Payer /order/subMerchant/identifier' response's property pattern was added
The ' Initiate Authentication /order/subMerchant/identifier' response's property pattern was added

Operations

Payment Options Inquiry

Non-Breaking changes

Added the new enum value 'DIRECT_DEBIT_CANADA' to the 'query' request parameter 'paymentType'
Added the new enum value 'EPS_UEBERWEISUNG' to the 'query' request parameter 'paymentType'
Added the optional property 'paymentTypes/directDebitCanada' to the response
Added the optional property 'paymentTypes/epsUeberweisung' to the response

Operations

Update Payment Plan Offer

Breaking changes

Changed the pattern of the 'path' request parameter 'paymentPlanOfferId' from '^[0-9a-zA-Z]*$' to '^[0-9a-zA-Z\-_]*$'

Non-Breaking changes

Added the new optional request property 'session/version'

Operations

Initiate Checkout

Breaking changes

Removed the enum value 'PREPAID_PAYMENT_INSTRUMENT_LOADING' of the request property ' Initiate Checkout /order/purchaseType'
The ' Initiate Checkout /accountFunding/recipient/country' request property's minLength was increased from '1' to '3'
Added the pattern to the request property ' Initiate Checkout /order/subMerchant/identifier'
Added the pattern '^[A-Z]*$' to the request property ' Initiate Checkout /accountFunding/recipient/country'

Non-Breaking changes

Added the new optional request property ' Initiate Checkout /accountFunding/recipient/stateProvinceCode'
Added the new optional request property ' Initiate Checkout /customer/taxRegistrationId'
Added the new optional request property ' Initiate Checkout /device/hostname'
Added the new optional request property ' Initiate Checkout /order/acceptPartialAmount'
Added the new optional request property ' Initiate Checkout /order/item/items/image'
Added the new optional request property ' Initiate Checkout /order/localTaxRegistrationId'
Added the new optional request property ' Initiate Checkout /order/merchantCharge'
Added the new optional request property ' Initiate Checkout /order/taxStatus'
Added the new optional request property ' Initiate Checkout /order/walletIndicator'

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

The 'customer/account/authentication/data' response property's maxLength was increased from '2048' to '20000'
The ' Retrieve Session /customer/account/authentication/data' response property's maxLength was increased from '2048' to '20000'
Removed the enum value 'PREPAID_PAYMENT_INSTRUMENT_LOADING' of the request property 'order/purchaseType'
The 'accountFunding/recipient/country' request property's minLength was increased from '1' to '3'
The 'customer/account/authentication/data' response property's maxLength was increased from '2048' to '20000'
Removed the optional property 'sourceOfFunds/provided/sofort/bic' from the response
Added the new 'DIRECT_DEBIT_CANADA' enum value to the 'paymentType' response property
Added the new 'EPS_UEBERWEISUNG' enum value to the 'paymentType' response property
Added the new 'EPS_UEBERWEISUNG' enum value to the 'sourceOfFunds/type' response property
Added the new 'PAYSAFECARD' enum value to the 'sourceOfFunds/type' response property
Added the new 'PAYU' enum value to the 'sourceOfFunds/type' response property
Removed the optional property ' Retrieve Session /sourceOfFunds/provided/sofort/bic' from the response
Added the new 'DIRECT_DEBIT_CANADA' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'EPS_UEBERWEISUNG' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'EPS_UEBERWEISUNG' enum value to the ' Retrieve Session /sourceOfFunds/type' response property
Added the new 'PAYSAFECARD' enum value to the ' Retrieve Session /sourceOfFunds/type' response property
Added the new 'PAYU' enum value to the ' Retrieve Session /sourceOfFunds/type' response property
Added the pattern to the request property 'order/subMerchant/identifier'
Added the pattern '^[A-Z]*$' to the request property 'accountFunding/recipient/country'
Changed the pattern of the request property 'paymentPlanOffer/id' from '^[0-9a-zA-Z]*$' to '^[0-9a-zA-Z\-_]*$'
Removed the request property 'sourceOfFunds/provided/sofort/bic'
Removed the optional property 'sourceOfFunds/provided/sofort/bic' from the response
Added the new 'DIRECT_DEBIT_CANADA' enum value to the 'paymentType' response property
Added the new 'EPS_UEBERWEISUNG' enum value to the 'paymentType' response property
Added the new 'EPS_UEBERWEISUNG' enum value to the 'sourceOfFunds/type' response property
Added the new 'PAYSAFECARD' enum value to the 'sourceOfFunds/type' response property
Added the new 'PAYU' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

For the 'query' request parameter 'responseControls', the type/format was generalized from 'object'/'' to ''/''
Added the optional property 'accountFunding/recipient/stateProvinceCode' to the response
Added the optional property 'item' to the response
Added the optional property 'order/item/items/image' to the response
Added the optional property 'order/merchantCharge' to the response
Added the optional property 'payerlocale' to the response
Added the optional property 'sourceOfFunds/provided/epsUeberweisung' to the response
Added the optional property 'sourceOfFunds/provided/klarnaPayLater' to the response
Added the optional property 'sourceOfFunds/provided/payU' to the response
Added the optional property 'sourceOfFunds/provided/paysafecard' to the response
Added the optional property 'sourceOfFunds/provided/sofort/bankAccountCountryCode' to the response
Added the optional property 'subMerchant' to the response
Removed the 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value from the 'order/purchaseType' response property
The 'accountFunding/recipient/country' response's property pattern '^[A-Z]*$' was added
The 'order/subMerchant/identifier' response's property pattern was added
The 'paymentPlanOffer/id' response's property pattern was changed from '^[0-9a-zA-Z]*$' to '^[0-9a-zA-Z\-_]*$'
Added the optional property ' Retrieve Session /accountFunding/recipient/stateProvinceCode' to the response
Added the optional property ' Retrieve Session /item' to the response
Added the optional property ' Retrieve Session /order/item/items/image' to the response
Added the optional property ' Retrieve Session /order/merchantCharge' to the response
Added the optional property ' Retrieve Session /payerlocale' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/epsUeberweisung' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/klarnaPayLater' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/payU' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/paysafecard' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/sofort/bankAccountCountryCode' to the response
Added the optional property ' Retrieve Session /subMerchant' to the response
Removed the 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value from the ' Retrieve Session /order/purchaseType' response property
The ' Retrieve Session /accountFunding/recipient/country' response's property pattern '^[A-Z]*$' was added
The ' Retrieve Session /order/subMerchant/identifier' response's property pattern was added
The ' Retrieve Session /paymentPlanOffer/id' response's property pattern was changed from '^[0-9a-zA-Z]*$' to '^[0-9a-zA-Z\-_]*$'
Added the new optional request property 'accountFunding/recipient/stateProvinceCode'
Added the new optional request property 'item'
Added the new optional request property 'order/item/items/image'
Added the new optional request property 'order/merchantCharge'
Added the new optional request property 'payerlocale'
Added the new optional request property 'sourceOfFunds/provided/epsUeberweisung'
Added the new optional request property 'sourceOfFunds/provided/klarnaPayLater'
Added the new optional request property 'sourceOfFunds/provided/payU'
Added the new optional request property 'sourceOfFunds/provided/paysafecard'
Added the new optional request property 'sourceOfFunds/provided/sofort/bankAccountCountryCode'
Added the new optional request property 'subMerchant'
Added the new 'DIRECT_DEBIT_CANADA' enum value to the request property 'paymentType'
Added the new 'EPS_UEBERWEISUNG' enum value to the request property 'paymentType'
Added the new 'EPS_UEBERWEISUNG' enum value to the request property 'sourceOfFunds/type'
Added the new 'PAYSAFECARD' enum value to the request property 'sourceOfFunds/type'
Added the new 'PAYU' enum value to the request property 'sourceOfFunds/type'
The 'customer/account/authentication/data' request property's maxLength was increased from '2048' to '20000'
Added the optional property 'accountFunding/recipient/stateProvinceCode' to the response
Added the optional property 'item' to the response
Added the optional property 'order/item/items/image' to the response
Added the optional property 'order/merchantCharge' to the response
Added the optional property 'payerlocale' to the response
Added the optional property 'sourceOfFunds/provided/epsUeberweisung' to the response
Added the optional property 'sourceOfFunds/provided/klarnaPayLater' to the response
Added the optional property 'sourceOfFunds/provided/payU' to the response
Added the optional property 'sourceOfFunds/provided/paysafecard' to the response
Added the optional property 'sourceOfFunds/provided/sofort/bankAccountCountryCode' to the response
Added the optional property 'subMerchant' to the response
Removed the 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value from the 'order/purchaseType' response property
The 'accountFunding/recipient/country' response's property pattern '^[A-Z]*$' was added
The 'order/subMerchant/identifier' response's property pattern was added
The 'paymentPlanOffer/id' response's property pattern was changed from '^[0-9a-zA-Z]*$' to '^[0-9a-zA-Z\-_]*$'

Operations

Shopping Options Inquiry

Breaking changes

Api removed without deprecation

Non-Breaking changes

Endpoint added

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

Added the new required 'query' request parameter 'subMerchant.identifier'
Added the new required 'query' request parameter 'subMerchant.identifier'

Non-Breaking changes

Added the new optional 'query' request parameter 'subMerchant'
Added the new optional 'query' request parameter 'subMerchant'
For the 'query' request parameter 'responseControls', the type/format was generalized from 'object'/'' to ''/''
Added the optional property 'subMerchant' to the response
Removed the 'BANAMEX_COSTCO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'BANKAXEPT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'BED_BATH_AND_BEYOND' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARNET' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARTE_BANCAIRE' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CITIBANK_PRIVATE_LABEL_CARD' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO_MEMBER_CREDIT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CRATE_AND_BARREL' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'EBT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'EFTPOS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'ELO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'FARMERS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_JCB' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_MAESTRO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_VISA' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'LASER' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'OTHER' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'PAGOBANCOMAT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'Q_CARD' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'SORIANA' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'TRUE_REWARDS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Added the new optional request property 'subMerchant'
Added the optional property 'subMerchant' to the response
Removed the 'BANAMEX_COSTCO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'BANKAXEPT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'BED_BATH_AND_BEYOND' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARNET' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARTE_BANCAIRE' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CITIBANK_PRIVATE_LABEL_CARD' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO_MEMBER_CREDIT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CRATE_AND_BARREL' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'EBT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'EFTPOS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'ELO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'FARMERS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_JCB' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_MAESTRO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_VISA' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'LASER' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'OTHER' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'PAGOBANCOMAT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'Q_CARD' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'SORIANA' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'TRUE_REWARDS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property

Operations

Search Tokens

Breaking changes

Added the new required 'query' request parameter 'subMerchant.identifier'

Non-Breaking changes

Added the new optional 'query' request parameter 'subMerchant'

April 2022

Version 66

Operations

Retrieve Order

Breaking changes

Removed the optional property 'transaction/items/transaction/transit/aggregationStartDate' from the response
Removed the optional property 'transaction/items/transaction/transit/fareCollection' from the response
Removed the optional property 'transaction/items/transaction/transit/transportationMode' from the response
Added the new 'DIRECT_DEBIT_CANADA' enum value to the 'sourceOfFunds/type' response property
Added the new 'DIRECT_DEBIT_CANADA' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/directDebitCanada' to the response
Added the optional property 'transaction/items/order/dutyAmount' to the response
Added the optional property 'transaction/items/order/shippingAndHandlingTaxAmount' to the response
Added the optional property 'transaction/items/order/shippingAndHandlingTaxRate' to the response
Added the optional property 'transaction/items/order/subMerchant/authentication' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/directDebitCanada' to the response
Added the optional property 'transaction/items/transaction/dutyAmount' to the response
Added the optional property 'transaction/items/transaction/shippingAndHandlingTaxAmount' to the response
Added the optional property 'transaction/items/transaction/shippingAndHandlingTaxRate' to the response
Added the optional property 'transaction/items/transaction/transit/aggregatedFare' to the response
Added the optional property 'transaction/items/transaction/transit/knownFare' to the response

Operations

Breaking changes

Removed the optional property 'transaction/transit/aggregationStartDate' from the response
Removed the optional property 'transaction/transit/fareCollection' from the response
Removed the optional property 'transaction/transit/transportationMode' from the response
Added the new 'DIRECT_DEBIT_CANADA' enum value to the 'sourceOfFunds/type' response property
Removed the request property ' Assess Risk /transaction/transit/aggregationStartDate'
Removed the request property ' Assess Risk /transaction/transit/fareCollection'
Removed the request property ' Assess Risk /transaction/transit/transportationMode'
Removed the request property ' Authorize /transaction/transit/aggregationStartDate'
Removed the request property ' Authorize /transaction/transit/fareCollection'
Removed the request property ' Authorize /transaction/transit/transportationMode'
Removed the request property ' Capture /transaction/transit/aggregationStartDate'
Removed the request property ' Capture /transaction/transit/fareCollection'
Removed the request property ' Capture /transaction/transit/transportationMode'
Removed the optional property ' Retrieve Transaction /transaction/transit/aggregationStartDate' from the response
Removed the optional property ' Retrieve Transaction /transaction/transit/fareCollection' from the response
Removed the optional property ' Retrieve Transaction /transaction/transit/transportationMode' from the response
Added the new 'DIRECT_DEBIT_CANADA' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'order/dutyAmount' to the response
Added the optional property 'order/shippingAndHandlingTaxAmount' to the response
Added the optional property 'order/shippingAndHandlingTaxRate' to the response
Added the optional property 'order/subMerchant/authentication' to the response
Added the optional property 'sourceOfFunds/provided/directDebitCanada' to the response
Added the optional property 'transaction/dutyAmount' to the response
Added the optional property 'transaction/shippingAndHandlingTaxAmount' to the response
Added the optional property 'transaction/shippingAndHandlingTaxRate' to the response
Added the optional property 'transaction/transit/aggregatedFare' to the response
Added the optional property 'transaction/transit/knownFare' to the response
Added the new optional request property ' Refund /sourceOfFunds/provided/directDebitCanada'
Added the new optional request property ' Refund /transaction/dutyAmount'
Added the new optional request property ' Refund /transaction/shippingAndHandlingTaxAmount'
Added the new optional request property ' Refund /transaction/shippingAndHandlingTaxRate'
Added the new optional request property ' Update Authorization /order/dutyAmount'
Added the new optional request property ' Update Authorization /order/shippingAndHandlingTaxAmount'
Added the new optional request property ' Update Authorization /order/shippingAndHandlingTaxRate'
Added the new optional request property ' Verify /order/dutyAmount'
Added the new optional request property ' Verify /order/shippingAndHandlingTaxAmount'
Added the new optional request property ' Verify /order/shippingAndHandlingTaxRate'
Added the new optional request property ' Verify /sourceOfFunds/provided/directDebitCanada'
Added the new optional request property ' Assess Risk /order/dutyAmount'
Added the new optional request property ' Assess Risk /order/shippingAndHandlingTaxAmount'
Added the new optional request property ' Assess Risk /order/shippingAndHandlingTaxRate'
Added the new optional request property ' Assess Risk /transaction/transit/aggregatedFare'
Added the new optional request property ' Assess Risk /transaction/transit/knownFare'
Added the new optional request property ' Authenticate Payer /order/dutyAmount'
Added the new optional request property ' Authenticate Payer /order/shippingAndHandlingTaxAmount'
Added the new optional request property ' Authenticate Payer /order/shippingAndHandlingTaxRate'
Added the new optional request property ' Confirm /order/dutyAmount'
Added the new optional request property ' Confirm /order/shippingAndHandlingTaxAmount'
Added the new optional request property ' Confirm /order/shippingAndHandlingTaxRate'
Added the new optional request property ' Initiate /order/dutyAmount'
Added the new optional request property ' Initiate /order/shippingAndHandlingTaxAmount'
Added the new optional request property ' Initiate /order/shippingAndHandlingTaxRate'
Added the new optional request property ' Authorize /order/dutyAmount'
Added the new optional request property ' Authorize /order/shippingAndHandlingTaxAmount'
Added the new optional request property ' Authorize /order/shippingAndHandlingTaxRate'
Added the new optional request property ' Authorize /transaction/transit/aggregatedFare'
Added the new optional request property ' Authorize /transaction/transit/knownFare'
Added the new optional request property ' Capture /transaction/dutyAmount'
Added the new optional request property ' Capture /transaction/shippingAndHandlingTaxAmount'
Added the new optional request property ' Capture /transaction/shippingAndHandlingTaxRate'
Added the new optional request property ' Capture /transaction/transit/aggregatedFare'
Added the new optional request property ' Capture /transaction/transit/knownFare'
Added the new optional request property ' Pay /order/dutyAmount'
Added the new optional request property ' Pay /order/shippingAndHandlingTaxAmount'
Added the new optional request property ' Pay /order/shippingAndHandlingTaxRate'
Added the new optional request property ' Pay /sourceOfFunds/provided/directDebitCanada'
Added the new optional request property ' Pay /transaction/transit'
Added the new 'DIRECT_DEBIT_CANADA' enum value to the request property ' Refund /sourceOfFunds/type'
Added the new 'DIRECT_DEBIT_CANADA' enum value to the request property ' Verify /sourceOfFunds/type'
Added the new 'DIRECT_DEBIT_CANADA' enum value to the request property ' Pay /sourceOfFunds/type'
Added the optional property ' Retrieve Transaction /order/dutyAmount' to the response
Added the optional property ' Retrieve Transaction /order/shippingAndHandlingTaxAmount' to the response
Added the optional property ' Retrieve Transaction /order/shippingAndHandlingTaxRate' to the response
Added the optional property ' Retrieve Transaction /order/subMerchant/authentication' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/directDebitCanada' to the response
Added the optional property ' Retrieve Transaction /transaction/dutyAmount' to the response
Added the optional property ' Retrieve Transaction /transaction/shippingAndHandlingTaxAmount' to the response
Added the optional property ' Retrieve Transaction /transaction/shippingAndHandlingTaxRate' to the response
Added the optional property ' Retrieve Transaction /transaction/transit/aggregatedFare' to the response
Added the optional property ' Retrieve Transaction /transaction/transit/knownFare' to the response
Added the optional property ' Authenticate Payer /order/dutyAmount' to the response
Added the optional property ' Authenticate Payer /order/shippingAndHandlingTaxAmount' to the response
Added the optional property ' Authenticate Payer /order/shippingAndHandlingTaxRate' to the response

Operations

Payment Options Inquiry

Non-Breaking changes

Added the optional property 'paymentTypes/card/walletProviders/items/secureRemoteCommerce/srcVersion' to the response

Operations

Update Payment Plan Offer

Breaking changes

Removed the optional property 'paymentPlanOffer/accept' from the response
Removed the optional property 'paymentPlanOffer/reject' from the response

Non-Breaking changes

Added the optional property 'response/additionalResponseData' to the response
Added the optional property 'response/providerCode' to the response
Added the optional property 'response/providerMessage' to the response
Added the optional property 'serialNumbers' to the response
The response property 'response' became required
The 'paymentPlanOffer/offerId' response's property pattern was changed from '^[0-9a-zA-Z\-]*$' to '^[0-9a-zA-Z\-_]*$'

Operations

Initiate Checkout

Breaking changes

Removed the request property ' Initiate Checkout /transaction/transit/aggregationStartDate'
Removed the request property ' Initiate Checkout /transaction/transit/fareCollection'
Removed the request property ' Initiate Checkout /transaction/transit/transportationMode'

Non-Breaking changes

Added the new optional request property ' Initiate Checkout /order/dutyAmount'
Added the new optional request property ' Initiate Checkout /order/shippingAndHandlingTaxAmount'
Added the new optional request property ' Initiate Checkout /order/shippingAndHandlingTaxRate'
Added the new optional request property ' Initiate Checkout /order/transactionFiltering'
Added the new optional request property ' Initiate Checkout /transaction/transit/aggregatedFare'
Added the new optional request property ' Initiate Checkout /transaction/transit/knownFare'
Added the optional property ' Initiate Checkout /accountFunding' to the response

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Removed the optional property 'paymentPlanOffer/paymentPlanOfferId' from the response
Removed the optional property 'transaction/transit/aggregationStartDate' from the response
Removed the optional property 'transaction/transit/fareCollection' from the response
Removed the optional property 'transaction/transit/transportationMode' from the response
Added the new 'DIRECT_DEBIT_CANADA' enum value to the 'sourceOfFunds/type' response property
Removed the optional property ' Retrieve Session /paymentPlanOffer/paymentPlanOfferId' from the response
Removed the optional property ' Retrieve Session /transaction/transit/aggregationStartDate' from the response
Removed the optional property ' Retrieve Session /transaction/transit/fareCollection' from the response
Removed the optional property ' Retrieve Session /transaction/transit/transportationMode' from the response
Added the new 'DIRECT_DEBIT_CANADA' enum value to the ' Retrieve Session /sourceOfFunds/type' response property
Removed the request property 'paymentPlanOffer/paymentPlanOfferId'
Removed the request property 'transaction/transit/aggregationStartDate'
Removed the request property 'transaction/transit/fareCollection'
Removed the request property 'transaction/transit/transportationMode'
Removed the optional property 'paymentPlanOffer/paymentPlanOfferId' from the response
Removed the optional property 'transaction/transit/aggregationStartDate' from the response
Removed the optional property 'transaction/transit/fareCollection' from the response
Removed the optional property 'transaction/transit/transportationMode' from the response
Added the new 'DIRECT_DEBIT_CANADA' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'order/dutyAmount' to the response
Added the optional property 'order/shippingAndHandlingTaxAmount' to the response
Added the optional property 'order/shippingAndHandlingTaxRate' to the response
Added the optional property 'paymentPlanOffer/id' to the response
Added the optional property 'sourceOfFunds/provided/directDebitCanada' to the response
Added the optional property 'transaction/dutyAmount' to the response
Added the optional property 'transaction/shippingAndHandlingTaxAmount' to the response
Added the optional property 'transaction/shippingAndHandlingTaxRate' to the response
Added the optional property 'transaction/transit/aggregatedFare' to the response
Added the optional property 'transaction/transit/knownFare' to the response
Added the new optional request property ' Open Wallet /order/dutyAmount'
Added the new optional request property ' Open Wallet /order/shippingAndHandlingTaxAmount'
Added the new optional request property ' Open Wallet /order/shippingAndHandlingTaxRate'
Added the optional property ' Retrieve Session /order/dutyAmount' to the response
Added the optional property ' Retrieve Session /order/shippingAndHandlingTaxAmount' to the response
Added the optional property ' Retrieve Session /order/shippingAndHandlingTaxRate' to the response
Added the optional property ' Retrieve Session /paymentPlanOffer/id' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/directDebitCanada' to the response
Added the optional property ' Retrieve Session /transaction/dutyAmount' to the response
Added the optional property ' Retrieve Session /transaction/shippingAndHandlingTaxAmount' to the response
Added the optional property ' Retrieve Session /transaction/shippingAndHandlingTaxRate' to the response
Added the optional property ' Retrieve Session /transaction/transit/aggregatedFare' to the response
Added the optional property ' Retrieve Session /transaction/transit/knownFare' to the response
Added the new optional request property 'order/dutyAmount'
Added the new optional request property 'order/shippingAndHandlingTaxAmount'
Added the new optional request property 'order/shippingAndHandlingTaxRate'
Added the new optional request property 'paymentPlanOffer/id'
Added the new optional request property 'sourceOfFunds/provided/directDebitCanada'
Added the new optional request property 'transaction/dutyAmount'
Added the new optional request property 'transaction/shippingAndHandlingTaxAmount'
Added the new optional request property 'transaction/shippingAndHandlingTaxRate'
Added the new optional request property 'transaction/transit/aggregatedFare'
Added the new optional request property 'transaction/transit/knownFare'
Added the new 'DIRECT_DEBIT_CANADA' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'order/dutyAmount' to the response
Added the optional property 'order/shippingAndHandlingTaxAmount' to the response
Added the optional property 'order/shippingAndHandlingTaxRate' to the response
Added the optional property 'paymentPlanOffer/id' to the response
Added the optional property 'sourceOfFunds/provided/directDebitCanada' to the response
Added the optional property 'transaction/dutyAmount' to the response
Added the optional property 'transaction/shippingAndHandlingTaxAmount' to the response
Added the optional property 'transaction/shippingAndHandlingTaxRate' to the response
Added the optional property 'transaction/transit/aggregatedFare' to the response
Added the optional property 'transaction/transit/knownFare' to the response

January 2022

Version 65

Operations

Retrieve Order

Breaking changes

Removed the optional property 'accountFunding/recipientAccountFundingMethod' from the response
Removed the optional property 'accountFunding/recipientAccountType' from the response
Removed the optional property 'debtRepayment/paymentRecipient' from the response
Removed the optional property 'transaction/items/accountFunding/recipientAccountFundingMethod' from the response
Removed the optional property 'transaction/items/accountFunding/recipientAccountType' from the response
Removed the optional property 'transaction/items/debtRepayment/paymentRecipient' from the response
Removed the optional property 'transaction/items/response/recurringPaymentAdvice' from the response
Added the new 'ACCOUNT_FUNDING' enum value to the 'purchaseType' response property
Added the new 'ACCOUNT_FUNDING' enum value to the 'transaction/items/order/purchaseType' response property
Added the new 'FASTR_BY_CB' enum value to the 'transaction/items/subgatewayMerchant/authentication/items/protocol' response property
Added the new 'MULTIBANCO' enum value to the 'sourceOfFunds/type' response property
Added the new 'MULTIBANCO' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'accountFunding/recipient' to the response
Added the optional property 'customer/nationalId' to the response
Added the optional property 'debtRepayment/recipient' to the response
Added the optional property 'sourceOfFunds/provided/klarnaPayNow' to the response
Added the optional property 'sourceOfFunds/provided/multibanco' to the response
Added the optional property 'subMerchant/disputeContactPhone' to the response
Added the optional property 'subMerchant/marketplaceId' to the response
Added the optional property 'transaction/items/accountFunding/recipient' to the response
Added the optional property 'transaction/items/authentication/amount' to the response
Added the optional property 'transaction/items/authentication/time' to the response
Added the optional property 'transaction/items/authorizationResponse/authenticationTokenVerificationResultCode' to the response
Added the optional property 'transaction/items/customer/nationalId' to the response
Added the optional property 'transaction/items/debtRepayment/recipient' to the response
Added the optional property 'transaction/items/order/subMerchant/disputeContactPhone' to the response
Added the optional property 'transaction/items/order/subMerchant/marketplaceId' to the response
Added the optional property 'transaction/items/response/authenticationTokenVerification' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/klarnaPayNow' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/multibanco' to the response
Added the required property 'accountFunding/reference' to the response
Added the required property 'sourceOfFunds/provided/trustly/bankAccountCountryCode' to the response
Added the required property 'transaction/items/accountFunding/reference' to the response
Added the required property 'transaction/items/sourceOfFunds/provided/trustly/bankAccountCountryCode' to the response

Operations

Breaking changes

Added the new required request property ' Initiate /sourceOfFunds/provided/trustly/bankAccountCountryCode'
Removed the enum value 'SAVE' of the request property ' Assess Risk /action/tokenOperation'
Removed the optional property 'accountFunding/recipientAccountFundingMethod' from the response
Removed the optional property 'accountFunding/recipientAccountType' from the response
Removed the optional property 'debtRepayment/paymentRecipient' from the response
Removed the optional property 'response/recurringPaymentAdvice' from the response
Added the new 'ACCOUNT_FUNDING' enum value to the 'order/purchaseType' response property
Added the new 'FASTR_BY_CB' enum value to the 'subgatewayMerchant/authentication/items/protocol' response property
Added the new 'MULTIBANCO' enum value to the 'sourceOfFunds/type' response property
Removed the request property ' Refund /accountFunding'
Removed the request property ' Verify /accountFunding/recipientAccountFundingMethod'
Removed the request property ' Verify /accountFunding/recipientAccountType'
Removed the request property ' Verify /debtRepayment/paymentRecipient'
Removed the request property ' Assess Risk /agreement/recurring'
Removed the request property ' Assess Risk /cruise/company/address'
Removed the request property ' Assess Risk /debtRepayment/paymentRecipient'
Removed the request property ' Assess Risk /userId'
Removed the request property ' Authenticate Payer /accountFunding/recipientAccountFundingMethod'
Removed the request property ' Authenticate Payer /accountFunding/recipientAccountType'
Removed the request property ' Authorize /accountFunding/recipientAccountFundingMethod'
Removed the request property ' Authorize /accountFunding/recipientAccountType'
Removed the request property ' Authorize /debtRepayment/paymentRecipient'
Removed the request property ' Capture /accountFunding'
Removed the request property ' Pay /accountFunding/recipientAccountFundingMethod'
Removed the request property ' Pay /accountFunding/recipientAccountType'
Removed the request property ' Pay /debtRepayment/paymentRecipient'
Removed the optional property ' Retrieve Transaction /accountFunding/recipientAccountFundingMethod' from the response
Removed the optional property ' Retrieve Transaction /accountFunding/recipientAccountType' from the response
Removed the optional property ' Retrieve Transaction /debtRepayment/paymentRecipient' from the response
Removed the optional property ' Retrieve Transaction /response/recurringPaymentAdvice' from the response
Removed the optional property ' Authenticate Payer /accountFunding/recipientAccountFundingMethod' from the response
Removed the optional property ' Authenticate Payer /accountFunding/recipientAccountType' from the response
Added the new 'ACCOUNT_FUNDING' enum value to the ' Retrieve Transaction /order/purchaseType' response property
Added the new 'DISBURSED' enum value to the ' Authenticate Payer /order/status' response property
Added the new 'FASTR_BY_CB' enum value to the ' Retrieve Transaction /subgatewayMerchant/authentication/items/protocol' response property
Added the new 'FASTR_BY_CB' enum value to the ' Authenticate Payer /order/subMerchant/authentication/items/protocol' response property
Added the new 'FASTR_BY_CB' enum value to the ' Authenticate Payer /subgatewayMerchant/authentication/items/protocol' response property
Added the new 'FASTR_BY_CB' enum value to the ' Initiate Authentication /order/subMerchant/authentication/items/protocol' response property
Added the new 'FASTR_BY_CB' enum value to the ' Initiate Authentication /subgatewayMerchant/authentication/items/protocol' response property
Added the new 'MULTIBANCO' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the new 'MULTIBANCO' enum value to the ' Initiate Authentication /sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'accountFunding/recipient' to the response
Added the optional property 'authentication/amount' to the response
Added the optional property 'authentication/time' to the response
Added the optional property 'authorizationResponse/authenticationTokenVerificationResultCode' to the response
Added the optional property 'customer/nationalId' to the response
Added the optional property 'debtRepayment/recipient' to the response
Added the optional property 'order/subMerchant/disputeContactPhone' to the response
Added the optional property 'order/subMerchant/marketplaceId' to the response
Added the optional property 'response/authenticationTokenVerification' to the response
Added the optional property 'sourceOfFunds/provided/klarnaPayNow' to the response
Added the optional property 'sourceOfFunds/provided/multibanco' to the response
Added the required property 'accountFunding/reference' to the response
Added the required property 'sourceOfFunds/provided/trustly/bankAccountCountryCode' to the response
Added the new optional request property ' Refund /order/subMerchant/disputeContactPhone'
Added the new optional request property ' Refund /order/subMerchant/marketplaceId'
Added the new optional request property ' Refund /transaction/acquirerResponse'
Added the new optional request property ' Verify /accountFunding/recipient'
Added the new optional request property ' Verify /authentication/amount'
Added the new optional request property ' Verify /authentication/time'
Added the new optional request property ' Verify /debtRepayment/recipient'
Added the new optional request property ' Verify /order/subMerchant/disputeContactPhone'
Added the new optional request property ' Verify /order/subMerchant/marketplaceId'
Added the new optional request property ' Void /transaction/acquirerResponse'
Added the new optional request property ' Assess Risk /accountFunding'
Added the new optional request property ' Assess Risk /agreement/amountVariability'
Added the new optional request property ' Assess Risk /agreement/maximumAmountPerPayment'
Added the new optional request property ' Assess Risk /agreement/minimumDaysBetweenPayments'
Added the new optional request property ' Assess Risk /agreement/numberOfPayments'
Added the new optional request property ' Assess Risk /agreement/paymentFrequency'
Added the new optional request property ' Assess Risk /authentication/3ds2/custom'
Added the new optional request property ' Assess Risk /authentication/amount'
Added the new optional request property ' Assess Risk /authentication/time'
Added the new optional request property ' Assess Risk /cruise/departurePort'
Added the new optional request property ' Assess Risk /customer/account'
Added the new optional request property ' Assess Risk /debtRepayment/recipient'
Added the new optional request property ' Assess Risk /initiator'
Added the new optional request property ' Assess Risk /order/marketplace'
Added the new optional request property ' Assess Risk /order/statementDescriptor/address/stateProvinceCode'
Added the new optional request property ' Assess Risk /order/subMerchant/disputeContactPhone'
Added the new optional request property ' Assess Risk /order/subMerchant/governmentCountryCode'
Added the new optional request property ' Assess Risk /order/subMerchant/marketplaceId'
Added the new optional request property ' Assess Risk /order/transactionFiltering'
Added the new optional request property ' Assess Risk /sourceOfFunds/provided/card/cardType'
Added the new optional request property ' Assess Risk /transaction/acquirerResponse'
Added the new optional request property ' Assess Risk /transaction/deferredAuthorization'
Added the new optional request property ' Authenticate Payer /accountFunding/recipient'
Added the new optional request property ' Authenticate Payer /order/purchaseType'
Added the new optional request property ' Initiate Authentication /order/subMerchant/disputeContactPhone'
Added the new optional request property ' Initiate /sourceOfFunds/provided/klarnaPayNow'
Added the new optional request property ' Authorize /accountFunding/recipient'
Added the new optional request property ' Authorize /authentication/amount'
Added the new optional request property ' Authorize /authentication/time'
Added the new optional request property ' Authorize /customer/account'
Added the new optional request property ' Authorize /debtRepayment/recipient'
Added the new optional request property ' Authorize /order/subMerchant/disputeContactPhone'
Added the new optional request property ' Authorize /order/subMerchant/marketplaceId'
Added the new optional request property ' Capture /authentication/amount'
Added the new optional request property ' Capture /authentication/time'
Added the new optional request property ' Capture /authorizationResponse/authenticationTokenVerificationResultCode'
Added the new optional request property ' Capture /order/subMerchant/disputeContactPhone'
Added the new optional request property ' Capture /order/subMerchant/marketplaceId'
Added the new optional request property ' Capture /transaction/acquirerResponse'
Added the new optional request property ' Pay /accountFunding/recipient'
Added the new optional request property ' Pay /authentication/amount'
Added the new optional request property ' Pay /authentication/time'
Added the new optional request property ' Pay /customer/account'
Added the new optional request property ' Pay /debtRepayment/recipient'
Added the new optional request property ' Pay /order/subMerchant/disputeContactPhone'
Added the new optional request property ' Pay /order/subMerchant/marketplaceId'
Added the new optional request property ' Pay /transaction/acquirerResponse'
The request property ' Assess Risk /paymentPlan/numberOfPayments' became optional
The request property ' Assess Risk /transaction/transit/fareCollection' became optional
The request property ' Assess Risk /transaction/transit/transportationMode' became optional
Added the new 'ACCOUNT_FUNDING' enum value to the request property ' Verify /order/purchaseType'
Added the new 'ACCOUNT_FUNDING' enum value to the request property ' Assess Risk /order/purchaseType'
Added the new 'ACCOUNT_FUNDING' enum value to the request property ' Authorize /order/purchaseType'
Added the new 'ACCOUNT_FUNDING' enum value to the request property ' Pay /order/purchaseType'
Added the new 'CREATE' enum value to the request property ' Assess Risk /action/tokenOperation'
Added the new 'FASTR_BY_CB' enum value to the request property ' Initiate Authentication /order/subMerchant/authentication/items/protocol'
Added the new 'FASTR_BY_CB' enum value to the request property ' Initiate Authentication /subgatewayMerchant/authentication/items/protocol'
Added the new 'MULTIBANCO' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value to the request property ' Assess Risk /order/purchaseType'
Added the optional property ' Retrieve Transaction /accountFunding/recipient' to the response
Added the optional property ' Retrieve Transaction /authentication/amount' to the response
Added the optional property ' Retrieve Transaction /authentication/time' to the response
Added the optional property ' Retrieve Transaction /authorizationResponse/authenticationTokenVerificationResultCode' to the response
Added the optional property ' Retrieve Transaction /customer/nationalId' to the response
Added the optional property ' Retrieve Transaction /debtRepayment/recipient' to the response
Added the optional property ' Retrieve Transaction /order/subMerchant/disputeContactPhone' to the response
Added the optional property ' Retrieve Transaction /order/subMerchant/marketplaceId' to the response
Added the optional property ' Retrieve Transaction /response/authenticationTokenVerification' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/klarnaPayNow' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/multibanco' to the response
Added the optional property ' Authenticate Payer /accountFunding/recipient' to the response
Added the optional property ' Authenticate Payer /authentication/amount' to the response
Added the optional property ' Authenticate Payer /authentication/time' to the response
Added the optional property ' Authenticate Payer /order/subMerchant/disputeContactPhone' to the response
Added the optional property ' Initiate Authentication /order/subMerchant/disputeContactPhone' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/klarnaPayNow' to the response
Added the required property ' Retrieve Transaction /accountFunding/reference' to the response
Added the required property ' Retrieve Transaction /sourceOfFunds/provided/trustly/bankAccountCountryCode' to the response
Added the required property ' Initiate Authentication /sourceOfFunds/provided/trustly/bankAccountCountryCode' to the response

Operations

Payment Options Inquiry

Non-Breaking changes

Added the new enum value 'BANCONTACT' to the 'query' request parameter 'paymentType'
Added the new enum value 'BLIK' to the 'query' request parameter 'paymentType'
Added the new enum value 'KLARNA_PAY_NOW' to the 'query' request parameter 'paymentType'
Added the new enum value 'MULTIBANCO' to the 'query' request parameter 'paymentType'
Added the new enum value 'PRZELEWY24' to the 'query' request parameter 'paymentType'
Added the new enum value 'TRUSTLY' to the 'query' request parameter 'paymentType'
Added the optional property 'paymentTypes/bancontact' to the response
Added the optional property 'paymentTypes/blik' to the response
Added the optional property 'paymentTypes/klarnaPayLater/countries' to the response
Added the optional property 'paymentTypes/klarnaPayNow' to the response
Added the optional property 'paymentTypes/multibanco' to the response
Added the optional property 'paymentTypes/przelewy24' to the response
Added the optional property 'paymentTypes/sofort/countries' to the response
Added the optional property 'paymentTypes/trustly' to the response

Operations

Update Payment Plan Offer

Non-Breaking changes

Endpoint added

Operations

Payment Plan Offers Inquiry

Non-Breaking changes

Endpoint added

Operations

Retrieve Risk Assessment , Create or Update Risk Assessment

Breaking changes

The request property 'order' became required
The request property 'sourceOfFunds' became required
The request property 'transaction' became required
The request property 'transaction/creationDate' became required
The request property 'transaction/source' became required

Non-Breaking changes

Added the new optional request property 'order/walletProvider'
Added the new optional request property 'sourceOfFunds/provided/card/devicePayment'
Added the new optional request property 'sourceOfFunds/provided/card/paymentAccountReference'
Added the new optional request property 'sourceOfFunds/provided/card/storedOnFile'
Added the new 'SCHEME_TOKEN' enum value to the request property 'sourceOfFunds/type'

Operations

Initiate Checkout

Breaking changes

Removed the enum value 'SAVE' of the request property ' Initiate Checkout /action/tokenOperation'
The ' Initiate Checkout /paymentLink/numberOfAllowedAttempts' response property's max was increased from '25.00' to '100.00'
Removed the request property ' Initiate Checkout /accountFunding/recipientAccountFundingMethod'
Removed the request property ' Initiate Checkout /accountFunding/recipientAccountType'
Removed the request property ' Initiate Checkout /debtRepayment/paymentRecipient'
Removed the optional property ' Initiate Checkout /accountFunding' from the response

Non-Breaking changes

Added the new optional request property ' Initiate Checkout /accountFunding/recipient'
Added the new optional request property ' Initiate Checkout /authentication/amount'
Added the new optional request property ' Initiate Checkout /authentication/time'
Added the new optional request property ' Initiate Checkout /customer/account'
Added the new optional request property ' Initiate Checkout /debtRepayment/recipient'
Added the new optional request property ' Initiate Checkout /order/subMerchant/disputeContactPhone'
Added the new optional request property ' Initiate Checkout /order/subMerchant/marketplaceId'
Added the new optional request property ' Initiate Checkout /transaction/acquirerResponse'
Added the new 'ACCOUNT_FUNDING' enum value to the request property ' Initiate Checkout /order/purchaseType'
Added the new 'CREATE' enum value to the request property ' Initiate Checkout /action/tokenOperation'

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Removed the optional property 'accountFunding/recipientAccountFundingMethod' from the response
Removed the optional property 'accountFunding/recipientAccountType' from the response
Removed the optional property 'agreement/recurring' from the response
Removed the optional property 'cruise/company/address' from the response
Removed the optional property 'debtRepayment/paymentRecipient' from the response
Removed the optional property 'userId' from the response
Added the new 'ACCOUNT_FUNDING' enum value to the 'order/purchaseType' response property
Added the new 'BANCONTACT' enum value to the 'paymentType' response property
Added the new 'BLIK' enum value to the 'paymentType' response property
Added the new 'FASTR_BY_CB' enum value to the 'order/subMerchant/authentication/items/protocol' response property
Added the new 'FASTR_BY_CB' enum value to the 'subgatewayMerchant/authentication/items/protocol' response property
Added the new 'KLARNA_PAY_NOW' enum value to the 'paymentType' response property
Added the new 'MULTIBANCO' enum value to the 'paymentType' response property
Added the new 'MULTIBANCO' enum value to the 'sourceOfFunds/type' response property
Added the new 'PRZELEWY24' enum value to the 'paymentType' response property
Added the new 'TRUSTLY' enum value to the 'paymentType' response property
Removed the optional property ' Retrieve Session /accountFunding/recipientAccountFundingMethod' from the response
Removed the optional property ' Retrieve Session /accountFunding/recipientAccountType' from the response
Removed the optional property ' Retrieve Session /agreement/recurring' from the response
Removed the optional property ' Retrieve Session /cruise/company/address' from the response
Removed the optional property ' Retrieve Session /debtRepayment/paymentRecipient' from the response
Removed the optional property ' Retrieve Session /userId' from the response
Added the new 'ACCOUNT_FUNDING' enum value to the ' Retrieve Session /order/purchaseType' response property
Added the new 'BANCONTACT' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'BLIK' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'FASTR_BY_CB' enum value to the ' Retrieve Session /order/subMerchant/authentication/items/protocol' response property
Added the new 'FASTR_BY_CB' enum value to the ' Retrieve Session /subgatewayMerchant/authentication/items/protocol' response property
Added the new 'KLARNA_PAY_NOW' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'MULTIBANCO' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'MULTIBANCO' enum value to the ' Retrieve Session /sourceOfFunds/type' response property
Added the new 'PRZELEWY24' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'TRUSTLY' enum value to the ' Retrieve Session /paymentType' response property
Removed the request property 'accountFunding/recipientAccountFundingMethod'
Removed the request property 'accountFunding/recipientAccountType'
Removed the request property 'agreement/recurring'
Removed the request property 'cruise/company/address'
Removed the request property 'debtRepayment/paymentRecipient'
Removed the request property 'userId'
Removed the optional property 'accountFunding/recipientAccountFundingMethod' from the response
Removed the optional property 'accountFunding/recipientAccountType' from the response
Removed the optional property 'agreement/recurring' from the response
Removed the optional property 'cruise/company/address' from the response
Removed the optional property 'debtRepayment/paymentRecipient' from the response
Removed the optional property 'userId' from the response
Added the new 'ACCOUNT_FUNDING' enum value to the 'order/purchaseType' response property
Added the new 'BANCONTACT' enum value to the 'paymentType' response property
Added the new 'BLIK' enum value to the 'paymentType' response property
Added the new 'FASTR_BY_CB' enum value to the 'order/subMerchant/authentication/items/protocol' response property
Added the new 'FASTR_BY_CB' enum value to the 'subgatewayMerchant/authentication/items/protocol' response property
Added the new 'KLARNA_PAY_NOW' enum value to the 'paymentType' response property
Added the new 'MULTIBANCO' enum value to the 'paymentType' response property
Added the new 'MULTIBANCO' enum value to the 'sourceOfFunds/type' response property
Added the new 'PRZELEWY24' enum value to the 'paymentType' response property
Added the new 'TRUSTLY' enum value to the 'paymentType' response property

Non-Breaking changes

Added the optional property 'accountFunding/recipient' to the response
Added the optional property 'authentication/amount' to the response
Added the optional property 'authentication/time' to the response
Added the optional property 'authorizationResponse/authenticationTokenVerificationResultCode' to the response
Added the optional property 'debtRepayment/recipient' to the response
Added the optional property 'order/item/items/serialNumber' to the response
Added the optional property 'order/items' to the response
Added the optional property 'order/subMerchant/disputeContactPhone' to the response
Added the optional property 'order/subMerchant/marketplaceId' to the response
Added the optional property 'paymentPlanOffer' to the response
Added the optional property 'paymentPlanProductName' to the response
Added the optional property 'sourceOfFunds/provided/klarnaPayNow' to the response
Added the optional property 'sourceOfFunds/provided/trustly/bankAccountCountryCode' to the response
Added the optional property 'transaction/acquirerResponse' to the response
Added the optional property ' Retrieve Session /accountFunding/recipient' to the response
Added the optional property ' Retrieve Session /authentication/amount' to the response
Added the optional property ' Retrieve Session /authentication/time' to the response
Added the optional property ' Retrieve Session /authorizationResponse/authenticationTokenVerificationResultCode' to the response
Added the optional property ' Retrieve Session /debtRepayment/recipient' to the response
Added the optional property ' Retrieve Session /order/item/items/serialNumber' to the response
Added the optional property ' Retrieve Session /order/items' to the response
Added the optional property ' Retrieve Session /order/subMerchant/disputeContactPhone' to the response
Added the optional property ' Retrieve Session /order/subMerchant/marketplaceId' to the response
Added the optional property ' Retrieve Session /paymentPlanOffer' to the response
Added the optional property ' Retrieve Session /paymentPlanProductName' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/klarnaPayNow' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/trustly/bankAccountCountryCode' to the response
Added the optional property ' Retrieve Session /transaction/acquirerResponse' to the response
Added the new optional request property 'accountFunding/recipient'
Added the new optional request property 'authentication/amount'
Added the new optional request property 'authentication/time'
Added the new optional request property 'authorizationResponse/authenticationTokenVerificationResultCode'
Added the new optional request property 'debtRepayment/recipient'
Added the new optional request property 'order/item/items/serialNumber'
Added the new optional request property 'order/items'
Added the new optional request property 'order/subMerchant/disputeContactPhone'
Added the new optional request property 'order/subMerchant/marketplaceId'
Added the new optional request property 'paymentPlanOffer'
Added the new optional request property 'paymentPlanProductName'
Added the new optional request property 'sourceOfFunds/provided/klarnaPayNow'
Added the new optional request property 'sourceOfFunds/provided/trustly/bankAccountCountryCode'
Added the new optional request property 'transaction/acquirerResponse'
Added the new 'ACCOUNT_FUNDING' enum value to the request property 'order/purchaseType'
Added the new 'BANCONTACT' enum value to the request property 'paymentType'
Added the new 'BLIK' enum value to the request property 'paymentType'
Added the new 'FASTR_BY_CB' enum value to the request property 'order/subMerchant/authentication/items/protocol'
Added the new 'FASTR_BY_CB' enum value to the request property 'subgatewayMerchant/authentication/items/protocol'
Added the new 'KLARNA_PAY_NOW' enum value to the request property 'paymentType'
Added the new 'MULTIBANCO' enum value to the request property 'paymentType'
Added the new 'MULTIBANCO' enum value to the request property 'sourceOfFunds/type'
Added the new 'PRZELEWY24' enum value to the request property 'paymentType'
Added the new 'TRUSTLY' enum value to the request property 'paymentType'
Added the optional property 'accountFunding/recipient' to the response
Added the optional property 'authentication/amount' to the response
Added the optional property 'authentication/time' to the response
Added the optional property 'authorizationResponse/authenticationTokenVerificationResultCode' to the response
Added the optional property 'debtRepayment/recipient' to the response
Added the optional property 'order/item/items/serialNumber' to the response
Added the optional property 'order/items' to the response
Added the optional property 'order/subMerchant/disputeContactPhone' to the response
Added the optional property 'order/subMerchant/marketplaceId' to the response
Added the optional property 'paymentPlanOffer' to the response
Added the optional property 'paymentPlanProductName' to the response
Added the optional property 'sourceOfFunds/provided/klarnaPayNow' to the response
Added the optional property 'sourceOfFunds/provided/trustly/bankAccountCountryCode' to the response
Added the optional property 'transaction/acquirerResponse' to the response

Operations

Create or Update Token (with system-generated token)

Breaking changes

Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the 'sourceOfFunds/provided/card/localBrand' response property

November 2021

Version 64

Operations

Create or Update Browser Payment Token

Breaking changes

Removed the enum value 'KLARNA' of the request property 'sourceOfFunds/type'

Non-Breaking changes

Added the new optional request property 'sourceOfFunds/provided/bancontact'
Added the new optional request property 'sourceOfFunds/provided/blik'
Added the new optional request property 'sourceOfFunds/provided/grabPay'
Added the new optional request property 'sourceOfFunds/provided/openBankingBankTransfer'
Added the new optional request property 'sourceOfFunds/provided/przelewy24'
Added the new optional request property 'sourceOfFunds/provided/trustly'
Added the new 'BANCONTACT' enum value to the request property 'sourceOfFunds/type'
Added the new 'BLIK' enum value to the request property 'sourceOfFunds/type'
Added the new 'GRABPAY' enum value to the request property 'sourceOfFunds/type'
Added the new 'KLARNA_FINANCING' enum value to the request property 'sourceOfFunds/type'
Added the new 'KLARNA_PAY_LATER' enum value to the request property 'sourceOfFunds/type'
Added the new 'KLARNA_PAY_NOW' enum value to the request property 'sourceOfFunds/type'
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the request property 'sourceOfFunds/type'
Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the request property 'sourceOfFunds/type'
Added the new 'PRZELEWY24' enum value to the request property 'sourceOfFunds/type'
Added the new 'TRUSTLY' enum value to the request property 'sourceOfFunds/type'

Operations

Retrieve Order

Breaking changes

Added the new 'BANCONTACT' enum value to the 'sourceOfFunds/type' response property
Added the new 'BANCONTACT' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'BLIK' enum value to the 'sourceOfFunds/type' response property
Added the new 'BLIK' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'DO_NOT_PROCEED_ABANDON_ORDER' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'DO_NOT_PROCEED_CONTACT_PAYER' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'NO_ACTION' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'PRZELEWY24' enum value to the 'sourceOfFunds/type' response property
Added the new 'PRZELEWY24' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'RESUBMIT_LATER' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_3DS' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_ALTERNATIVE_PAYMENT_DETAILS' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_UPDATED_PAYMENT_DETAILS' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'REVIEW' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'TRUSTLY' enum value to the 'sourceOfFunds/type' response property
Added the new 'TRUSTLY' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'accountFunding' to the response
Added the optional property 'sourceOfFunds/provided/bancontact' to the response
Added the optional property 'sourceOfFunds/provided/blik' to the response
Added the optional property 'sourceOfFunds/provided/przelewy24' to the response
Added the optional property 'sourceOfFunds/provided/trustly' to the response
Added the optional property 'transaction/items/accountFunding' to the response
Added the optional property 'transaction/items/action/tokenOperation' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/bancontact' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/blik' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/przelewy24' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/trustly' to the response
Removed the 'ATTEMPT_WITH_AUTHENTICATION' enum value from the 'transaction/items/response/gatewayRecommendation' response property

Operations

Breaking changes

Removed the enum value 'SAVE' of the request property ' Authorize /action/tokenOperation'
Removed the enum value 'SAVE' of the request property ' Pay /action/tokenOperation'
Added the new 'BANCONTACT' enum value to the 'sourceOfFunds/type' response property
Added the new 'BLIK' enum value to the 'sourceOfFunds/type' response property
Added the new 'DO_NOT_PROCEED_ABANDON_ORDER' enum value to the 'response/gatewayRecommendation' response property
Added the new 'DO_NOT_PROCEED_CONTACT_PAYER' enum value to the 'response/gatewayRecommendation' response property
Added the new 'NO_ACTION' enum value to the 'response/gatewayRecommendation' response property
Added the new 'PRZELEWY24' enum value to the 'sourceOfFunds/type' response property
Added the new 'RESUBMIT_LATER' enum value to the 'response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_3DS' enum value to the 'response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_ALTERNATIVE_PAYMENT_DETAILS' enum value to the 'response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_UPDATED_PAYMENT_DETAILS' enum value to the 'response/gatewayRecommendation' response property
Added the new 'REVIEW' enum value to the 'response/gatewayRecommendation' response property
Added the new 'TRUSTLY' enum value to the 'sourceOfFunds/type' response property
Added the new 'BANCONTACT' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the new 'BLIK' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the new 'DO_NOT_PROCEED_ABANDON_ORDER' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'DO_NOT_PROCEED_CONTACT_PAYER' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'NO_ACTION' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'PRZELEWY24' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the new 'RESUBMIT_LATER' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_3DS' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_ALTERNATIVE_PAYMENT_DETAILS' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'RESUBMIT_WITH_UPDATED_PAYMENT_DETAILS' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'REVIEW' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'TRUSTLY' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'accountFunding' to the response
Added the optional property 'action/tokenOperation' to the response
Added the optional property 'sourceOfFunds/provided/bancontact' to the response
Added the optional property 'sourceOfFunds/provided/blik' to the response
Added the optional property 'sourceOfFunds/provided/przelewy24' to the response
Added the optional property 'sourceOfFunds/provided/trustly' to the response
Removed the 'ATTEMPT_WITH_AUTHENTICATION' enum value from the 'response/gatewayRecommendation' response property
Added the new optional request property ' Refund /accountFunding'
Added the new optional request property ' Verify /accountFunding'
Added the new optional request property ' Verify /authentication/3ds2/custom'
Added the new optional request property ' Authenticate Payer /accountFunding'
Added the new optional request property ' Authenticate Payer /order/discount'
Added the new optional request property ' Authenticate Payer /order/itemAmount'
Added the new optional request property ' Authenticate Payer /order/netAmount'
Added the new optional request property ' Authenticate Payer /order/shippingAndHandlingAmount'
Added the new optional request property ' Authenticate Payer /order/surchargeAmount'
Added the new optional request property ' Authenticate Payer /order/tax'
Added the new optional request property ' Authenticate Payer /order/taxAmount'
Added the new optional request property ' Initiate /sourceOfFunds/provided/bancontact'
Added the new optional request property ' Initiate /sourceOfFunds/provided/blik'
Added the new optional request property ' Initiate /sourceOfFunds/provided/przelewy24'
Added the new optional request property ' Initiate /sourceOfFunds/provided/trustly'
Added the new optional request property ' Authorize /accountFunding'
Added the new optional request property ' Authorize /transaction/acquirerResponse'
Added the new optional request property ' Capture /accountFunding'
Added the new optional request property ' Pay /accountFunding'
The request property ' Authenticate Payer /order/amount' became optional
The request property ' Authorize /paymentPlan/numberOfPayments' became optional
The request property ' Pay /paymentPlan/numberOfPayments' became optional
Added the new 'BANCONTACT' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'BLIK' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'CREATE' enum value to the request property ' Authorize /action/tokenOperation'
Added the new 'CREATE' enum value to the request property ' Pay /action/tokenOperation'
Added the new 'PRZELEWY24' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'TRUSTLY' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the optional property ' Retrieve Transaction /accountFunding' to the response
Added the optional property ' Retrieve Transaction /action/tokenOperation' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/bancontact' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/blik' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/przelewy24' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/trustly' to the response
Added the optional property ' Authenticate Payer /accountFunding' to the response
Added the optional property ' Authenticate Payer /order/discount' to the response
Added the optional property ' Authenticate Payer /order/itemAmount' to the response
Added the optional property ' Authenticate Payer /order/netAmount' to the response
Added the optional property ' Authenticate Payer /order/shippingAndHandlingAmount' to the response
Added the optional property ' Authenticate Payer /order/surchargeAmount' to the response
Added the optional property ' Authenticate Payer /order/surchargeSource' to the response
Added the optional property ' Authenticate Payer /order/tax' to the response
Added the optional property ' Authenticate Payer /order/taxAmount' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/bancontact' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/blik' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/przelewy24' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/trustly' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/bancontact' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/blik' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/przelewy24' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/trustly' to the response
Removed the 'ATTEMPT_WITH_AUTHENTICATION' enum value from the ' Retrieve Transaction /response/gatewayRecommendation' response property
Removed the 'ATTEMPT_WITH_AUTHENTICATION' enum value from the ' Authenticate Payer /response/gatewayRecommendation' response property
Removed the 'ATTEMPT_WITH_AUTHENTICATION' enum value from the ' Initiate Authentication /response/gatewayRecommendation' response property

Operations

Payment Options Inquiry

Non-Breaking changes

Added the new enum value 'GRABPAY' to the 'query' request parameter 'paymentType'
Added the optional property 'paymentTypes/grabPay' to the response
Removed the 'AMEX' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'AMEX_PURCHASE_CARD' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'BANAMEX_COSTCO' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'CARNET' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'CARTE_BANCAIRE' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'CITIBANK_PRIVATE_LABEL_CARD' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'COSTCO' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'COSTCO_CASH_CARD' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'COSTCO_MEMBER_CREDIT' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'DINERS_CLUB' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'DISCOVER' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'EBT' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'ELO' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'FARMERS_CARD' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'JCB' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'LASER' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'MAESTRO' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'MASTERCARD' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'MASTERCARD_PURCHASE_CARD' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'PRIVATE_LABEL_CARD' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'Q_CARD' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'RUPAY' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'SORIANA' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'TRUE_REWARDS' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'UATP' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'VISA' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'VISA_DEBIT' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'VISA_PURCHASE_CARD' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property
Removed the 'VITAMIN_SHOPPE_GIFT_CARD' enum value from the 'paymentTypes/card/cardTypes/items/cardType' response property

Operations

Retrieve Risk Assessment , Create or Update Risk Assessment

Non-Breaking changes

Added the required property 'id' to the response
Added the required property 'id' to the response

Operations

Initiate Checkout

Breaking changes

The ' Initiate Checkout /paymentLink/numberOfAllowedAttempts' request property's max was decreased to '25.00'

Non-Breaking changes

Added the new optional request property ' Initiate Checkout /accountFunding'
Added the new optional request property ' Initiate Checkout /interaction/tokens'
Added the new optional request property ' Initiate Checkout /order/tax/items/rate'
Added the optional property ' Initiate Checkout /accountFunding' to the response

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Removed the enum value 'SAVE' of the request property 'action/tokenOperation'
Added the new 'BANCONTACT' enum value to the 'sourceOfFunds/type' response property
Added the new 'BLIK' enum value to the 'sourceOfFunds/type' response property
Added the new 'CREATE' enum value to the 'action/tokenOperation' response property
Added the new 'GRABPAY' enum value to the 'paymentType' response property
Added the new 'PRZELEWY24' enum value to the 'sourceOfFunds/type' response property
Added the new 'TRUSTLY' enum value to the 'sourceOfFunds/type' response property
Added the new 'BANCONTACT' enum value to the ' Retrieve Session /sourceOfFunds/type' response property
Added the new 'BLIK' enum value to the ' Retrieve Session /sourceOfFunds/type' response property
Added the new 'CREATE' enum value to the ' Retrieve Session /action/tokenOperation' response property
Added the new 'GRABPAY' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'PRZELEWY24' enum value to the ' Retrieve Session /sourceOfFunds/type' response property
Added the new 'TRUSTLY' enum value to the ' Retrieve Session /sourceOfFunds/type' response property
Added the new 'BANCONTACT' enum value to the 'sourceOfFunds/type' response property
Added the new 'BLIK' enum value to the 'sourceOfFunds/type' response property
Added the new 'CREATE' enum value to the 'action/tokenOperation' response property
Added the new 'GRABPAY' enum value to the 'paymentType' response property
Added the new 'PRZELEWY24' enum value to the 'sourceOfFunds/type' response property
Added the new 'TRUSTLY' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'accountFunding' to the response
Added the optional property 'sourceOfFunds/provided/bancontact' to the response
Added the optional property 'sourceOfFunds/provided/blik' to the response
Added the optional property 'sourceOfFunds/provided/przelewy24' to the response
Added the optional property 'sourceOfFunds/provided/trustly' to the response
Removed the 'SAVE' enum value from the 'action/tokenOperation' response property
Added the optional property ' Retrieve Session /accountFunding' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/bancontact' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/blik' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/przelewy24' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/trustly' to the response
Removed the 'SAVE' enum value from the ' Retrieve Session /action/tokenOperation' response property
Added the new optional request property 'accountFunding'
Added the new optional request property 'sourceOfFunds/provided/bancontact'
Added the new optional request property 'sourceOfFunds/provided/blik'
Added the new optional request property 'sourceOfFunds/provided/przelewy24'
Added the new optional request property 'sourceOfFunds/provided/trustly'
Added the new 'BANCONTACT' enum value to the request property 'sourceOfFunds/type'
Added the new 'BLIK' enum value to the request property 'sourceOfFunds/type'
Added the new 'CREATE' enum value to the request property 'action/tokenOperation'
Added the new 'GRABPAY' enum value to the request property 'paymentType'
Added the new 'PRZELEWY24' enum value to the request property 'sourceOfFunds/type'
Added the new 'TRUSTLY' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'accountFunding' to the response
Added the optional property 'sourceOfFunds/provided/bancontact' to the response
Added the optional property 'sourceOfFunds/provided/blik' to the response
Added the optional property 'sourceOfFunds/provided/przelewy24' to the response
Added the optional property 'sourceOfFunds/provided/trustly' to the response
Removed the 'SAVE' enum value from the 'action/tokenOperation' response property

August 2021

Version 63

Operations

Retrieve Authentication Configuration

Non-Breaking changes

Endpoint added

Operations

Delete Payment Link

Non-Breaking changes

Endpoint added

Operations

Retrieve Order

Breaking changes

Removed the optional property 'transaction/items/cruise/company/address' from the response
Added the new 'AGENT' enum value to the 'transaction/items/initiator/entity/type' response property
Added the new 'CHECKOUT_VIA_PAYMENT_LINK' enum value to the 'transaction/items/gatewayEntryPoint' response property
Added the new 'CHECKOUT_VIA_WEBSITE' enum value to the 'transaction/items/gatewayEntryPoint' response property
Added the new 'GATEWAY' enum value to the 'transaction/items/initiator/entity/type' response property
Added the new 'KLARNA_PAY_NOW' enum value to the 'sourceOfFunds/type' response property
Added the new 'KLARNA_PAY_NOW' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value to the 'purchaseType' response property
Added the new 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value to the 'transaction/items/order/purchaseType' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'transaction/items/initiator/entity/type' response property

Non-Breaking changes

Added the optional property 'paymentPlan/receiptText' to the response
Added the optional property 'subMerchant/address/stateProvinceCode' to the response
Added the optional property 'subMerchant/governmentCountryCode' to the response
Added the optional property 'transaction/items/authentication/3ds2/3dsServerTransactionId' to the response
Added the optional property 'transaction/items/authentication/3ds2/custom' to the response
Added the optional property 'transaction/items/authentication/3ds2/sdk/challengeCompletionCallbackUrl' to the response
Added the optional property 'transaction/items/cruise/departurePort' to the response
Added the optional property 'transaction/items/order/subMerchant/address/stateProvinceCode' to the response
Added the optional property 'transaction/items/order/subMerchant/governmentCountryCode' to the response
Added the optional property 'transaction/items/paymentPlan/receiptText' to the response
The response property 'subMerchant/identifier' became required
The response property 'subMerchant/tradingName' became required
The response property 'transaction/items/order/subMerchant/identifier' became required
The response property 'transaction/items/order/subMerchant/tradingName' became required
Removed the 'CHECKOUT' enum value from the 'transaction/items/gatewayEntryPoint' response property

Operations

Breaking changes

Removed the optional property 'cruise/company/address' from the response
Added the new 'AGENT' enum value to the 'initiator/entity/type' response property
Added the new 'CHECKOUT_VIA_PAYMENT_LINK' enum value to the 'gatewayEntryPoint' response property
Added the new 'CHECKOUT_VIA_WEBSITE' enum value to the 'gatewayEntryPoint' response property
Added the new 'GATEWAY' enum value to the 'initiator/entity/type' response property
Added the new 'KLARNA_PAY_NOW' enum value to the 'sourceOfFunds/type' response property
Added the new 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value to the 'order/purchaseType' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'initiator/entity/type' response property
Removed the request property ' Refund /cruise/company/address'
Removed the request property ' Authorize /cruise/company/address'
Removed the request property ' Capture /cruise/company/address'
Removed the request property ' Pay /cruise/company/address'
Removed the optional property ' Retrieve Transaction /cruise/company/address' from the response
Added the new 'AGENT' enum value to the ' Retrieve Transaction /initiator/entity/type' response property
Added the new 'CHECKOUT_VIA_PAYMENT_LINK' enum value to the ' Retrieve Transaction /gatewayEntryPoint' response property
Added the new 'CHECKOUT_VIA_WEBSITE' enum value to the ' Retrieve Transaction /gatewayEntryPoint' response property
Added the new 'GATEWAY' enum value to the ' Retrieve Transaction /initiator/entity/type' response property
Added the new 'KLARNA_PAY_NOW' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the new 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value to the ' Retrieve Transaction /order/purchaseType' response property
Added the new 'SERVICE_PROVIDER' enum value to the ' Retrieve Transaction /initiator/entity/type' response property

Non-Breaking changes

Added the optional property 'authentication/3ds2/3dsServerTransactionId' to the response
Added the optional property 'authentication/3ds2/custom' to the response
Added the optional property 'authentication/3ds2/sdk/challengeCompletionCallbackUrl' to the response
Added the optional property 'cruise/departurePort' to the response
Added the optional property 'order/subMerchant/address/stateProvinceCode' to the response
Added the optional property 'order/subMerchant/governmentCountryCode' to the response
Added the optional property 'paymentPlan/receiptText' to the response
The response property 'order/subMerchant/identifier' became required
The response property 'order/subMerchant/tradingName' became required
Removed the 'CHECKOUT' enum value from the 'gatewayEntryPoint' response property
Added the new optional request property ' Refund /cruise/departurePort'
Added the new optional request property ' Refund /order/subMerchant/governmentCountryCode'
Added the new optional request property ' Verify /order/subMerchant/governmentCountryCode'
Added the new optional request property ' Authorize /authentication/3ds2/custom'
Added the new optional request property ' Authorize /cruise/departurePort'
Added the new optional request property ' Authorize /order/subMerchant/governmentCountryCode'
Added the new optional request property ' Capture /authentication/3ds2/custom'
Added the new optional request property ' Capture /cruise/departurePort'
Added the new optional request property ' Capture /order/subMerchant/governmentCountryCode'
Added the new optional request property ' Disbursement /initiator'
Added the new optional request property ' Pay /authentication/3ds2/custom'
Added the new optional request property ' Pay /cruise/departurePort'
Added the new optional request property ' Pay /order/subMerchant/governmentCountryCode'
Added the new 'KLARNA_PAY_NOW' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value to the request property ' Verify /order/purchaseType'
Added the new 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value to the request property ' Authorize /order/purchaseType'
Added the new 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value to the request property ' Pay /order/purchaseType'
Added the optional property ' Retrieve Transaction /authentication/3ds2/3dsServerTransactionId' to the response
Added the optional property ' Retrieve Transaction /authentication/3ds2/custom' to the response
Added the optional property ' Retrieve Transaction /authentication/3ds2/sdk/challengeCompletionCallbackUrl' to the response
Added the optional property ' Retrieve Transaction /cruise/departurePort' to the response
Added the optional property ' Retrieve Transaction /order/subMerchant/address/stateProvinceCode' to the response
Added the optional property ' Retrieve Transaction /order/subMerchant/governmentCountryCode' to the response
Added the optional property ' Retrieve Transaction /paymentPlan/receiptText' to the response
Added the optional property ' Authenticate Payer /authentication/3ds2/custom' to the response
The response property ' Retrieve Transaction /order/subMerchant/identifier' became required
The response property ' Retrieve Transaction /order/subMerchant/tradingName' became required
Removed the 'CHECKOUT' enum value from the ' Retrieve Transaction /gatewayEntryPoint' response property

Operations

Payment Options Inquiry

Breaking changes

Removed the enum value 'CHECKOUT' from the 'query' request parameter 'gatewayEntryPoint'
The response property 'paymentTypes/openBankingBankTransfer/aspsp' became optional
The 'paymentTypes/openBankingBankTransfer/aspsp' response's property type/format changed from 'array'/'' to 'object'/''
Added the new 'CHECKOUT_VIA_PAYMENT_LINK' enum value to the 'gatewayEntryPoint' response property
Added the new 'CHECKOUT_VIA_WEBSITE' enum value to the 'gatewayEntryPoint' response property

Non-Breaking changes

Added the new enum value 'CHECKOUT_VIA_PAYMENT_LINK' to the 'query' request parameter 'gatewayEntryPoint'
Added the new enum value 'CHECKOUT_VIA_WEBSITE' to the 'query' request parameter 'gatewayEntryPoint'
Added the optional property 'paymentTypes/openBankingBankTransfer/aspsp/other' to the response
Added the optional property 'paymentTypes/openBankingBankTransfer/aspsp/preferred' to the response
Removed the 'CHECKOUT' enum value from the 'gatewayEntryPoint' response property

Operations

Retrieve Risk Assessment , Create or Update Risk Assessment

Non-Breaking changes

Endpoint added

Operations

Initiate Checkout , Create Session

Breaking changes

Removed ' create_checkout_session_request' from the request body 'oneOf' list
Added ' initiate_checkout_response' to the response body 'oneOf' list

Non-Breaking changes

Api operation id 'Session: Create Checkout Session OR Session: Create Session' removed and replaced with 'Hosted Checkout: Initiate Checkout OR Session: Create Session'
Api tag 'Hosted Checkout' added
Added ' initiate_checkout_request' to the request body 'oneOf' list
Removed ' create_checkout_session_response' from the response body 'oneOf' list

Operations

Create SRC Enrollment Card Object , Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Added '#/components/schemas/retrieve_session_response, create_src_enrollment_card_object_response' to the response body 'oneOf' list
Removed the required property 'merchant' from the response
Removed the required property 'session' from the response
Removed the enum value 'CHECKOUT' of the request property 'gatewayEntryPoint'
Added the new 'CHECKOUT_VIA_PAYMENT_LINK' enum value to the 'gatewayEntryPoint' response property
Added the new 'CHECKOUT_VIA_WEBSITE' enum value to the 'gatewayEntryPoint' response property
Added the new 'KLARNA_PAY_NOW' enum value to the 'sourceOfFunds/type' response property
Added the new 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value to the 'order/purchaseType' response property
Removed the optional property '3DSecure' from the response
Removed the optional property '3DSecureId' from the response
Removed the optional property 'action' from the response
Removed the optional property 'agreement' from the response
Removed the optional property 'airline' from the response
Removed the optional property 'authResponseUpdateAction' from the response
Removed the optional property 'authentication' from the response
Removed the optional property 'authorizationResponse' from the response
Removed the optional property 'billing' from the response
Removed the optional property 'browserPayment' from the response
Removed the optional property 'constraints' from the response
Removed the optional property 'correlationId' from the response
Removed the optional property 'creditCardBillPayment' from the response
Removed the optional property 'cruise' from the response
Removed the optional property 'currencyConversion' from the response
Removed the optional property 'customer' from the response
Removed the optional property 'debtRepayment' from the response
Removed the optional property 'device' from the response
Removed the optional property 'disbursementType' from the response
Removed the optional property 'externalTokenProvider' from the response
Removed the optional property 'gatewayEntryPoint' from the response
Removed the optional property 'initiator' from the response
Removed the optional property 'lineOfBusiness' from the response
Removed the optional property 'locale' from the response
Removed the optional property 'order' from the response
Removed the optional property 'partnerSolutionId' from the response
Removed the optional property 'paymentPlan' from the response
Removed the optional property 'paymentType' from the response
Removed the optional property 'posTerminal' from the response
Removed the optional property 'responseControls' from the response
Removed the optional property 'risk' from the response
Removed the optional property 'shipping' from the response
Removed the optional property 'sourceOfFunds' from the response
Removed the optional property 'subgatewayMerchant' from the response
Removed the optional property 'token' from the response
Removed the optional property 'transaction' from the response
Removed the optional property 'transactionSource' from the response
Removed the optional property 'userId' from the response
Removed the optional property 'verificationStrategy' from the response
Removed the optional property 'wallet' from the response
Added the new 'CHECKOUT_VIA_PAYMENT_LINK' enum value to the 'gatewayEntryPoint' response property
Added the new 'CHECKOUT_VIA_WEBSITE' enum value to the 'gatewayEntryPoint' response property
Added the new 'KLARNA_PAY_NOW' enum value to the 'sourceOfFunds/type' response property
Added the new 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value to the 'order/purchaseType' response property

Non-Breaking changes

Added the optional property 'authentication/3ds2/custom' to the response
Added the optional property 'cardBin' to the response
Added the optional property 'cruise/departurePort' to the response
Added the optional property 'currency' to the response
Added the optional property 'order/subMerchant/governmentCountryCode' to the response
Removed the 'CHECKOUT' enum value from the 'gatewayEntryPoint' response property
Api operation id 'Wallet: Open Wallet OR Wallet: Update Session From Wallet' removed and replaced with 'Wallet: Create SRC Enrollment Card Object OR Wallet: Open Wallet OR Wallet: Update Session From Wallet'
Added ' create_src_enrollment_card_object_request' to the request body 'oneOf' list
Added the new optional request property 'authentication/3ds2/custom'
Added the new optional request property 'cardBin'
Added the new optional request property 'cruise/departurePort'
Added the new optional request property 'currency'
Added the new optional request property 'order/subMerchant/governmentCountryCode'
Added the new 'CHECKOUT_VIA_PAYMENT_LINK' enum value to the request property 'gatewayEntryPoint'
Added the new 'CHECKOUT_VIA_WEBSITE' enum value to the request property 'gatewayEntryPoint'
Added the new 'KLARNA_PAY_NOW' enum value to the request property 'sourceOfFunds/type'
Added the new 'PREPAID_PAYMENT_INSTRUMENT_LOADING' enum value to the request property 'order/purchaseType'
Added the optional property 'authentication/3ds2/custom' to the response
Added the optional property 'cardBin' to the response
Added the optional property 'cruise/departurePort' to the response
Added the optional property 'currency' to the response
Added the optional property 'order/subMerchant/governmentCountryCode' to the response
Removed the 'CHECKOUT' enum value from the 'gatewayEntryPoint' response property

May 2021

Version 62

Operations

Retrieve Order

Breaking changes

Removed the optional property 'transaction/items/userId' from the response
Added the new 'DISBURSED' enum value to the 'status' response property
Added the new 'DISBURSED' enum value to the 'transaction/items/order/status' response property
Added the new 'DISBURSEMENT' enum value to the 'transaction/items/transaction/type' response property
Added the new 'GRABPAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'GRABPAY' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'MERCHANT_MANAGER' enum value to the 'transaction/items/gatewayEntryPoint' response property

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/grabPay' to the response
Added the optional property 'sourceOfFunds/provided/moMoPay' to the response
Added the optional property 'transaction/items/browserPayment/paypal/accountId' to the response
Added the optional property 'transaction/items/initiator' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/grabPay' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/moMoPay' to the response
Added the optional property 'transaction/items/transaction/deferredAuthorization' to the response
Added the optional property 'transaction/items/transaction/disbursementType' to the response
Added the optional property 'transaction/items/transaction/instantRefund' to the response
Removed the 'BANAMEX_COSTCO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'BANAMEX_COSTCO' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'BANKAXEPT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'BANKAXEPT' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'BED_BATH_AND_BEYOND' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'BED_BATH_AND_BEYOND' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARNET' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARNET' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARTE_BANCAIRE' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARTE_BANCAIRE' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'CITIBANK_PRIVATE_LABEL_CARD' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CITIBANK_PRIVATE_LABEL_CARD' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO_MEMBER_CREDIT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO_MEMBER_CREDIT' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'CRATE_AND_BARREL' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CRATE_AND_BARREL' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'EBT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'EBT' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'EFTPOS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'EFTPOS' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'ELO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'ELO' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'FARMERS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'FARMERS' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_JCB' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_JCB' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_MAESTRO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_MAESTRO' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_VISA' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_VISA' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'LASER' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'LASER' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'OTHER' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'OTHER' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'PAGOBANCOMAT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'PAGOBANCOMAT' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'Q_CARD' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'Q_CARD' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'SORIANA' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'SORIANA' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Removed the 'TRUE_REWARDS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'TRUE_REWARDS' enum value from the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Added the required property 'totalDisbursedAmount' to the response
Added the required property 'transaction/items/order/totalDisbursedAmount' to the response

Operations

Breaking changes

Removed the optional property 'userId' from the response
Added the new 'DISBURSED' enum value to the 'order/status' response property
Added the new 'DISBURSEMENT' enum value to the 'transaction/type' response property
Added the new 'GRABPAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'MERCHANT_MANAGER' enum value to the 'gatewayEntryPoint' response property
Removed the request property ' Refund /userId'
Removed the request property ' Update Authorization /userId'
Removed the request property ' Verify /userId'
Removed the request property ' Void /userId'
Removed the request property ' Authorize /userId'
Removed the request property ' Capture /userId'
Removed the request property ' Pay /userId'
Removed the request property ' Referral /userId'
Removed the optional property ' Retrieve Transaction /userId' from the response
Added the new 'DISBURSED' enum value to the ' Retrieve Transaction /order/status' response property
Added the new 'DISBURSED' enum value to the ' Initiate Authentication /order/status' response property
Added the new 'DISBURSEMENT' enum value to the ' Retrieve Transaction /transaction/type' response property
Added the new 'DISBURSEMENT' enum value to the ' Authenticate Payer /transaction/type' response property
Added the new 'DISBURSEMENT' enum value to the ' Initiate Authentication /transaction/type' response property
Added the new 'GRABPAY' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the new 'MERCHANT_MANAGER' enum value to the ' Retrieve Transaction /gatewayEntryPoint' response property

Non-Breaking changes

Added the optional property 'browserPayment/paypal/accountId' to the response
Added the optional property 'initiator' to the response
Added the optional property 'sourceOfFunds/provided/grabPay' to the response
Added the optional property 'sourceOfFunds/provided/moMoPay' to the response
Added the optional property 'transaction/deferredAuthorization' to the response
Added the optional property 'transaction/disbursementType' to the response
Added the optional property 'transaction/instantRefund' to the response
Removed the 'BANAMEX_COSTCO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'BANKAXEPT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'BED_BATH_AND_BEYOND' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARNET' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARTE_BANCAIRE' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CITIBANK_PRIVATE_LABEL_CARD' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO_MEMBER_CREDIT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'CRATE_AND_BARREL' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'EBT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'EFTPOS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'ELO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'FARMERS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_JCB' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_MAESTRO' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_VISA' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'LASER' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'OTHER' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'PAGOBANCOMAT' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'Q_CARD' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'SORIANA' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Removed the 'TRUE_REWARDS' enum value from the 'sourceOfFunds/provided/card/localBrand' response property
Added the required property 'order/totalDisbursedAmount' to the response
Api operation id 'Authentication: Authenticate Payer OR Authentication: Initiate Authentication OR Browser Payment: Confirm OR Browser Payment: Initiate OR Browser Payment: Update OR Transaction: Authorize OR Transaction: Capture OR Transaction: Pay OR Transaction: Referral OR Transaction: Refund OR Transaction: Update Authorization OR Transaction: Verify OR Transaction: Void OR Transaction: Assess Risk' removed and replaced with 'Authentication: Authenticate Payer OR Authentication: Initiate Authentication OR Browser Payment: Confirm OR Browser Payment: Initiate OR Browser Payment: Update OR Transaction: Authorize OR Transaction: Capture OR Transaction: Disbursement OR Transaction: Pay OR Transaction: Referral OR Transaction: Refund OR Transaction: Update Authorization OR Transaction: Verify OR Transaction: Void OR Transaction: Assess Risk'
Added the new optional request property ' Refund /initiator'
Added the new optional request property ' Update Authorization /initiator'
Added the new optional request property ' Verify /initiator'
Added the new optional request property ' Void /initiator'
Added the new optional request property ' Initiate Authentication /sourceOfFunds/provided/card/cardType'
Added the new optional request property ' Initiate Authentication /sourceOfFunds/provided/card/expiry'
Added the new optional request property ' Initiate /sourceOfFunds/provided/grabPay'
Added the new optional request property ' Authorize /initiator'
Added the new optional request property ' Authorize /transaction/deferredAuthorization'
Added the new optional request property ' Capture /initiator'
Added the new optional request property ' Capture /transaction/deferredAuthorization'
Added the new optional request property ' Pay /initiator'
Added the new optional request property ' Pay /sourceOfFunds/provided/moMoPay'
Added the new optional request property ' Pay /transaction/deferredAuthorization'
Added the new optional request property ' Referral /initiator'
Added ' disbursement_request' to the request body 'oneOf' list
Added the new 'GRABPAY' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the optional property ' Retrieve Transaction /browserPayment/paypal/accountId' to the response
Added the optional property ' Retrieve Transaction /initiator' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/grabPay' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/moMoPay' to the response
Added the optional property ' Retrieve Transaction /transaction/deferredAuthorization' to the response
Added the optional property ' Retrieve Transaction /transaction/disbursementType' to the response
Added the optional property ' Retrieve Transaction /transaction/instantRefund' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/card/cardType' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/grabPay' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/moMoPay' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/card/cardType' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/grabPay' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/moMoPay' to the response
Removed the 'BANAMEX_COSTCO' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'BANAMEX_COSTCO' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'BANAMEX_COSTCO' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'BANKAXEPT' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'BANKAXEPT' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'BANKAXEPT' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'BED_BATH_AND_BEYOND' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'BED_BATH_AND_BEYOND' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'BED_BATH_AND_BEYOND' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARNET' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARNET' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARNET' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARTE_BANCAIRE' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARTE_BANCAIRE' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'CARTE_BANCAIRE' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'CITIBANK_PRIVATE_LABEL_CARD' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'CITIBANK_PRIVATE_LABEL_CARD' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'CITIBANK_PRIVATE_LABEL_CARD' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO_MEMBER_CREDIT' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO_MEMBER_CREDIT' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'COSTCO_MEMBER_CREDIT' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'CRATE_AND_BARREL' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'CRATE_AND_BARREL' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'CRATE_AND_BARREL' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'EBT' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'EBT' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'EBT' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'EFTPOS' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'EFTPOS' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'EFTPOS' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'ELO' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'ELO' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'ELO' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'FARMERS' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'FARMERS' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'FARMERS' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_JCB' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_JCB' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_JCB' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_MAESTRO' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_MAESTRO' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_MAESTRO' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_VISA' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_VISA' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'GIROCARD_VISA' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'LASER' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'LASER' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'LASER' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'OTHER' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'OTHER' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'OTHER' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'PAGOBANCOMAT' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'PAGOBANCOMAT' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'PAGOBANCOMAT' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'Q_CARD' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'Q_CARD' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'Q_CARD' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'SORIANA' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'SORIANA' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'SORIANA' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Removed the 'TRUE_REWARDS' enum value from the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Removed the 'TRUE_REWARDS' enum value from the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Removed the 'TRUE_REWARDS' enum value from the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Added the required property ' Retrieve Transaction /order/totalDisbursedAmount' to the response

Operations

Payment Options Inquiry

Breaking changes

Removed the optional property 'paymentTypes/klarna' from the response
Added the new 'MERCHANT_MANAGER' enum value to the 'gatewayEntryPoint' response property

Non-Breaking changes

Added the new enum value 'KLARNA_FINANCING' to the 'query' request parameter 'paymentType'
Added the new enum value 'KLARNA_PAY_LATER' to the 'query' request parameter 'paymentType'
Added the new enum value 'MERCHANT_MANAGER' to the 'query' request parameter 'gatewayEntryPoint'
Added the optional property 'paymentTypes/klarnaFinancing' to the response
Added the optional property 'paymentTypes/klarnaPayLater' to the response
Added the optional property 'paymentTypes/moMoPay' to the response
Added the required property 'paymentTypes/paypal/accountId' to the response

Operations

Create Checkout Session

Breaking changes

Removed the request property ' Create Checkout Session /interaction/googleAnalytics'
Removed the request property ' Create Checkout Session /userId'

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /initiator'
Added the new optional request property ' Create Checkout Session /transaction/deferredAuthorization'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Added the new 'GRABPAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'KLARNA_FINANCING' enum value to the 'paymentType' response property
Added the new 'KLARNA_PAY_LATER' enum value to the 'paymentType' response property
Added the new 'MERCHANT_MANAGER' enum value to the 'gatewayEntryPoint' response property
Added the new 'GRABPAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'KLARNA_FINANCING' enum value to the 'paymentType' response property
Added the new 'KLARNA_PAY_LATER' enum value to the 'paymentType' response property
Added the new 'MERCHANT_MANAGER' enum value to the 'gatewayEntryPoint' response property
Added the new 'GRABPAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'KLARNA_FINANCING' enum value to the 'paymentType' response property
Added the new 'KLARNA_PAY_LATER' enum value to the 'paymentType' response property
Added the new 'MERCHANT_MANAGER' enum value to the 'gatewayEntryPoint' response property

Non-Breaking changes

Added the optional property 'creditCardBillPayment' to the response
Added the optional property 'disbursementType' to the response
Added the optional property 'initiator' to the response
Added the optional property 'sourceOfFunds/provided/grabPay' to the response
Added the optional property 'sourceOfFunds/provided/moMoPay' to the response
Added the optional property 'transaction/deferredAuthorization' to the response
Added the optional property 'creditCardBillPayment' to the response
Added the optional property 'disbursementType' to the response
Added the optional property 'initiator' to the response
Added the optional property 'sourceOfFunds/provided/grabPay' to the response
Added the optional property 'sourceOfFunds/provided/moMoPay' to the response
Added the optional property 'transaction/deferredAuthorization' to the response
Added the new optional request property 'creditCardBillPayment'
Added the new optional request property 'disbursementType'
Added the new optional request property 'initiator'
Added the new optional request property 'sourceOfFunds/provided/grabPay'
Added the new optional request property 'sourceOfFunds/provided/moMoPay'
Added the new optional request property 'transaction/deferredAuthorization'
Added the new 'GRABPAY' enum value to the request property 'sourceOfFunds/type'
Added the new 'KLARNA_FINANCING' enum value to the request property 'paymentType'
Added the new 'KLARNA_PAY_LATER' enum value to the request property 'paymentType'
Added the new 'MERCHANT_MANAGER' enum value to the request property 'gatewayEntryPoint'
Added the optional property 'creditCardBillPayment' to the response
Added the optional property 'disbursementType' to the response
Added the optional property 'initiator' to the response
Added the optional property 'sourceOfFunds/provided/grabPay' to the response
Added the optional property 'sourceOfFunds/provided/moMoPay' to the response
Added the optional property 'transaction/deferredAuthorization' to the response

February 2021

Version 61

Operations

Close Batch

Non-Breaking changes

Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the request property 'acquirer/cardType'

Operations

Retrieve Order

Breaking changes

The response property 'transaction/items/transaction/transit/fareCollection' became optional
The response property 'transaction/items/transaction/transit/transportationMode' became optional
Removed the required property 'transaction/items/subgatewayMerchant/address/state' from the response
Removed the optional property 'agreement/recurring' from the response
Removed the optional property 'transaction/items/agreement/recurring' from the response
Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the 'sourceOfFunds/provided/card/localBrand' response property
Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Added the new 'KLARNA_FINANCING' enum value to the 'sourceOfFunds/type' response property
Added the new 'KLARNA_FINANCING' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'KLARNA_PAY_LATER' enum value to the 'sourceOfFunds/type' response property
Added the new 'KLARNA_PAY_LATER' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'REFRESH_AUTHENTICATION' enum value to the 'transaction/items/authentication/purpose' response property

Non-Breaking changes

Added the optional property 'agreement/amountVariability' to the response
Added the optional property 'agreement/maximumAmountPerPayment' to the response
Added the optional property 'agreement/minimumDaysBetweenPayments' to the response
Added the optional property 'agreement/numberOfPayments' to the response
Added the optional property 'agreement/paymentFrequency' to the response
Added the optional property 'transaction/items/agreement/amountVariability' to the response
Added the optional property 'transaction/items/agreement/maximumAmountPerPayment' to the response
Added the optional property 'transaction/items/agreement/minimumDaysBetweenPayments' to the response
Added the optional property 'transaction/items/agreement/numberOfPayments' to the response
Added the optional property 'transaction/items/agreement/paymentFrequency' to the response
Added the optional property 'transaction/items/subgatewayMerchant/acquirer/items/amexSafeKey' to the response
Removed the 'KLARNA' enum value from the 'sourceOfFunds/type' response property
Removed the 'KLARNA' enum value from the 'transaction/items/sourceOfFunds/type' response property
Added the required property 'transaction/items/subgatewayMerchant/address/stateProvince' to the response

Operations

Retrieve Transaction , Authenticate Payer , Initiate Authentication , Confirm , Initiate , Update , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void , Assess Risk

Breaking changes

The response property 'transaction/transit/fareCollection' became optional
The response property 'transaction/transit/transportationMode' became optional
Removed the required property 'subgatewayMerchant/address/state' from the response
Added the new required request property ' Initiate Authentication /subgatewayMerchant/address/stateProvince'
Removed the enum value 'KLARNA' of the request property ' Initiate /sourceOfFunds/type'
The response property ' Retrieve Transaction /transaction/transit/fareCollection' became optional
The response property ' Retrieve Transaction /transaction/transit/transportationMode' became optional
The response property ' Authenticate Payer /customer/account/id' became optional
Removed the required property ' Retrieve Transaction /subgatewayMerchant/address/state' from the response
Removed the required property ' Authenticate Payer /subgatewayMerchant/address/state' from the response
Removed the required property ' Initiate Authentication /subgatewayMerchant/address/state' from the response
Removed the optional property 'agreement/recurring' from the response
Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the 'sourceOfFunds/provided/card/localBrand' response property
Added the new 'KLARNA_FINANCING' enum value to the 'sourceOfFunds/type' response property
Added the new 'KLARNA_PAY_LATER' enum value to the 'sourceOfFunds/type' response property
Added the new 'REFRESH_AUTHENTICATION' enum value to the 'authentication/purpose' response property
Removed the request property ' Refund /agreement/recurring'
Removed the request property ' Verify /agreement/recurring'
Removed the request property ' Authenticate Payer /agreement/recurring'
Removed the request property ' Initiate Authentication /subgatewayMerchant/address/state'
Removed the request property ' Confirm /agreement/recurring'
Removed the request property ' Initiate /agreement/recurring'
Removed the request property ' Authorize /agreement/recurring'
Removed the request property ' Capture /agreement/recurring'
Removed the request property ' Pay /agreement/recurring'
Removed the optional property ' Retrieve Transaction /agreement/recurring' from the response
Removed the optional property ' Authenticate Payer /agreement/recurring' from the response
Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the ' Retrieve Transaction /sourceOfFunds/provided/card/localBrand' response property
Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the ' Authenticate Payer /sourceOfFunds/provided/card/localBrand' response property
Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the ' Initiate Authentication /sourceOfFunds/provided/card/localBrand' response property
Added the new 'KLARNA_FINANCING' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the new 'KLARNA_PAY_LATER' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the new 'REFRESH_AUTHENTICATION' enum value to the ' Retrieve Transaction /authentication/purpose' response property
Added the new 'REFRESH_AUTHENTICATION' enum value to the ' Initiate Authentication /authentication/purpose' response property

Non-Breaking changes

Added the optional property 'agreement/amountVariability' to the response
Added the optional property 'agreement/maximumAmountPerPayment' to the response
Added the optional property 'agreement/minimumDaysBetweenPayments' to the response
Added the optional property 'agreement/numberOfPayments' to the response
Added the optional property 'agreement/paymentFrequency' to the response
Added the optional property 'subgatewayMerchant/acquirer/items/amexSafeKey' to the response
Removed the 'KLARNA' enum value from the 'sourceOfFunds/type' response property
Added the required property 'subgatewayMerchant/address/stateProvince' to the response
Added the new optional request property ' Refund /agreement/amountVariability'
Added the new optional request property ' Refund /agreement/maximumAmountPerPayment'
Added the new optional request property ' Refund /agreement/minimumDaysBetweenPayments'
Added the new optional request property ' Refund /agreement/numberOfPayments'
Added the new optional request property ' Refund /agreement/paymentFrequency'
Added the new optional request property ' Refund /order/statementDescriptor/address/stateProvinceCode'
Added the new optional request property ' Verify /agreement/amountVariability'
Added the new optional request property ' Verify /agreement/maximumAmountPerPayment'
Added the new optional request property ' Verify /agreement/minimumDaysBetweenPayments'
Added the new optional request property ' Verify /agreement/numberOfPayments'
Added the new optional request property ' Verify /agreement/paymentFrequency'
Added the new optional request property ' Authenticate Payer /agreement/amountVariability'
Added the new optional request property ' Authenticate Payer /agreement/maximumAmountPerPayment'
Added the new optional request property ' Authenticate Payer /agreement/minimumDaysBetweenPayments'
Added the new optional request property ' Authenticate Payer /agreement/numberOfPayments'
Added the new optional request property ' Authenticate Payer /agreement/paymentFrequency'
Added the new optional request property ' Authenticate Payer /customer/account/history/issuerAuthentication/authenticationToken'
Added the new optional request property ' Authenticate Payer /customer/account/history/issuerAuthentication/transactionId'
Added the new optional request property ' Authenticate Payer /sourceOfFunds/provided/card/nameOnCard'
Added the new optional request property ' Confirm /agreement/amountVariability'
Added the new optional request property ' Confirm /agreement/maximumAmountPerPayment'
Added the new optional request property ' Confirm /agreement/minimumDaysBetweenPayments'
Added the new optional request property ' Confirm /agreement/numberOfPayments'
Added the new optional request property ' Confirm /agreement/paymentFrequency'
Added the new optional request property ' Initiate /agreement/amountVariability'
Added the new optional request property ' Initiate /agreement/maximumAmountPerPayment'
Added the new optional request property ' Initiate /agreement/minimumDaysBetweenPayments'
Added the new optional request property ' Initiate /agreement/numberOfPayments'
Added the new optional request property ' Initiate /agreement/paymentFrequency'
Added the new optional request property ' Authorize /agreement/amountVariability'
Added the new optional request property ' Authorize /agreement/maximumAmountPerPayment'
Added the new optional request property ' Authorize /agreement/minimumDaysBetweenPayments'
Added the new optional request property ' Authorize /agreement/numberOfPayments'
Added the new optional request property ' Authorize /agreement/paymentFrequency'
Added the new optional request property ' Authorize /order/statementDescriptor/address/stateProvinceCode'
Added the new optional request property ' Capture /agreement/amountVariability'
Added the new optional request property ' Capture /agreement/maximumAmountPerPayment'
Added the new optional request property ' Capture /agreement/minimumDaysBetweenPayments'
Added the new optional request property ' Capture /agreement/numberOfPayments'
Added the new optional request property ' Capture /agreement/paymentFrequency'
Added the new optional request property ' Capture /order/statementDescriptor/address/stateProvinceCode'
Added the new optional request property ' Pay /agreement/amountVariability'
Added the new optional request property ' Pay /agreement/maximumAmountPerPayment'
Added the new optional request property ' Pay /agreement/minimumDaysBetweenPayments'
Added the new optional request property ' Pay /agreement/numberOfPayments'
Added the new optional request property ' Pay /agreement/paymentFrequency'
Added the new optional request property ' Pay /order/statementDescriptor/address/stateProvinceCode'
The request property ' Authenticate Payer /customer/account/id' became optional
The request property ' Authorize /transaction/transit/fareCollection' became optional
The request property ' Authorize /transaction/transit/transportationMode' became optional
The request property ' Capture /transaction/transit/fareCollection' became optional
The request property ' Capture /transaction/transit/transportationMode' became optional
Added the new 'KLARNA_FINANCING' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'KLARNA_PAY_LATER' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'REFRESH_AUTHENTICATION' enum value to the request property ' Initiate Authentication /authentication/purpose'
Added the optional property ' Retrieve Transaction /agreement/amountVariability' to the response
Added the optional property ' Retrieve Transaction /agreement/maximumAmountPerPayment' to the response
Added the optional property ' Retrieve Transaction /agreement/minimumDaysBetweenPayments' to the response
Added the optional property ' Retrieve Transaction /agreement/numberOfPayments' to the response
Added the optional property ' Retrieve Transaction /agreement/paymentFrequency' to the response
Added the optional property ' Retrieve Transaction /subgatewayMerchant/acquirer/items/amexSafeKey' to the response
Added the optional property ' Authenticate Payer /agreement/amountVariability' to the response
Added the optional property ' Authenticate Payer /agreement/maximumAmountPerPayment' to the response
Added the optional property ' Authenticate Payer /agreement/minimumDaysBetweenPayments' to the response
Added the optional property ' Authenticate Payer /agreement/numberOfPayments' to the response
Added the optional property ' Authenticate Payer /agreement/paymentFrequency' to the response
Added the optional property ' Authenticate Payer /customer/account/history/issuerAuthentication/authenticationToken' to the response
Added the optional property ' Authenticate Payer /customer/account/history/issuerAuthentication/transactionId' to the response
Removed the 'KLARNA' enum value from the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the required property ' Retrieve Transaction /subgatewayMerchant/address/stateProvince' to the response
Added the required property ' Authenticate Payer /subgatewayMerchant/address/stateProvince' to the response
Added the required property ' Initiate Authentication /subgatewayMerchant/address/stateProvince' to the response

Operations

Payment Options Inquiry

Breaking changes

Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the 'paymentTypes/card/cardTypes/items/cardType' response property
Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the 'paymentTypes/card/localBrand' response property

Operations

Create Checkout Session

Breaking changes

Removed the request property ' Create Checkout Session /agreement/recurring'
Removed the request property ' Create Checkout Session /interaction/theme'

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /agreement/amountVariability'
Added the new optional request property ' Create Checkout Session /agreement/maximumAmountPerPayment'
Added the new optional request property ' Create Checkout Session /agreement/minimumDaysBetweenPayments'
Added the new optional request property ' Create Checkout Session /agreement/numberOfPayments'
Added the new optional request property ' Create Checkout Session /agreement/paymentFrequency'
Added the new optional request property ' Create Checkout Session /interaction/style'
Added the new optional request property ' Create Checkout Session /order/marketplace'
The request property ' Create Checkout Session /transaction/transit/fareCollection' became optional
The request property ' Create Checkout Session /transaction/transit/transportationMode' became optional

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

The response property 'agreement/id' became optional
The response property 'agreement/id' became optional
Removed the enum value 'KLARNA' of the request property 'sourceOfFunds/type'
The response property 'agreement/id' became optional
Removed the optional property 'subgatewayMerchant/address/state' from the response
Added the new 'KLARNA_FINANCING' enum value to the 'sourceOfFunds/type' response property
Added the new 'KLARNA_PAY_LATER' enum value to the 'sourceOfFunds/type' response property
Added the new 'REFRESH_AUTHENTICATION' enum value to the 'authentication/purpose' response property
Removed the optional property 'subgatewayMerchant/address/state' from the response
Added the new 'KLARNA_FINANCING' enum value to the 'sourceOfFunds/type' response property
Added the new 'KLARNA_PAY_LATER' enum value to the 'sourceOfFunds/type' response property
Added the new 'REFRESH_AUTHENTICATION' enum value to the 'authentication/purpose' response property
Removed the request property 'subgatewayMerchant/address/state'
Removed the optional property 'subgatewayMerchant/address/state' from the response
Added the new 'KLARNA_FINANCING' enum value to the 'sourceOfFunds/type' response property
Added the new 'KLARNA_PAY_LATER' enum value to the 'sourceOfFunds/type' response property
Added the new 'REFRESH_AUTHENTICATION' enum value to the 'authentication/purpose' response property

Non-Breaking changes

Added the optional property 'agreement/amountVariability' to the response
Added the optional property 'agreement/maximumAmountPerPayment' to the response
Added the optional property 'agreement/minimumDaysBetweenPayments' to the response
Added the optional property 'agreement/numberOfPayments' to the response
Added the optional property 'agreement/paymentFrequency' to the response
Added the optional property 'customer/account/history/issuerAuthentication/authenticationToken' to the response
Added the optional property 'customer/account/history/issuerAuthentication/transactionId' to the response
Added the optional property 'order/statementDescriptor/address/stateProvinceCode' to the response
Added the optional property 'subgatewayMerchant/address/stateProvince' to the response
Removed the 'KLARNA' enum value from the 'sourceOfFunds/type' response property
Added the optional property 'agreement/amountVariability' to the response
Added the optional property 'agreement/maximumAmountPerPayment' to the response
Added the optional property 'agreement/minimumDaysBetweenPayments' to the response
Added the optional property 'agreement/numberOfPayments' to the response
Added the optional property 'agreement/paymentFrequency' to the response
Added the optional property 'customer/account/history/issuerAuthentication/authenticationToken' to the response
Added the optional property 'customer/account/history/issuerAuthentication/transactionId' to the response
Added the optional property 'order/statementDescriptor/address/stateProvinceCode' to the response
Added the optional property 'subgatewayMerchant/address/stateProvince' to the response
Removed the 'KLARNA' enum value from the 'sourceOfFunds/type' response property
Added the new optional request property 'agreement/amountVariability'
Added the new optional request property 'agreement/maximumAmountPerPayment'
Added the new optional request property 'agreement/minimumDaysBetweenPayments'
Added the new optional request property 'agreement/numberOfPayments'
Added the new optional request property 'agreement/paymentFrequency'
Added the new optional request property 'customer/account/history/issuerAuthentication/authenticationToken'
Added the new optional request property 'customer/account/history/issuerAuthentication/transactionId'
Added the new optional request property 'order/statementDescriptor/address/stateProvinceCode'
Added the new optional request property 'subgatewayMerchant/address/stateProvince'
Added the new 'KLARNA_FINANCING' enum value to the request property 'sourceOfFunds/type'
Added the new 'KLARNA_PAY_LATER' enum value to the request property 'sourceOfFunds/type'
Added the new 'REFRESH_AUTHENTICATION' enum value to the request property 'authentication/purpose'
Added the optional property 'agreement/amountVariability' to the response
Added the optional property 'agreement/maximumAmountPerPayment' to the response
Added the optional property 'agreement/minimumDaysBetweenPayments' to the response
Added the optional property 'agreement/numberOfPayments' to the response
Added the optional property 'agreement/paymentFrequency' to the response
Added the optional property 'customer/account/history/issuerAuthentication/authenticationToken' to the response
Added the optional property 'customer/account/history/issuerAuthentication/transactionId' to the response
Added the optional property 'order/statementDescriptor/address/stateProvinceCode' to the response
Added the optional property 'subgatewayMerchant/address/stateProvince' to the response
Removed the 'KLARNA' enum value from the 'sourceOfFunds/type' response property

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the 'sourceOfFunds/provided/card/localBrand' response property
Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the 'sourceOfFunds/provided/card/localBrand' response property

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/card/nameOnCard' to the response

Operations

Search Tokens

Breaking changes

Added the new 'CITIBANK_PRIVATE_LABEL_CARD' enum value to the 'page/token/items/sourceOfFunds/provided/card/localBrand' response property

November 2020

Version 60

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'marketplace' to the response
Added the optional property 'sourceOfFunds/provided/card/cardType' to the response
Added the optional property 'transaction/items/authorizationResponse/timezone' to the response
Added the optional property 'transaction/items/order/marketplace' to the response
Added the optional property 'transaction/items/order/transactionFiltering' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/cardType' to the response
Added the optional property 'transaction/items/transaction/authorizingEntity' to the response

Operations

Retrieve Transaction , Authenticate Payer , Initiate Authentication , Confirm , Initiate , Update , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void , Assess Risk

Non-Breaking changes

Added the optional property 'authorizationResponse/timezone' to the response
Added the optional property 'order/marketplace' to the response
Added the optional property 'order/transactionFiltering' to the response
Added the optional property 'sourceOfFunds/provided/card/cardType' to the response
Added the optional property 'transaction/authorizingEntity' to the response
Added the new optional request property ' Refund /order/marketplace'
Added the new optional request property ' Refund /sourceOfFunds/provided/card/cardType'
Added the new optional request property ' Verify /authentication'
Added the new optional request property ' Verify /order/marketplace'
Added the new optional request property ' Verify /order/transactionFiltering'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/cardType'
Added the new optional request property ' Authenticate Payer /externalTokenProvider'
Added the new optional request property ' Initiate Authentication /externalTokenProvider'
Added the new optional request property ' Authorize /order/marketplace'
Added the new optional request property ' Authorize /order/transactionFiltering'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/cardType'
Added the new optional request property ' Capture /authorizationResponse/date'
Added the new optional request property ' Capture /authorizationResponse/time'
Added the new optional request property ' Capture /authorizationResponse/timezone'
Added the new optional request property ' Capture /order/marketplace'
Added the new optional request property ' Capture /sourceOfFunds/provided/card/cardType'
Added the new optional request property ' Pay /order/marketplace'
Added the new optional request property ' Pay /order/transactionFiltering'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/cardType'
Added the optional property ' Retrieve Transaction /authorizationResponse/timezone' to the response
Added the optional property ' Retrieve Transaction /order/marketplace' to the response
Added the optional property ' Retrieve Transaction /order/transactionFiltering' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/card/cardType' to the response
Added the optional property ' Retrieve Transaction /transaction/authorizingEntity' to the response
Added the optional property ' Authenticate Payer /authentication/3ds2/3dsServerTransactionId' to the response

Operations

Payment Options Inquiry

Breaking changes

Removed the optional property 'paymentTypes/card/enforceCardSecurityCodeEntry' from the response

Non-Breaking changes

Added the new enum value 'OPEN_BANKING_BANK_TRANSFER' to the 'query' request parameter 'paymentType'
Added the optional property 'paymentTypes/openBankingBankTransfer' to the response
The 'paymentTypes/card/interactionConstraints' response's property pattern was changed from '^\s*((CREDIT_DEBIT_SELECTION))(,\s*((CREDIT_DEBIT_SELECTION)))*\s*$' to '^\s*((CREDIT_DEBIT_SELECTION)|(CARD_TYPE_SELECTION)|(CARD_SECURITY_CODE_ENTRY))(,\s*((CREDIT_DEBIT_SELECTION)|(CARD_TYPE_SELECTION)|(CARD_SECURITY_CODE_ENTRY)))*\s*$'
Added the required property 'paymentTypes/paypal/clientId' to the response

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the 'paymentType' response property
Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the 'paymentType' response property
Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the 'paymentType' response property

Non-Breaking changes

Added the optional property 'authorizationResponse/date' to the response
Added the optional property 'authorizationResponse/time' to the response
Added the optional property 'authorizationResponse/timezone' to the response
Added the optional property 'order/marketplace' to the response
Added the optional property 'order/transactionFiltering' to the response
Added the optional property 'sourceOfFunds/provided/card/cardType' to the response
Added the new optional request property ' Open Wallet /order/transactionFiltering'
Added the optional property 'authorizationResponse/date' to the response
Added the optional property 'authorizationResponse/time' to the response
Added the optional property 'authorizationResponse/timezone' to the response
Added the optional property 'order/marketplace' to the response
Added the optional property 'order/transactionFiltering' to the response
Added the optional property 'sourceOfFunds/provided/card/cardType' to the response
Added the new optional request property 'authorizationResponse/date'
Added the new optional request property 'authorizationResponse/time'
Added the new optional request property 'authorizationResponse/timezone'
Added the new optional request property 'order/marketplace'
Added the new optional request property 'order/transactionFiltering'
Added the new optional request property 'sourceOfFunds/provided/card/cardType'
Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the request property 'paymentType'
Added the optional property 'authorizationResponse/date' to the response
Added the optional property 'authorizationResponse/time' to the response
Added the optional property 'authorizationResponse/timezone' to the response
Added the optional property 'order/marketplace' to the response
Added the optional property 'order/transactionFiltering' to the response
Added the optional property 'sourceOfFunds/provided/card/cardType' to the response

Operations

Delete Token , Retrieve Token , Create or Update Token

Non-Breaking changes

Added the optional property 'schemeToken' to the response

September 2020

Version 59

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'risk/response/provider' to the response
Added the optional property 'statementDescriptor' to the response
Added the optional property 'transaction/items/browserPayment/paypal/interactionId' to the response
Added the optional property 'transaction/items/risk/response/provider' to the response

Operations

Retrieve Transaction , Authenticate Payer , Initiate Authentication , Confirm , Initiate , Update , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void , Assess Risk

Non-Breaking changes

Added the optional property 'browserPayment/paypal/interactionId' to the response
Added the optional property 'risk/response/provider' to the response
Api operation id 'Authentication: Authenticate Payer OR Authentication: Initiate Authentication OR Browser Payment: Confirm OR Browser Payment: Initiate OR Transaction: Authorize OR Transaction: Capture OR Transaction: Pay OR Transaction: Referral OR Transaction: Refund OR Transaction: Update Authorization OR Transaction: Verify OR Transaction: Void OR Transaction: Assess Risk' removed and replaced with 'Authentication: Authenticate Payer OR Authentication: Initiate Authentication OR Browser Payment: Confirm OR Browser Payment: Initiate OR Browser Payment: Update OR Transaction: Authorize OR Transaction: Capture OR Transaction: Pay OR Transaction: Referral OR Transaction: Refund OR Transaction: Update Authorization OR Transaction: Verify OR Transaction: Void OR Transaction: Assess Risk'
Added the new optional request property ' Authenticate Payer /order/statementDescriptor'
Added the new optional request property ' Initiate Authentication /subgatewayMerchant/acquirer/items/amexSafeKey'
Added the new optional request property ' Capture /order/description'
Added the new optional request property ' Refund /order/description'
Added ' update_browser_payment_request' to the request body 'oneOf' list
The request property ' Initiate /browserPayment/returnUrl' became optional
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the request property ' Pay /sourceOfFunds/type'
The ' Capture /authorizationResponse/transactionIdentifier' request property's maxLength was increased from '15' to '30'
Added the optional property ' Retrieve Transaction /browserPayment/paypal/interactionId' to the response
Added the optional property ' Retrieve Transaction /risk/response/provider' to the response
Added the optional property ' Authenticate Payer /order/statementDescriptor' to the response
Added the optional property ' Authenticate Payer /subgatewayMerchant/acquirer/items/amexSafeKey' to the response
Added the optional property ' Initiate Authentication /subgatewayMerchant/acquirer/items/amexSafeKey' to the response

Operations

Payment Options Inquiry

Non-Breaking changes

Added the new enum value 'MERCADO_PAGO_CHECKOUT' to the 'query' request parameter 'paymentType'
Added the optional property 'paymentTypes/mercadoPagoCheckout' to the response

Operations

Create Checkout Session

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /transaction/bancanet'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

The 'authorizationResponse/transactionIdentifier' response property's maxLength was increased from '15' to '30'
The 'authorizationResponse/transactionIdentifier' response property's maxLength was increased from '15' to '30'
The 'authorizationResponse/transactionIdentifier' response property's maxLength was increased from '15' to '30'
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the 'paymentType' response property
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the 'paymentType' response property
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the 'paymentType' response property

Non-Breaking changes

Added the optional property 'subgatewayMerchant/acquirer/items/amexSafeKey' to the response
Added the optional property 'subgatewayMerchant/acquirer/items/amexSafeKey' to the response
Added the new optional request property 'subgatewayMerchant/acquirer/items/amexSafeKey'
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the request property 'paymentType'
The 'authorizationResponse/transactionIdentifier' request property's maxLength was increased from '15' to '30'
Added the optional property 'subgatewayMerchant/acquirer/items/amexSafeKey' to the response

Operations

Create or Update Token (with system-generated token)

Non-Breaking changes

Added the optional property 'replacementToken' to the response

Operations

Delete Token , Retrieve Token , Create or Update Token

Non-Breaking changes

Added the optional property 'replacementToken' to the response
Added the optional property 'replacementToken' to the response

Operations

Search Tokens

Non-Breaking changes

Added the optional property 'page/token/items/replacementToken' to the response

June 2020

Version 58

Operations

Retrieve Order

Breaking changes

Removed the optional property 'authentication/3ds2' from the response
Removed the optional property 'authentication/acceptVersions' from the response
Removed the optional property 'authentication/channel' from the response
Removed the optional property 'authentication/method' from the response
Removed the optional property 'authentication/payerInteraction' from the response
Removed the optional property 'authentication/psd2' from the response
Removed the optional property 'authentication/purpose' from the response
Removed the optional property 'authentication/redirect' from the response
Removed the optional property 'authentication/transactionId' from the response
Removed the optional property 'authentication/version' from the response
Removed the optional property 'debtRepayment/indicator' from the response
Removed the optional property 'transaction/items/debtRepayment/indicator' from the response
Added the new 'AUTO' enum value to the 'transaction/items/authentication/psd2/exemption' response property
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the 'sourceOfFunds/type' response property
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'purchaseType' to the response
Added the optional property 'transaction/items/order/purchaseType' to the response

Operations

Retrieve Transaction , Authenticate Payer , Initiate Authentication , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void , Assess Risk

Breaking changes

Removed the optional property 'debtRepayment/indicator' from the response
Added the new 'AUTO' enum value to the 'authentication/psd2/exemption' response property
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the 'sourceOfFunds/type' response property
Removed the request property ' Verify /debtRepayment/indicator'
Removed the request property ' Assess Risk /debtRepayment/indicator'
Removed the request property ' Authorize /debtRepayment/indicator'
Removed the request property ' Pay /debtRepayment/indicator'
Removed the optional property ' Retrieve Transaction /debtRepayment/indicator' from the response
Added the new 'AUTO' enum value to the ' Retrieve Transaction /authentication/psd2/exemption' response property
Added the new 'AUTO' enum value to the ' Authenticate Payer /authentication/psd2/exemption' response property
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'order/purchaseType' to the response
Added the new optional request property ' Verify /order/purchaseType'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/track1'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/track2'
Added the new optional request property ' Assess Risk /order/purchaseType'
Added the new optional request property ' Authenticate Payer /customer/account/authentication/cardAssociation'
Added the new optional request property ' Authenticate Payer /customer/account/authentication/data'
Added the new optional request property ' Authorize /order/purchaseType'
Added the new optional request property ' Pay /order/purchaseType'
Added the new 'AUTO' enum value to the request property ' Assess Risk /authentication/psd2/exemption'
Added the new 'AUTO' enum value to the request property ' Authenticate Payer /authentication/psd2/exemption'
Added the new 'AUTO' enum value to the request property ' Authorize /authentication/psd2/exemption'
Added the new 'AUTO' enum value to the request property ' Pay /authentication/psd2/exemption'
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the optional property ' Retrieve Transaction /order/purchaseType' to the response
Added the optional property ' Authenticate Payer /customer/account/authentication/cardAssociation' to the response
Added the optional property ' Authenticate Payer /customer/account/authentication/data' to the response

Operations

Payment Options Inquiry

Non-Breaking changes

Added the optional property 'paymentTypes/boletobancario/acquirer' to the response
Added the optional property 'paymentTypes/card/interactionConstraints' to the response

Operations

Create Checkout Session

Breaking changes

Removed the request property ' Create Checkout Session /debtRepayment/indicator'

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /authentication/challengePreference'
Added the new optional request property ' Create Checkout Session /order/invoiceNumber'
Added the new optional request property ' Create Checkout Session /order/purchaseType'
Added the new optional request property ' Create Checkout Session /sourceOfFunds/provided/boletoBancario'
The request property ' Create Checkout Session /sourceOfFunds' became optional
Added the new 'AUTO' enum value to the request property ' Create Checkout Session /authentication/psd2/exemption'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Removed the optional property 'debtRepayment/indicator' from the response
Added the new 'ACCOUNT_UPDATER' enum value to the 'verificationStrategy' response property
Added the new 'AUTO' enum value to the 'authentication/psd2/exemption' response property
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the 'sourceOfFunds/type' response property
Removed the optional property 'debtRepayment/indicator' from the response
Added the new 'ACCOUNT_UPDATER' enum value to the 'verificationStrategy' response property
Added the new 'AUTO' enum value to the 'authentication/psd2/exemption' response property
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the 'sourceOfFunds/type' response property
Removed the request property 'debtRepayment/indicator'
Removed the optional property 'debtRepayment/indicator' from the response
Added the new 'ACCOUNT_UPDATER' enum value to the 'verificationStrategy' response property
Added the new 'AUTO' enum value to the 'authentication/psd2/exemption' response property
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'customer/account/authentication/cardAssociation' to the response
Added the optional property 'customer/account/authentication/data' to the response
Added the optional property 'order/purchaseType' to the response
Added the optional property 'customer/account/authentication/cardAssociation' to the response
Added the optional property 'customer/account/authentication/data' to the response
Added the optional property 'order/purchaseType' to the response
Added the new optional request property 'customer/account/authentication/cardAssociation'
Added the new optional request property 'customer/account/authentication/data'
Added the new optional request property 'order/purchaseType'
Added the new 'ACCOUNT_UPDATER' enum value to the request property 'verificationStrategy'
Added the new 'AUTO' enum value to the request property 'authentication/psd2/exemption'
Added the new 'MERCADO_PAGO_CHECKOUT' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'customer/account/authentication/cardAssociation' to the response
Added the optional property 'customer/account/authentication/data' to the response
Added the optional property 'order/purchaseType' to the response

Operations

Create or Update Token (with system-generated token)

Breaking changes

Added the new 'ACCOUNT_UPDATER' enum value to the 'verificationStrategy' response property

Non-Breaking changes

The request property 'sourceOfFunds' became optional
Added the new 'ACCOUNT_UPDATER' enum value to the request property 'verificationStrategy'

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

Added the new 'ACCOUNT_UPDATER' enum value to the 'verificationStrategy' response property
Added the new 'ACCOUNT_UPDATER' enum value to the 'verificationStrategy' response property

Non-Breaking changes

The request property 'sourceOfFunds' became optional
Added the new 'ACCOUNT_UPDATER' enum value to the request property 'verificationStrategy'

March 2020

Version 57

Operations

Retrieve Order

Breaking changes

Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the 'sourceOfFunds/type' response property
Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'WHITELISTED_MERCHANT' enum value to the 'authentication/psd2/exemption' response property
Added the new 'WHITELISTED_MERCHANT' enum value to the 'transaction/items/authentication/psd2/exemption' response property

Non-Breaking changes

Added the optional property 'expectedNumberOfCaptures' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/actionType' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/customerType' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/daysBeforeAction' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/dueDate' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/slipUrl' to the response
Added the optional property 'sourceOfFunds/provided/openBankingBankTransfer' to the response
Added the optional property 'transaction/items/action' to the response
Added the optional property 'transaction/items/authorizationResponse/transactionIntegrityClass' to the response
Added the optional property 'transaction/items/order/expectedNumberOfCaptures' to the response
Added the optional property 'transaction/items/posTerminal/terminalId' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/boletoBancario/actionType' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/boletoBancario/customerType' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/boletoBancario/daysBeforeAction' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/boletoBancario/dueDate' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/boletoBancario/slipUrl' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/openBankingBankTransfer' to the response
Added the optional property 'transaction/items/timeOfLastUpdate' to the response
Added the optional property 'transaction/items/transaction/stan' to the response
Added the required property 'lastUpdatedTime' to the response
Added the required property 'transaction/items/order/lastUpdatedTime' to the response

Operations

Retrieve Transaction , Authenticate Payer , Initiate Authentication , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void , Assess Risk

Breaking changes

The request property ' Assess Risk /order/subMerchant/identifier' became required
The request property ' Assess Risk /order/subMerchant/tradingName' became required
Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the 'sourceOfFunds/type' response property
Added the new 'WHITELISTED_MERCHANT' enum value to the 'authentication/psd2/exemption' response property
Removed the request property ' Assess Risk /risk/paymentRecipient'
Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property
Added the new 'UNIONPAY' enum value to the ' Authenticate Payer /order/subMerchant/authentication/items/protocol' response property
Added the new 'UNIONPAY' enum value to the ' Initiate Authentication /order/subMerchant/authentication/items/protocol' response property
Added the new 'WHITELISTED_MERCHANT' enum value to the ' Retrieve Transaction /authentication/psd2/exemption' response property
Added the new 'WHITELISTED_MERCHANT' enum value to the ' Authenticate Payer /authentication/psd2/exemption' response property

Non-Breaking changes

Added the optional property 'action' to the response
Added the optional property 'authorizationResponse/transactionIntegrityClass' to the response
Added the optional property 'order/expectedNumberOfCaptures' to the response
Added the optional property 'posTerminal/terminalId' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/actionType' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/customerType' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/daysBeforeAction' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/dueDate' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/slipUrl' to the response
Added the optional property 'sourceOfFunds/provided/openBankingBankTransfer' to the response
Added the optional property 'timeOfLastUpdate' to the response
Added the optional property 'transaction/stan' to the response
Added the required property 'order/lastUpdatedTime' to the response
Added the new optional request property ' Verify /posTerminal/address'
Added the new optional request property ' Verify /posTerminal/cardPresenceCapability'
Added the new optional request property ' Verify /posTerminal/cardholderActivated'
Added the new optional request property ' Verify /posTerminal/mobile'
Added the new optional request property ' Verify /posTerminal/onlineReasonCode'
Added the new optional request property ' Verify /posTerminal/store'
Added the new optional request property ' Verify /posTerminal/terminalId'
Added the new optional request property ' Assess Risk /agreement/recurring/amountVariability'
Added the new optional request property ' Assess Risk /agreement/recurring/numberOfPayments'
Added the new optional request property ' Assess Risk /debtRepayment'
Added the new optional request property ' Assess Risk /order/subMerchant/address/stateProvinceCode'
Added the new optional request property ' Assess Risk /posTerminal/mobile'
Added the new optional request property ' Assess Risk /posTerminal/terminalId'
Added the new optional request property ' Assess Risk /subgatewayMerchant/riskProfileName'
Added the new optional request property ' Authenticate Payer /device/browserDetails/javaScriptEnabled'
Added the new optional request property ' Initiate /sourceOfFunds/provided/openBankingBankTransfer'
Added the new optional request property ' Authorize /posTerminal/terminalId'
Added the new optional request property ' Capture /authorizationResponse/transactionIntegrityClass'
Added the new optional request property ' Capture /posTerminal/terminalId'
Added the new optional request property ' Pay /posTerminal/terminalId'
Added the new optional request property ' Refund /action/refundAuthorization'
Added the new optional request property ' Refund /posTerminal/terminalId'
Added the new optional request property ' Refund /transaction/acquirer/traceId'
Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'REQUEST_WHITELISTING' enum value to the request property ' Authenticate Payer /authentication/challengePreference'
Added the new 'UNIONPAY' enum value to the request property ' Initiate Authentication /order/subMerchant/authentication/items/protocol'
Added the new 'WHITELISTED_MERCHANT' enum value to the request property ' Assess Risk /authentication/psd2/exemption'
Added the new 'WHITELISTED_MERCHANT' enum value to the request property ' Authenticate Payer /authentication/psd2/exemption'
Added the new 'WHITELISTED_MERCHANT' enum value to the request property ' Authorize /authentication/psd2/exemption'
Added the new 'WHITELISTED_MERCHANT' enum value to the request property ' Pay /authentication/psd2/exemption'
Added the optional property ' Retrieve Transaction /action' to the response
Added the optional property ' Retrieve Transaction /authorizationResponse/transactionIntegrityClass' to the response
Added the optional property ' Retrieve Transaction /order/expectedNumberOfCaptures' to the response
Added the optional property ' Retrieve Transaction /posTerminal/terminalId' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/boletoBancario/actionType' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/boletoBancario/customerType' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/boletoBancario/daysBeforeAction' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/boletoBancario/dueDate' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/boletoBancario/slipUrl' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/openBankingBankTransfer' to the response
Added the optional property ' Retrieve Transaction /timeOfLastUpdate' to the response
Added the optional property ' Retrieve Transaction /transaction/stan' to the response
Added the optional property ' Authenticate Payer /authentication/3ds2/sdk/challengeCompletionCallbackUrl' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/boletoBancario/actionType' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/boletoBancario/customerType' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/boletoBancario/daysBeforeAction' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/boletoBancario/dueDate' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/boletoBancario/slipUrl' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/openBankingBankTransfer' to the response
Added the optional property ' Authenticate Payer /timeOfLastUpdate' to the response
Added the optional property ' Initiate Authentication /authentication/3ds2/protocolVersion' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/boletoBancario/actionType' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/boletoBancario/customerType' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/boletoBancario/daysBeforeAction' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/boletoBancario/dueDate' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/boletoBancario/slipUrl' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/openBankingBankTransfer' to the response
Added the optional property ' Initiate Authentication /timeOfLastUpdate' to the response
Added the required property ' Retrieve Transaction /order/lastUpdatedTime' to the response
Added the required property ' Authenticate Payer /order/lastUpdatedTime' to the response
Added the required property ' Initiate Authentication /order/lastUpdatedTime' to the response

Operations

Payment Options Inquiry

Non-Breaking changes

Added the new optional 'query' request parameter 'action'
Added the optional property 'paymentTypes/card/walletProviders/items/secureRemoteCommerce/defaultPayerCountry' to the response
Added the optional property 'paymentTypes/card/walletProviders/items/secureRemoteCommerce/shippingAddressCountries' to the response

Operations

Create Checkout Session

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /interaction/country'
Added the new 'WHITELISTED_MERCHANT' enum value to the request property ' Create Checkout Session /authentication/psd2/exemption'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Breaking changes

Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the 'sourceOfFunds/type' response property
Added the new 'REQUEST_WHITELISTING' enum value to the 'authentication/challengePreference' response property
Added the new 'UNIONPAY' enum value to the 'order/subMerchant/authentication/items/protocol' response property
Added the new 'WHITELISTED_MERCHANT' enum value to the 'authentication/psd2/exemption' response property
Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the 'sourceOfFunds/type' response property
Added the new 'REQUEST_WHITELISTING' enum value to the 'authentication/challengePreference' response property
Added the new 'UNIONPAY' enum value to the 'order/subMerchant/authentication/items/protocol' response property
Added the new 'WHITELISTED_MERCHANT' enum value to the 'authentication/psd2/exemption' response property
Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the 'sourceOfFunds/type' response property
Added the new 'REQUEST_WHITELISTING' enum value to the 'authentication/challengePreference' response property
Added the new 'UNIONPAY' enum value to the 'order/subMerchant/authentication/items/protocol' response property
Added the new 'WHITELISTED_MERCHANT' enum value to the 'authentication/psd2/exemption' response property

Non-Breaking changes

Added the optional property 'action/refundAuthorization' to the response
Added the optional property 'authorizationResponse/transactionIntegrityClass' to the response
Added the optional property 'device/browserDetails/javaScriptEnabled' to the response
Added the optional property 'posTerminal/terminalId' to the response
Added the optional property 'sourceOfFunds/provided/openBankingBankTransfer' to the response
Added the optional property 'sourceOfFunds/schemeTokenProvisioningIdentifier' to the response
Added the optional property 'subgatewayMerchant/riskProfileName' to the response
Added the optional property 'action/refundAuthorization' to the response
Added the optional property 'authorizationResponse/transactionIntegrityClass' to the response
Added the optional property 'device/browserDetails/javaScriptEnabled' to the response
Added the optional property 'posTerminal/terminalId' to the response
Added the optional property 'sourceOfFunds/provided/openBankingBankTransfer' to the response
Added the optional property 'sourceOfFunds/schemeTokenProvisioningIdentifier' to the response
Added the optional property 'subgatewayMerchant/riskProfileName' to the response
Added the new optional request property 'action/refundAuthorization'
Added the new optional request property 'authorizationResponse/transactionIntegrityClass'
Added the new optional request property 'device/browserDetails/javaScriptEnabled'
Added the new optional request property 'posTerminal/terminalId'
Added the new optional request property 'sourceOfFunds/provided/openBankingBankTransfer'
Added the new optional request property 'sourceOfFunds/schemeTokenProvisioningIdentifier'
Added the new optional request property 'subgatewayMerchant/riskProfileName'
Added the new 'OPEN_BANKING_BANK_TRANSFER' enum value to the request property 'sourceOfFunds/type'
Added the new 'REQUEST_WHITELISTING' enum value to the request property 'authentication/challengePreference'
Added the new 'UNIONPAY' enum value to the request property 'order/subMerchant/authentication/items/protocol'
Added the new 'WHITELISTED_MERCHANT' enum value to the request property 'authentication/psd2/exemption'
Added the optional property 'action/refundAuthorization' to the response
Added the optional property 'authorizationResponse/transactionIntegrityClass' to the response
Added the optional property 'device/browserDetails/javaScriptEnabled' to the response
Added the optional property 'posTerminal/terminalId' to the response
Added the optional property 'sourceOfFunds/provided/openBankingBankTransfer' to the response
Added the optional property 'sourceOfFunds/schemeTokenProvisioningIdentifier' to the response
Added the optional property 'subgatewayMerchant/riskProfileName' to the response

Operations

Create or Update Token (with system-generated token)

Breaking changes

Added the new 'SCHEME_TOKENIZATION_DECLINED' enum value to the 'response/gatewayCode' response property
Added the new 'SCHEME_TOKENIZATION_ERROR' enum value to the 'response/gatewayCode' response property
Added the new 'SCHEME_TOKENIZATION_SUCCESSFUL' enum value to the 'response/gatewayCode' response property
Added the new 'SCHEME_TOKENIZATION_SUCCESSFUL_ADDITIONAL_AUTHENTICATION_REQUIRED' enum value to the 'response/gatewayCode' response property

Non-Breaking changes

Added the new optional request property 'billing'
Added the new optional request property 'customer'
Added the new optional request property 'device'
Added the new optional request property 'sourceOfFunds/provided/card/nameOnCard'
Added the new optional request property 'sourceOfFunds/schemeTokenProvisioningIdentifier'
Added the optional property 'billing' to the response
Added the optional property 'customer' to the response
Added the optional property 'device' to the response
Added the optional property 'schemeToken' to the response
Added the optional property 'sourceOfFunds/provided/card/nameOnCard' to the response
Added the optional property 'sourceOfFunds/schemeTokenProvisioningIdentifier' to the response

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

Added the new 'SCHEME_TOKENIZATION_DECLINED' enum value to the 'response/gatewayCode' response property
Added the new 'SCHEME_TOKENIZATION_ERROR' enum value to the 'response/gatewayCode' response property
Added the new 'SCHEME_TOKENIZATION_SUCCESSFUL' enum value to the 'response/gatewayCode' response property
Added the new 'SCHEME_TOKENIZATION_SUCCESSFUL_ADDITIONAL_AUTHENTICATION_REQUIRED' enum value to the 'response/gatewayCode' response property

Non-Breaking changes

Added the new optional request property 'billing'
Added the new optional request property 'customer'
Added the new optional request property 'device'
Added the new optional request property 'sourceOfFunds/provided/card/nameOnCard'
Added the new optional request property 'sourceOfFunds/schemeTokenProvisioningIdentifier'
Added the optional property 'billing' to the response
Added the optional property 'customer' to the response
Added the optional property 'device' to the response
Added the optional property 'schemeToken' to the response
Added the optional property 'sourceOfFunds/provided/card/nameOnCard' to the response
Added the optional property 'sourceOfFunds/schemeTokenProvisioningIdentifier' to the response

December 2019

Version 56

Operations

Balance Inquiry

Breaking changes

The request property 'order/subMerchant/identifier' became required
The request property 'order/subMerchant/tradingName' became required

Non-Breaking changes

Added the new optional request property 'order/subMerchant/address/stateProvinceCode'
Added the new optional request property 'sourceOfFunds/provided/card/maskedFpan'
Added the new optional request property 'sourceOfFunds/provided/card/maskedFpanExpiry'
Added the new optional request property 'sourceOfFunds/provided/card/storedOnFile'

Operations

Retrieve Order

Breaking changes

Removed the optional property 'transaction/items/risk/paymentRecipient' from the response

Non-Breaking changes

Added the optional property 'agreement/recurring/amountVariability' to the response
Added the optional property 'agreement/recurring/numberOfPayments' to the response
Added the optional property 'debtRepayment' to the response
Added the optional property 'sourceOfFunds/provided/oxxo/dueDate' to the response
Added the optional property 'transaction/items/agreement/recurring/amountVariability' to the response
Added the optional property 'transaction/items/agreement/recurring/numberOfPayments' to the response
Added the optional property 'transaction/items/debtRepayment' to the response
Added the optional property 'transaction/items/posTerminal/mobile' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/oxxo/dueDate' to the response
Added the required property 'merchantAmount' to the response
Added the required property 'merchantCurrency' to the response
Added the required property 'transaction/items/order/merchantAmount' to the response
Added the required property 'transaction/items/order/merchantCurrency' to the response
Added the required property 'transaction/items/transaction/multiCurrencyPricing/merchantAmount' to the response
Added the required property 'transaction/items/transaction/multiCurrencyPricing/merchantCurrency' to the response

Operations

Retrieve Transaction , Authenticate Payer , Initiate Authentication , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void , Assess Risk

Breaking changes

The request property ' Verify /order/subMerchant/identifier' became required
The request property ' Verify /order/subMerchant/tradingName' became required
The request property ' Authorize /order/subMerchant/identifier' became required
The request property ' Authorize /order/subMerchant/tradingName' became required
The request property ' Capture /order/subMerchant/identifier' became required
The request property ' Capture /order/subMerchant/tradingName' became required
The request property ' Pay /order/subMerchant/identifier' became required
The request property ' Pay /order/subMerchant/tradingName' became required
The request property ' Refund /order/subMerchant/identifier' became required
The request property ' Refund /order/subMerchant/tradingName' became required
Removed the optional property 'risk/paymentRecipient' from the response
Removed the request property ' Authorize /risk/paymentRecipient'
Removed the request property ' Pay /risk/paymentRecipient'
Removed the optional property ' Retrieve Transaction /risk/paymentRecipient' from the response

Non-Breaking changes

Added the optional property 'agreement/recurring/amountVariability' to the response
Added the optional property 'agreement/recurring/numberOfPayments' to the response
Added the optional property 'debtRepayment' to the response
Added the optional property 'posTerminal/mobile' to the response
Added the optional property 'sourceOfFunds/provided/oxxo/dueDate' to the response
Added the required property 'order/merchantAmount' to the response
Added the required property 'order/merchantCurrency' to the response
Added the required property 'transaction/multiCurrencyPricing/merchantAmount' to the response
Added the required property 'transaction/multiCurrencyPricing/merchantCurrency' to the response
Added the new optional request property ' Verify /agreement/recurring/amountVariability'
Added the new optional request property ' Verify /agreement/recurring/numberOfPayments'
Added the new optional request property ' Verify /debtRepayment'
Added the new optional request property ' Verify /order/subMerchant/address/stateProvinceCode'
Added the new optional request property ' Verify /posTerminal/inputCapability'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/emvRequest'
Added the new optional request property ' Authenticate Payer /agreement/recurring/amountVariability'
Added the new optional request property ' Authenticate Payer /agreement/recurring/numberOfPayments'
Added the new optional request property ' Confirm /agreement/recurring/amountVariability'
Added the new optional request property ' Confirm /agreement/recurring/numberOfPayments'
Added the new optional request property ' Initiate /agreement/recurring/amountVariability'
Added the new optional request property ' Initiate /agreement/recurring/numberOfPayments'
Added the new optional request property ' Initiate /sourceOfFunds/provided/oxxo/dueDate'
Added the new optional request property ' Authorize /agreement/recurring/amountVariability'
Added the new optional request property ' Authorize /agreement/recurring/numberOfPayments'
Added the new optional request property ' Authorize /debtRepayment'
Added the new optional request property ' Authorize /order/subMerchant/address/stateProvinceCode'
Added the new optional request property ' Authorize /posTerminal/mobile'
Added the new optional request property ' Capture /agreement/recurring/amountVariability'
Added the new optional request property ' Capture /agreement/recurring/numberOfPayments'
Added the new optional request property ' Capture /order/subMerchant/address/stateProvinceCode'
Added the new optional request property ' Capture /posTerminal/mobile'
Added the new optional request property ' Pay /agreement/recurring/amountVariability'
Added the new optional request property ' Pay /agreement/recurring/numberOfPayments'
Added the new optional request property ' Pay /customer/nationalId'
Added the new optional request property ' Pay /debtRepayment'
Added the new optional request property ' Pay /order/subMerchant/address/stateProvinceCode'
Added the new optional request property ' Pay /posTerminal/mobile'
Added the new optional request property ' Pay /sourceOfFunds/provided/boletoBancario'
Added the new optional request property ' Refund /agreement/recurring/amountVariability'
Added the new optional request property ' Refund /agreement/recurring/numberOfPayments'
Added the new optional request property ' Refund /order/subMerchant/address/stateProvinceCode'
Added the new optional request property ' Refund /posTerminal/mobile'
Added the new 'BOLETO_BANCARIO' enum value to the request property ' Pay /sourceOfFunds/type'
Added the optional property ' Retrieve Transaction /agreement/recurring/amountVariability' to the response
Added the optional property ' Retrieve Transaction /agreement/recurring/numberOfPayments' to the response
Added the optional property ' Retrieve Transaction /debtRepayment' to the response
Added the optional property ' Retrieve Transaction /posTerminal/mobile' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/oxxo/dueDate' to the response
Added the optional property ' Authenticate Payer /agreement/recurring/amountVariability' to the response
Added the optional property ' Authenticate Payer /agreement/recurring/numberOfPayments' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/oxxo/dueDate' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/oxxo/dueDate' to the response
Added the required property ' Retrieve Transaction /order/merchantAmount' to the response
Added the required property ' Retrieve Transaction /order/merchantCurrency' to the response
Added the required property ' Retrieve Transaction /transaction/multiCurrencyPricing/merchantAmount' to the response
Added the required property ' Retrieve Transaction /transaction/multiCurrencyPricing/merchantCurrency' to the response

Operations

Payment Options Inquiry

Non-Breaking changes

Added the optional property 'risk' to the response

Operations

Create Checkout Session

Breaking changes

The request property ' Create Checkout Session /order/subMerchant/identifier' became required
The request property ' Create Checkout Session /order/subMerchant/tradingName' became required
Removed the request property ' Create Checkout Session /risk/paymentRecipient'

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /agreement/recurring/amountVariability'
Added the new optional request property ' Create Checkout Session /agreement/recurring/numberOfPayments'
Added the new optional request property ' Create Checkout Session /debtRepayment'
Added the new optional request property ' Create Checkout Session /order/subMerchant/address/stateProvinceCode'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session

Non-Breaking changes

Added the optional property 'agreement/recurring/amountVariability' to the response
Added the optional property 'agreement/recurring/numberOfPayments' to the response
Added the optional property 'debtRepayment' to the response
Added the optional property 'order/subMerchant/address/stateProvinceCode' to the response
Added the optional property 'posTerminal/mobile' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/actionType' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/customerType' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/daysBeforeAction' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/dueDate' to the response
Added the optional property 'sourceOfFunds/provided/oxxo/dueDate' to the response
Added the optional property 'agreement/recurring/amountVariability' to the response
Added the optional property 'agreement/recurring/numberOfPayments' to the response
Added the optional property 'debtRepayment' to the response
Added the optional property 'order/subMerchant/address/stateProvinceCode' to the response
Added the optional property 'posTerminal/mobile' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/actionType' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/customerType' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/daysBeforeAction' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario/dueDate' to the response
Added the optional property 'sourceOfFunds/provided/oxxo/dueDate' to the response
Added the new optional request property 'agreement/recurring/amountVariability'
Added the new optional request property 'agreement/recurring/numberOfPayments'
Added the new optional request property 'debtRepayment'
Added the new optional request property 'order/subMerchant/address/stateProvinceCode'
Added the new optional request property 'posTerminal/mobile'
Added the new optional request property 'sourceOfFunds/provided/boletoBancario/actionType'
Added the new optional request property 'sourceOfFunds/provided/boletoBancario/customerType'
Added the new optional request property 'sourceOfFunds/provided/boletoBancario/daysBeforeAction'
Added the new optional request property 'sourceOfFunds/provided/boletoBancario/dueDate'
Added the new optional request property 'sourceOfFunds/provided/oxxo/dueDate'
Added the optional property 'agreement/recurring/amountVariability' to the response
Added the optional property 'agreement/recurring/numberOfPayments' to the response