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
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

September 2019

Version 55

Operations

Retrieve Order

Breaking changes

For the 'query' request parameter 'responseControls', the type/format was changed from ''/'' to 'object'/''
Added the new 'SOFTWARE_ONLINE_PIN_ONLY' enum value to the 'transaction/items/posTerminal/pinEntryCapability' response property

Non-Breaking changes

Added the optional property '3DSecure' to the response
Added the optional property '3DSecureId' to the response
Added the optional property 'airline' to the response
Added the optional property 'authentication' to the response
Added the optional property 'paymentPlan' to the response
Added the optional property 'requestedAmount' to the response
Added the optional property 'transaction/items/transaction/multiCurrencyPricing' to the response
Added the optional property 'transaction/items/transaction/transit/aggregationStartDate' to the response
The 'merchant' response's property pattern was changed

Operations

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

Breaking changes

For the 'query' request parameter 'responseControls', the type/format was changed from ''/'' to 'object'/''
Added ' assess_risk_response' to the response body 'oneOf' list
Added the new 'SOFTWARE_ONLINE_PIN_ONLY' enum value to the 'posTerminal/pinEntryCapability' response property
Added the new 'SOFTWARE_ONLINE_PIN_ONLY' enum value to the ' Retrieve Transaction /posTerminal/pinEntryCapability' response property

Non-Breaking changes

Added the optional property 'transaction/multiCurrencyPricing' to the response
Added the optional property 'transaction/transit/aggregationStartDate' 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' removed and replaced with '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'
Added the new optional request property ' Initiate /transaction/multiCurrencyPricing'
Added the new optional request property ' Authorize /transaction/multiCurrencyPricing'
Added the new optional request property ' Capture /transaction/multiCurrencyPricing'
Added the new optional request property ' Pay /transaction/multiCurrencyPricing'
Added the new optional request property ' Refund /transaction/multiCurrencyPricing'
Added ' assess_risk_request' to the request body 'oneOf' list
Added the new 'SOFTWARE_ONLINE_PIN_ONLY' enum value to the request property ' Verify /posTerminal/pinEntryCapability'
Added the new 'SOFTWARE_ONLINE_PIN_ONLY' enum value to the request property ' Authorize /posTerminal/pinEntryCapability'
Added the new 'SOFTWARE_ONLINE_PIN_ONLY' enum value to the request property ' Capture /posTerminal/pinEntryCapability'
Added the new 'SOFTWARE_ONLINE_PIN_ONLY' enum value to the request property ' Pay /posTerminal/pinEntryCapability'
Added the new 'SOFTWARE_ONLINE_PIN_ONLY' enum value to the request property ' Refund /posTerminal/pinEntryCapability'
The ' Authenticate Payer /authentication/3ds2/sdk/referenceNumber' request property's minLength was decreased from '32' to '1'
Added the optional property ' Retrieve Transaction /transaction/multiCurrencyPricing' to the response
Added the optional property ' Retrieve Transaction /transaction/transit/aggregationStartDate' to the response

Operations

Payment Options Inquiry

Breaking changes

Added the new 'AMERICAN_EXPRESS' enum value to the 'paymentTypes/card/walletProviders/items/secureRemoteCommerce/scheme/items/name' response property

Non-Breaking changes

Added the optional property 'custom' to the response

Operations

Create Checkout Session

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /interaction/merchant/url'
Added the new optional request property ' Create Checkout Session /transaction/multiCurrencyPricing'

Operations

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

Breaking changes

For the 'query' request parameter 'responseControls', the type/format was changed from ''/'' to 'object'/''
The 'authentication/3ds2/sdk/referenceNumber' response property's minLength was decreased from '32' to '1'
The 'authentication/3ds2/sdk/referenceNumber' response property's minLength was decreased from '32' to '1'
The 'authentication/3ds2/sdk/referenceNumber' response property's minLength was decreased from '32' to '1'
Added the new 'AMERICAN_EXPRESS' enum value to the 'wallet/secureRemoteCommerce/scheme' response property
Added the new 'SOFTWARE_ONLINE_PIN_ONLY' enum value to the 'posTerminal/pinEntryCapability' response property
Added the new 'AMERICAN_EXPRESS' enum value to the 'wallet/secureRemoteCommerce/scheme' response property
Added the new 'SOFTWARE_ONLINE_PIN_ONLY' enum value to the 'posTerminal/pinEntryCapability' response property
Added the new 'AMERICAN_EXPRESS' enum value to the 'wallet/secureRemoteCommerce/scheme' response property
Added the new 'SOFTWARE_ONLINE_PIN_ONLY' enum value to the 'posTerminal/pinEntryCapability' response property

Non-Breaking changes

Added the optional property 'authResponseUpdateAction' to the response
Added the optional property 'sourceOfFunds/provided/paypal/accountEmail' to the response
Added the optional property 'sourceOfFunds/provided/paypal/accountHolder' to the response
Added the optional property 'sourceOfFunds/provided/paypal/billingAgreement/id' to the response
Added the optional property 'sourceOfFunds/provided/paypal/payerId' to the response
Added the optional property 'subgatewayMerchant/orderId' to the response
Added the optional property 'subgatewayMerchant/riskCredentialsId' to the response
Added the optional property 'subgatewayMerchant/riskProviderId' to the response
Added the optional property 'subgatewayMerchant/transactionId' to the response
Added the optional property 'transaction/multiCurrencyPricing' to the response
Added the new 'AMERICAN_EXPRESS' enum value to the request property ' Update Session From Wallet /wallet/secureRemoteCommerce/scheme'
Added the optional property 'authResponseUpdateAction' to the response
Added the optional property 'sourceOfFunds/provided/paypal/accountEmail' to the response
Added the optional property 'sourceOfFunds/provided/paypal/accountHolder' to the response
Added the optional property 'sourceOfFunds/provided/paypal/billingAgreement/id' to the response
Added the optional property 'sourceOfFunds/provided/paypal/payerId' to the response
Added the optional property 'subgatewayMerchant/orderId' to the response
Added the optional property 'subgatewayMerchant/riskCredentialsId' to the response
Added the optional property 'subgatewayMerchant/riskProviderId' to the response
Added the optional property 'subgatewayMerchant/transactionId' to the response
Added the optional property 'transaction/multiCurrencyPricing' to the response
Added the new optional request property 'authResponseUpdateAction'
Added the new optional request property 'sourceOfFunds/provided/paypal/accountEmail'
Added the new optional request property 'sourceOfFunds/provided/paypal/accountHolder'
Added the new optional request property 'sourceOfFunds/provided/paypal/billingAgreement/id'
Added the new optional request property 'sourceOfFunds/provided/paypal/payerId'
Added the new optional request property 'subgatewayMerchant/orderId'
Added the new optional request property 'subgatewayMerchant/riskCredentialsId'
Added the new optional request property 'subgatewayMerchant/riskProviderId'
Added the new optional request property 'subgatewayMerchant/transactionId'
Added the new optional request property 'transaction/multiCurrencyPricing'
Added the new 'AMERICAN_EXPRESS' enum value to the request property 'wallet/secureRemoteCommerce/scheme'
Added the new 'SOFTWARE_ONLINE_PIN_ONLY' enum value to the request property 'posTerminal/pinEntryCapability'
The 'authentication/3ds2/sdk/referenceNumber' request property's minLength was decreased from '32' to '1'
Added the optional property 'authResponseUpdateAction' to the response
Added the optional property 'sourceOfFunds/provided/paypal/accountEmail' to the response
Added the optional property 'sourceOfFunds/provided/paypal/accountHolder' to the response
Added the optional property 'sourceOfFunds/provided/paypal/billingAgreement/id' to the response
Added the optional property 'sourceOfFunds/provided/paypal/payerId' to the response
Added the optional property 'subgatewayMerchant/orderId' to the response
Added the optional property 'subgatewayMerchant/riskCredentialsId' to the response
Added the optional property 'subgatewayMerchant/riskProviderId' to the response
Added the optional property 'subgatewayMerchant/transactionId' to the response
Added the optional property 'transaction/multiCurrencyPricing' to the response

Operations

Shopping Options Inquiry

Non-Breaking changes

Endpoint added

Operations

Create or Update Token (with system-generated token)

Breaking changes

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

Non-Breaking changes

Added the new optional request property 'shipping'
Added the new optional request property 'sourceOfFunds/provided/paypal'
Added the new 'PAYPAL' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'shipping' to the response
Added the optional property 'sourceOfFunds/provided/paypal' to the response

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

For the 'query' request parameter 'responseControls', the type/format was changed from ''/'' to 'object'/''
Added the new 'PAYPAL' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the new optional request property 'shipping'
Added the new optional request property 'sourceOfFunds/provided/paypal'
Added the new 'PAYPAL' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'shipping' to the response
Added the optional property 'sourceOfFunds/provided/paypal' to the response

July 2019

Version 54

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Non-Breaking changes

Added the new optional request property 'sourceOfFunds/type'

Operations

Retrieve Order

Breaking changes

The response property 'agreement/id' became optional
The response property 'transaction/items/agreement/id' became optional
Removed the optional property 'recurringPaymentAgreement' from the response
Removed the optional property 'transaction/items/authentication/3ds1/xid' from the response
Removed the optional property 'transaction/items/order/recurringPaymentAgreement' from the response
Removed the optional property 'transaction/items/transaction/frequency' from the response
Added the new 'PBBA' enum value to the 'sourceOfFunds/type' response property
Added the new 'PBBA' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'agreement/expiryDate' to the response
Added the optional property 'agreement/recurring' to the response
Added the optional property 'agreement/type' to the response
Added the optional property 'sourceOfFunds/provided/card/paymentAccountReference' to the response
Added the optional property 'sourceOfFunds/provided/pbba' to the response
Added the optional property 'transaction/items/agreement/expiryDate' to the response
Added the optional property 'transaction/items/agreement/recurring' to the response
Added the optional property 'transaction/items/agreement/type' to the response
Added the optional property 'transaction/items/authentication/3ds/transactionId' to the response
Added the optional property 'transaction/items/authentication/3ds2/directoryServerId' to the response
Added the optional property 'transaction/items/authentication/3ds2/protocolVersion' to the response
Added the optional property 'transaction/items/authentication/acceptVersions' to the response
Added the optional property 'transaction/items/authentication/channel' to the response
Added the optional property 'transaction/items/authentication/purpose' to the response
Added the optional property 'transaction/items/cruise' to the response
Added the optional property 'transaction/items/order/supply' to the response
Added the optional property 'transaction/items/order/valueTransfer' to the response
Added the optional property 'transaction/items/shipping/contact/sameAsBilling' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/paymentAccountReference' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/pbba' to the response
Added the optional property 'transaction/items/subgatewayMerchant/acquirer/items/merchantCategoryCode' to the response
The 'merchant' response's property pattern was changed

Operations

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

Breaking changes

The response property 'agreement/id' became optional
The response property ' Retrieve Transaction /agreement/id' became optional
Removed the optional property 'authentication/3ds1/xid' from the response
Removed the optional property 'order/recurringPaymentAgreement' from the response
Removed the optional property 'transaction/frequency' from the response
Added the new 'PBBA' enum value to the 'sourceOfFunds/type' response property
Removed the request property ' Verify /order/recurringPaymentAgreement'
Removed the request property ' Verify /transaction/frequency'
Removed the request property ' Authenticate Payer /transaction'
Removed the request property ' Initiate /transaction/frequency'
Removed the request property ' Authorize /3DSecure'
Removed the request property ' Authorize /authentication/3ds1/xid'
Removed the request property ' Authorize /authentication/3ds2/dsTransactionId'
Removed the request property ' Authorize /order/recurringPaymentAgreement'
Removed the request property ' Authorize /transaction/frequency'
Removed the request property ' Capture /3DSecure'
Removed the request property ' Capture /authentication/3ds1/xid'
Removed the request property ' Capture /authentication/3ds2/dsTransactionId'
Removed the request property ' Pay /3DSecure'
Removed the request property ' Pay /authentication/3ds1/xid'
Removed the request property ' Pay /authentication/3ds2/dsTransactionId'
Removed the request property ' Pay /order/recurringPaymentAgreement'
Removed the request property ' Pay /transaction/frequency'
Removed the optional property ' Retrieve Transaction /authentication/3ds1/xid' from the response
Removed the optional property ' Retrieve Transaction /order/recurringPaymentAgreement' from the response
Removed the optional property ' Retrieve Transaction /transaction/frequency' from the response
Removed the optional property ' Authenticate Payer /authentication/3ds1/xid' from the response
Removed the optional property ' Authenticate Payer /transaction/frequency' from the response
Added the new 'PBBA' enum value to the ' Retrieve Transaction /sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'agreement/expiryDate' to the response
Added the optional property 'agreement/recurring' to the response
Added the optional property 'agreement/type' to the response
Added the optional property 'authentication/3ds/transactionId' to the response
Added the optional property 'authentication/3ds2/directoryServerId' to the response
Added the optional property 'authentication/3ds2/protocolVersion' to the response
Added the optional property 'authentication/acceptVersions' to the response
Added the optional property 'authentication/channel' to the response
Added the optional property 'authentication/purpose' to the response
Added the optional property 'cruise' to the response
Added the optional property 'order/supply' to the response
Added the optional property 'order/valueTransfer' to the response
Added the optional property 'shipping/contact/sameAsBilling' to the response
Added the optional property 'sourceOfFunds/provided/card/paymentAccountReference' to the response
Added the optional property 'sourceOfFunds/provided/pbba' to the response
Added the optional property 'subgatewayMerchant/acquirer/items/merchantCategoryCode' to the response
Added the new optional request property ' Verify /agreement/expiryDate'
Added the new optional request property ' Verify /agreement/recurring'
Added the new optional request property ' Verify /agreement/type'
Added the new optional request property ' Authenticate Payer /agreement/type'
Added the new optional request property ' Initiate Authentication /subgatewayMerchant/acquirer/items/merchantCategoryCode'
Added the new optional request property ' Confirm /agreement/expiryDate'
Added the new optional request property ' Confirm /agreement/recurring'
Added the new optional request property ' Confirm /agreement/type'
Added the new optional request property ' Initiate /agreement/expiryDate'
Added the new optional request property ' Initiate /agreement/recurring'
Added the new optional request property ' Initiate /agreement/type'
Added the new optional request property ' Authorize /agreement/expiryDate'
Added the new optional request property ' Authorize /agreement/recurring'
Added the new optional request property ' Authorize /agreement/type'
Added the new optional request property ' Authorize /authentication/3ds/transactionId'
Added the new optional request property ' Authorize /authentication/3ds2/protocolVersion'
Added the new optional request property ' Authorize /authentication/3ds2/statusReasonCode'
Added the new optional request property ' Authorize /cruise'
Added the new optional request property ' Authorize /transaction/transit/aggregationStartDate'
Added the new optional request property ' Capture /agreement/expiryDate'
Added the new optional request property ' Capture /agreement/recurring'
Added the new optional request property ' Capture /agreement/type'
Added the new optional request property ' Capture /authentication/3ds/transactionId'
Added the new optional request property ' Capture /authentication/3ds2/protocolVersion'
Added the new optional request property ' Capture /authentication/3ds2/statusReasonCode'
Added the new optional request property ' Capture /cruise'
Added the new optional request property ' Capture /transaction/transit'
Added the new optional request property ' Pay /agreement/expiryDate'
Added the new optional request property ' Pay /agreement/recurring'
Added the new optional request property ' Pay /agreement/type'
Added the new optional request property ' Pay /authentication/3ds/transactionId'
Added the new optional request property ' Pay /authentication/3ds2/protocolVersion'
Added the new optional request property ' Pay /authentication/3ds2/statusReasonCode'
Added the new optional request property ' Pay /cruise'
Added the new optional request property ' Pay /sourceOfFunds/provided/pbba'
Added the new optional request property ' Refund /agreement/expiryDate'
Added the new optional request property ' Refund /agreement/recurring'
Added the new optional request property ' Refund /agreement/type'
Added the new optional request property ' Refund /cruise'
The request property ' Verify /agreement/id' became optional
The request property ' Confirm /agreement/id' became optional
The request property ' Initiate /agreement/id' became optional
The request property ' Authorize /agreement/id' became optional
The request property ' Capture /agreement/id' became optional
The request property ' Pay /agreement/id' became optional
The request property ' Refund /agreement/id' became optional
Added the new 'PBBA' enum value to the request property ' Pay /sourceOfFunds/type'
Added the optional property ' Retrieve Transaction /agreement/expiryDate' to the response
Added the optional property ' Retrieve Transaction /agreement/recurring' to the response
Added the optional property ' Retrieve Transaction /agreement/type' to the response
Added the optional property ' Retrieve Transaction /authentication/3ds/transactionId' to the response
Added the optional property ' Retrieve Transaction /authentication/3ds2/directoryServerId' to the response
Added the optional property ' Retrieve Transaction /authentication/3ds2/protocolVersion' to the response
Added the optional property ' Retrieve Transaction /authentication/acceptVersions' to the response
Added the optional property ' Retrieve Transaction /authentication/channel' to the response
Added the optional property ' Retrieve Transaction /authentication/purpose' to the response
Added the optional property ' Retrieve Transaction /cruise' to the response
Added the optional property ' Retrieve Transaction /order/supply' to the response
Added the optional property ' Retrieve Transaction /order/valueTransfer' to the response
Added the optional property ' Retrieve Transaction /shipping/contact/sameAsBilling' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/card/paymentAccountReference' to the response
Added the optional property ' Retrieve Transaction /sourceOfFunds/provided/pbba' to the response
Added the optional property ' Retrieve Transaction /subgatewayMerchant/acquirer/items/merchantCategoryCode' to the response
Added the optional property ' Authenticate Payer /agreement' to the response
Added the optional property ' Authenticate Payer /authentication/3ds/transactionId' to the response
Added the optional property ' Authenticate Payer /authentication/3ds2/directoryServerId' to the response
Added the optional property ' Authenticate Payer /authentication/3ds2/protocolVersion' to the response
Added the optional property ' Authenticate Payer /customer/account/authentication' to the response
Added the optional property ' Authenticate Payer /customer/account/history' to the response
Added the optional property ' Authenticate Payer /device' to the response
Added the optional property ' Authenticate Payer /order/supply' to the response
Added the optional property ' Authenticate Payer /order/valueTransfer' to the response
Added the optional property ' Authenticate Payer /shipping/contact/sameAsBilling' to the response
Added the optional property ' Authenticate Payer /sourceOfFunds/provided/pbba' to the response
Added the optional property ' Authenticate Payer /subgatewayMerchant/acquirer/items/merchantCategoryCode' to the response
Added the optional property ' Initiate Authentication /authentication/3ds2/directoryServerId' to the response
Added the optional property ' Initiate Authentication /authentication/purpose' to the response
Added the optional property ' Initiate Authentication /encryptedData' to the response
Added the optional property ' Initiate Authentication /sourceOfFunds/provided/pbba' to the response
Added the optional property ' Initiate Authentication /subgatewayMerchant/acquirer/items/merchantCategoryCode' to the response
Added the optional property ' Initiate Authentication /transaction/reference' to the response
The response property ' Authenticate Payer /customer/account/id' became required
Added the required property ' Authenticate Payer /order/amount' to the response
Added the required property ' Initiate Authentication /authentication/acceptVersions' to the response
Added the required property ' Initiate Authentication /authentication/channel' to the response

Operations

Payment Options Inquiry

Non-Breaking changes

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

Operations

Create Checkout Session

Breaking changes

Removed the request property ' Create Checkout Session /authentication/3ds1/xid'
Removed the request property ' Create Checkout Session /authentication/3ds2/dsTransactionId'
Removed the request property ' Create Checkout Session /order/recurringPaymentAgreement'
Removed the request property ' Create Checkout Session /transaction/frequency'

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /agreement/expiryDate'
Added the new optional request property ' Create Checkout Session /agreement/recurring'
Added the new optional request property ' Create Checkout Session /agreement/type'
Added the new optional request property ' Create Checkout Session /authentication/3ds/transactionId'
Added the new optional request property ' Create Checkout Session /authentication/3ds2/protocolVersion'
Added the new optional request property ' Create Checkout Session /authentication/3ds2/statusReasonCode'
Added the new optional request property ' Create Checkout Session /authentication/psd2'
Added the new optional request property ' Create Checkout Session /cruise'
Added the new optional request property ' Create Checkout Session /transaction/acquirer/traceId'
Added the new optional request property ' Create Checkout Session /transaction/transit/aggregationStartDate'
The request property ' Create Checkout Session /agreement/id' became optional

Operations

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

Breaking changes

Removed the optional property '3DSecure/acsEci' from the response
Removed the optional property '3DSecure/authenticationToken' from the response
Removed the optional property '3DSecure/paResStatus' from the response
Removed the optional property '3DSecure/veResEnrolled' from the response
Removed the optional property '3DSecure/xid' from the response
Removed the optional property 'authentication/3ds1/xid' from the response
Removed the optional property 'authentication/3ds2/dsTransactionId' from the response
Removed the optional property 'order/recurringPaymentAgreement' from the response
Removed the optional property 'transaction/frequency' from the response
Added the new 'PBBA' enum value to the 'paymentType' response property
Added the new 'PBBA' enum value to the 'sourceOfFunds/type' response property
Removed the optional property '3DSecure/acsEci' from the response
Removed the optional property '3DSecure/authenticationToken' from the response
Removed the optional property '3DSecure/paResStatus' from the response
Removed the optional property '3DSecure/veResEnrolled' from the response
Removed the optional property '3DSecure/xid' from the response
Removed the optional property 'authentication/3ds1/xid' from the response
Removed the optional property 'authentication/3ds2/dsTransactionId' from the response
Removed the optional property 'order/recurringPaymentAgreement' from the response
Removed the optional property 'transaction/frequency' from the response
Added the new 'PBBA' enum value to the 'paymentType' response property
Added the new 'PBBA' enum value to the 'sourceOfFunds/type' response property
Removed the request property '3DSecure/acsEci'
Removed the request property '3DSecure/authenticationToken'
Removed the request property '3DSecure/paResStatus'
Removed the request property '3DSecure/veResEnrolled'
Removed the request property '3DSecure/xid'
Removed the request property 'authentication/3ds1/xid'
Removed the request property 'authentication/3ds2/dsTransactionId'
Removed the request property 'order/recurringPaymentAgreement'
Removed the request property 'transaction/frequency'
Removed the optional property '3DSecure/acsEci' from the response
Removed the optional property '3DSecure/authenticationToken' from the response
Removed the optional property '3DSecure/paResStatus' from the response
Removed the optional property '3DSecure/veResEnrolled' from the response
Removed the optional property '3DSecure/xid' from the response
Removed the optional property 'authentication/3ds1/xid' from the response
Removed the optional property 'authentication/3ds2/dsTransactionId' from the response
Removed the optional property 'order/recurringPaymentAgreement' from the response
Removed the optional property 'transaction/frequency' from the response
Added the new 'PBBA' enum value to the 'paymentType' response property
Added the new 'PBBA' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'agreement/type' to the response
Added the optional property 'authentication/3ds/transactionId' to the response
Added the optional property 'authentication/3ds2/protocolVersion' to the response
Added the optional property 'authentication/3ds2/statusReasonCode' to the response
Added the optional property 'cruise' to the response
Added the optional property 'sourceOfFunds/provided/pbba' to the response
Added the optional property 'subgatewayMerchant/acquirer/items/merchantCategoryCode' to the response
Added the optional property 'transaction/transit/aggregationStartDate' to the response
Added the optional property 'agreement/type' to the response
Added the optional property 'authentication/3ds/transactionId' to the response
Added the optional property 'authentication/3ds2/protocolVersion' to the response
Added the optional property 'authentication/3ds2/statusReasonCode' to the response
Added the optional property 'cruise' to the response
Added the optional property 'sourceOfFunds/provided/pbba' to the response
Added the optional property 'subgatewayMerchant/acquirer/items/merchantCategoryCode' to the response
Added the optional property 'transaction/transit/aggregationStartDate' to the response
Added the new optional request property 'agreement/type'
Added the new optional request property 'authentication/3ds/transactionId'
Added the new optional request property 'authentication/3ds2/protocolVersion'
Added the new optional request property 'authentication/3ds2/statusReasonCode'
Added the new optional request property 'cruise'
Added the new optional request property 'sourceOfFunds/provided/pbba'
Added the new optional request property 'subgatewayMerchant/acquirer/items/merchantCategoryCode'
Added the new optional request property 'transaction/transit/aggregationStartDate'
The request property 'agreement/id' became optional
Added the new 'PBBA' enum value to the request property 'paymentType'
Added the new 'PBBA' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'agreement/type' to the response
Added the optional property 'authentication/3ds/transactionId' to the response
Added the optional property 'authentication/3ds2/protocolVersion' to the response
Added the optional property 'authentication/3ds2/statusReasonCode' to the response
Added the optional property 'cruise' to the response
Added the optional property 'sourceOfFunds/provided/pbba' to the response
Added the optional property 'subgatewayMerchant/acquirer/items/merchantCategoryCode' to the response
Added the optional property 'transaction/transit/aggregationStartDate' to the response

April 2019

Version 53

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Non-Breaking changes

Added the optional property '3DSecure/custom' to the response
Added the optional property '3DSecure/custom' to the response
Added the new optional request property 'order/walletProvider'
Added the new optional request property 'sourceOfFunds/provided/card/devicePayment'
The request property 'sourceOfFunds/provided/card/expiry' became optional
Added the optional property '3DSecure/custom' to the response

Operations

Balance Inquiry

Breaking changes

Added the new 'BANCOMER_MEMBERSHIP_REWARDS' enum value to the 'availableBalance/reward/program' response property

Operations

Retrieve Order

Breaking changes

Added the new 'AUTHENTICATION_EXEMPT' enum value to the 'authenticationStatus' response property
Added the new 'AUTHENTICATION_EXEMPT' enum value to the 'transaction/items/transaction/authenticationStatus' response property
Added the new 'AUTHENTICATION_NOT_IN_EFFECT' enum value to the 'authenticationStatus' response property
Added the new 'AUTHENTICATION_NOT_IN_EFFECT' enum value to the 'transaction/items/transaction/authenticationStatus' response property
Added the new 'AUTHENTICATION_NOT_NEEDED' enum value to the 'status' response property
Added the new 'AUTHENTICATION_NOT_NEEDED' enum value to the 'transaction/items/order/status' response property
Added the new 'AUTHENTICATION_REQUIRED' enum value to the 'authenticationStatus' response property
Added the new 'AUTHENTICATION_REQUIRED' enum value to the 'transaction/items/transaction/authenticationStatus' response property
Added the new 'BANCOMER_MEMBERSHIP_REWARDS' enum value to the 'reward/program' response property
Added the new 'BANCOMER_MEMBERSHIP_REWARDS' enum value to the 'transaction/items/order/reward/program' response property
Added the new 'PROCEED' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the 'transaction/items/order/walletProvider' response property
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the 'walletProvider' response property

Non-Breaking changes

Added the optional property 'transaction/items/3DSecure/custom' to the response
Added the optional property 'transaction/items/authentication/3ds2/statusReasonCode' to the response
Added the optional property 'transaction/items/authentication/psd2' to the response
Added the optional property 'transaction/items/order/authenticationStatus' to the response
Added the optional property 'transaction/items/order/wallet/secureRemoteCommerce' to the response
Added the optional property 'transaction/items/subgatewayMerchant/acquirer/items/3DS1' to the response
Added the optional property 'transaction/items/subgatewayMerchant/acquirer/items/countryCode' to the response
Added the optional property 'transaction/items/subgatewayMerchant/acquirer/items/fraudRate' to the response
Added the optional property 'wallet/secureRemoteCommerce' to the response
Removed the 'PROCEED_WITH_AUTHENTICATION' enum value from the 'transaction/items/response/gatewayRecommendation' response property
Removed the 'PROCEED_WITH_PAYMENT' enum value from the 'transaction/items/response/gatewayRecommendation' response property
The 'merchant' response's property pattern was changed

Operations

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

Breaking changes

Added the new 'AUTHENTICATION_EXEMPT' enum value to the 'transaction/authenticationStatus' response property
Added the new 'AUTHENTICATION_NOT_IN_EFFECT' enum value to the 'transaction/authenticationStatus' response property
Added the new 'AUTHENTICATION_NOT_NEEDED' enum value to the 'order/status' response property
Added the new 'AUTHENTICATION_REQUIRED' enum value to the 'transaction/authenticationStatus' response property
Added the new 'BANCOMER_MEMBERSHIP_REWARDS' enum value to the 'order/reward/program' response property
Added the new 'PROCEED' enum value to the 'response/gatewayRecommendation' response property
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the 'order/walletProvider' response property
Added the new 'ATTEMPT_WITH_AUTHENTICATION' enum value to the ' Authenticate Payer /response/gatewayRecommendation' response property
Added the new 'ATTEMPT_WITH_AUTHENTICATION' enum value to the ' Initiate Authentication /response/gatewayRecommendation' response property
Added the new 'AUTHENTICATION_EXEMPT' enum value to the ' Retrieve Transaction /transaction/authenticationStatus' response property
Added the new 'AUTHENTICATION_NOT_IN_EFFECT' enum value to the ' Retrieve Transaction /transaction/authenticationStatus' response property
Added the new 'AUTHENTICATION_NOT_NEEDED' enum value to the ' Retrieve Transaction /order/status' response property
Added the new 'AUTHENTICATION_REQUIRED' enum value to the ' Retrieve Transaction /transaction/authenticationStatus' response property
Added the new 'BANCOMER_MEMBERSHIP_REWARDS' enum value to the ' Retrieve Transaction /order/reward/program' response property
Added the new 'PROCEED' enum value to the ' Retrieve Transaction /response/gatewayRecommendation' response property
Added the new 'PROCEED' enum value to the ' Authenticate Payer /response/gatewayRecommendation' response property
Added the new 'PROCEED' enum value to the ' Initiate Authentication /response/gatewayRecommendation' response property
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the ' Retrieve Transaction /order/walletProvider' response property

Non-Breaking changes

Added the optional property '3DSecure/custom' to the response
Added the optional property 'authentication/3ds2/statusReasonCode' to the response
Added the optional property 'authentication/psd2' to the response
Added the optional property 'order/authenticationStatus' to the response
Added the optional property 'order/wallet/secureRemoteCommerce' to the response
Added the optional property 'subgatewayMerchant/acquirer/items/3DS1' to the response
Added the optional property 'subgatewayMerchant/acquirer/items/countryCode' to the response
Added the optional property 'subgatewayMerchant/acquirer/items/fraudRate' to the response
Removed the 'PROCEED_WITH_AUTHENTICATION' enum value from the 'response/gatewayRecommendation' response property
Removed the 'PROCEED_WITH_PAYMENT' enum value from the 'response/gatewayRecommendation' response property
Added the new optional request property ' Update Authorization /order/discount'
Added the new optional request property ' Update Authorization /order/gratuityAmount'
Added the new optional request property ' Update Authorization /order/itemAmount'
Added the new optional request property ' Update Authorization /order/netAmount'
Added the new optional request property ' Update Authorization /order/shippingAndHandlingAmount'
Added the new optional request property ' Update Authorization /order/surchargeAmount'
Added the new optional request property ' Update Authorization /order/taxAmount'
Added the new optional request property ' Verify /transaction/acquirer/traceId'
Added the new optional request property ' Void /transaction/acquirer'
Added the new optional request property ' Authenticate Payer /authentication/psd2'
Added the new optional request property ' Confirm /session'
Added the new optional request property ' Authorize /authentication/psd2'
Added the new optional request property ' Authorize /transaction/acquirer/traceId'
Added the new optional request property ' Pay /authentication/psd2'
Added the new optional request property ' Pay /transaction/acquirer/traceId'
The request property ' Authorize /sourceOfFunds/provided/card/devicePayment/3DSecure/onlinePaymentCryptogram' became optional
The request property ' Pay /sourceOfFunds/provided/card/devicePayment/3DSecure/onlinePaymentCryptogram' became optional
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the request property ' Verify /order/walletProvider'
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the request property ' Authorize /order/walletProvider'
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the request property ' Capture /order/walletProvider'
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the request property ' Pay /order/walletProvider'
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the request property ' Refund /order/walletProvider'
Added the optional property ' Retrieve Transaction /3DSecure/custom' to the response
Added the optional property ' Retrieve Transaction /authentication/3ds2/statusReasonCode' to the response
Added the optional property ' Retrieve Transaction /authentication/psd2' to the response
Added the optional property ' Retrieve Transaction /order/authenticationStatus' to the response
Added the optional property ' Retrieve Transaction /order/wallet/secureRemoteCommerce' to the response
Added the optional property ' Retrieve Transaction /subgatewayMerchant/acquirer/items/3DS1' to the response
Added the optional property ' Retrieve Transaction /subgatewayMerchant/acquirer/items/countryCode' to the response
Added the optional property ' Retrieve Transaction /subgatewayMerchant/acquirer/items/fraudRate' to the response
Added the optional property ' Authenticate Payer /authentication/3ds2/statusReasonCode' to the response
Added the optional property ' Authenticate Payer /authentication/psd2' to the response
Added the optional property ' Authenticate Payer /order/authenticationStatus' to the response
Added the optional property ' Initiate Authentication /order/authenticationStatus' to the response
Removed the 'PROCEED_WITH_AUTHENTICATION' enum value from the ' Retrieve Transaction /response/gatewayRecommendation' response property
Removed the 'PROCEED_WITH_AUTHENTICATION' enum value from the ' Authenticate Payer /response/gatewayRecommendation' response property
Removed the 'PROCEED_WITH_AUTHENTICATION' enum value from the ' Initiate Authentication /response/gatewayRecommendation' response property
Removed the 'PROCEED_WITH_PAYMENT' enum value from the ' Retrieve Transaction /response/gatewayRecommendation' response property
Removed the 'PROCEED_WITH_PAYMENT' enum value from the ' Authenticate Payer /response/gatewayRecommendation' response property
Removed the 'PROCEED_WITH_PAYMENT' enum value from the ' Initiate Authentication /response/gatewayRecommendation' response property

Operations

Payment Options Inquiry

Breaking changes

Added the new 'SECURE_REMOTE_COMMERCE' enum value to the 'paymentTypes/card/walletProviders/items/walletProvider' response property

Non-Breaking changes

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

Operations

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

Non-Breaking changes

Added the optional property 'authentication/psd2' to the response
Added the optional property 'transaction/acquirer/traceId' to the response
Added the optional property 'wallet/secureRemoteCommerce' to the response
Added the new optional request property ' Update Session From Wallet /wallet/secureRemoteCommerce'
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the request property ' Update Session From Wallet /order/walletProvider'
Added the optional property 'authentication/psd2' to the response
Added the optional property 'transaction/acquirer/traceId' to the response
Added the optional property 'wallet/secureRemoteCommerce' to the response
Added the new optional request property 'authentication/psd2'
Added the new optional request property 'transaction/acquirer/traceId'
Added the new optional request property 'wallet/secureRemoteCommerce'
Added the optional property 'authentication/psd2' to the response
Added the optional property 'transaction/acquirer/traceId' to the response
Added the optional property 'wallet/secureRemoteCommerce' to the response

January 2019

Version 52

Operations

Create or Update Browser Payment Token

Breaking changes

Added the new required request property 'sourceOfFunds/provided/paypal/billingAgreement/cardinality'

Non-Breaking changes

Added the new optional request property 'shipping/origin'
Added the new optional request property 'sourceOfFunds/provided/ideal'
Added the new 'KLARNA' enum value to the request property 'sourceOfFunds/type'

Operations

Retrieve Order

Breaking changes

The 'transaction/items/authorizationResponse/transactionIdentifier' response property's maxLength was increased from '15' to '30'
Added the new '3DS1' enum value to the 'authenticationVersion' response property
Added the new '3DS2' enum value to the 'authenticationVersion' response property
Added the new 'ATTEMPT_WITH_AUTHENTICATION' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'KLARNA' enum value to the 'sourceOfFunds/type' response property
Added the new 'KLARNA' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'MERCHANT' enum value to the 'transaction/items/transaction/source' response property
Added the new 'PROCEED_WITH_AUTHENTICATION' enum value to the 'transaction/items/response/gatewayRecommendation' response property
Added the new 'PROCEED_WITH_PAYMENT' enum value to the 'transaction/items/response/gatewayRecommendation' response property

Non-Breaking changes

Added the optional property 'agreement' to the response
Added the optional property 'billing/address/stateProvinceCode' to the response
Added the optional property 'shipping/address/sameAsBilling' to the response
Added the optional property 'shipping/address/source' to the response
Added the optional property 'shipping/address/stateProvinceCode' to the response
Added the optional property 'sourceOfFunds/provided/paypal/billingAgreement' to the response
Added the optional property 'sourceOfFunds/provided/paypal/payerId' to the response
Added the optional property 'transaction/items/agreement' to the response
Added the optional property 'transaction/items/authentication' to the response
Added the optional property 'transaction/items/billing/address/stateProvinceCode' to the response
Added the optional property 'transaction/items/shipping/address/sameAsBilling' to the response
Added the optional property 'transaction/items/shipping/address/source' to the response
Added the optional property 'transaction/items/shipping/address/stateProvinceCode' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/paypal/billingAgreement' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/paypal/payerId' to the response
Removed the 'ATTEMPT_WITH_3DS' enum value from the 'transaction/items/response/gatewayRecommendation' response property
Removed the 'PROCEED' enum value from the 'transaction/items/response/gatewayRecommendation' response property
Removed the 'THREEDS1' enum value from the 'authenticationVersion' response property
Removed the 'THREEDS2' enum value from the 'authenticationVersion' response property
The 'merchant' response's property pattern was changed

Operations

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

Breaking changes

The 'authorizationResponse/transactionIdentifier' response property's maxLength was increased from '15' to '30'
Removed the success response
Added the new 'ATTEMPT_WITH_AUTHENTICATION' enum value to the 'response/gatewayRecommendation' response property
Added the new 'KLARNA' enum value to the 'sourceOfFunds/type' response property
Added the new 'MERCHANT' enum value to the 'transaction/source' response property
Added the new 'PROCEED_WITH_AUTHENTICATION' enum value to the 'response/gatewayRecommendation' response property
Added the new 'PROCEED_WITH_PAYMENT' enum value to the 'response/gatewayRecommendation' response property
Removed the request property ' Initiate /sourceOfFunds/provided/sepa/bic'

Non-Breaking changes

Added the optional property 'agreement' to the response
Added the optional property 'authentication' to the response
Added the optional property 'billing/address/stateProvinceCode' to the response
Added the optional property 'shipping/address/sameAsBilling' to the response
Added the optional property 'shipping/address/source' to the response
Added the optional property 'shipping/address/stateProvinceCode' to the response
Added the optional property 'sourceOfFunds/provided/paypal/billingAgreement' to the response
Added the optional property 'sourceOfFunds/provided/paypal/payerId' to the response
Removed the 'ATTEMPT_WITH_3DS' enum value from the 'response/gatewayRecommendation' response property
Removed the 'PROCEED' enum value from the 'response/gatewayRecommendation' response property
Api operation id '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' removed and replaced with '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'
Api tag 'Authentication' added
Added the new optional request property ' Confirm /agreement'
Added the new optional request property ' Confirm /shipping'
Added the new optional request property ' Initiate /agreement'
Added the new optional request property ' Initiate /billing/address/stateProvinceCode'
Added the new optional request property ' Initiate /customer/firstName'
Added the new optional request property ' Initiate /customer/lastName'
Added the new optional request property ' Initiate /device'
Added the new optional request property ' Initiate /risk'
Added the new optional request property ' Initiate /shipping/origin'
Added the new optional request property ' Initiate /sourceOfFunds/provided/ideal'
Added the new optional request property ' Authorize /agreement'
Added the new optional request property ' Authorize /authentication'
Added the new optional request property ' Authorize /billing/address/stateProvinceCode'
Added the new optional request property ' Authorize /shipping/address/sameAsBilling'
Added the new optional request property ' Authorize /shipping/address/source'
Added the new optional request property ' Authorize /shipping/address/stateProvinceCode'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/maskedFpan'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/maskedFpanExpiry'
Added the new optional request property ' Capture /agreement'
Added the new optional request property ' Capture /authentication'
Added the new optional request property ' Capture /billing/address/stateProvinceCode'
Added the new optional request property ' Capture /posTerminal/store'
Added the new optional request property ' Capture /shipping/address/sameAsBilling'
Added the new optional request property ' Capture /shipping/address/source'
Added the new optional request property ' Capture /shipping/address/stateProvinceCode'
Added the new optional request property ' Capture /sourceOfFunds/provided/card/maskedFpan'
Added the new optional request property ' Capture /sourceOfFunds/provided/card/maskedFpanExpiry'
Added the new optional request property ' Pay /agreement'
Added the new optional request property ' Pay /authentication'
Added the new optional request property ' Pay /billing/address/stateProvinceCode'
Added the new optional request property ' Pay /shipping/address/sameAsBilling'
Added the new optional request property ' Pay /shipping/address/source'
Added the new optional request property ' Pay /shipping/address/stateProvinceCode'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/maskedFpan'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/maskedFpanExpiry'
Added the new optional request property ' Refund /agreement'
Added the new optional request property ' Refund /billing/address/stateProvinceCode'
Added the new optional request property ' Refund /shipping/address/sameAsBilling'
Added the new optional request property ' Refund /shipping/address/source'
Added the new optional request property ' Refund /shipping/address/stateProvinceCode'
Added the new optional request property ' Refund /sourceOfFunds/provided/card/maskedFpan'
Added the new optional request property ' Refund /sourceOfFunds/provided/card/maskedFpanExpiry'
Added the new optional request property ' Verify /agreement'
Added the new optional request property ' Verify /billing/address/stateProvinceCode'
Added the new optional request property ' Verify /shipping/address/sameAsBilling'
Added the new optional request property ' Verify /shipping/address/source'
Added the new optional request property ' Verify /shipping/address/stateProvinceCode'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/maskedFpan'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/maskedFpanExpiry'
Added ' authenticate_payer_request, initiate_authentication_request' to the request body 'oneOf' list
Added the new 'KLARNA' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'MERCHANT' enum value to the request property ' Authorize /transaction/source'
Added the new 'MERCHANT' enum value to the request property ' Capture /transaction/source'
Added the new 'MERCHANT' enum value to the request property ' Pay /transaction/source'
Added the new 'MERCHANT' enum value to the request property ' Refund /transaction/source'
Added the new 'MERCHANT' enum value to the request property ' Verify /transaction/source'
Added the success response

Operations

Payment Options Inquiry

Breaking changes

Removed the required property 'transactionMode' from the response
Added the new 'MERCHANT' enum value to the 'paymentTypes/ach/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/alipay/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/bancanet/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/boletobancario/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/card/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/enets/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/giftCard/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/giropay/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/ideal/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/oxxo/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/paypal/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/poli/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/sepa/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/sofort/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/unionpay/transactionSources/items/transactionSource' response property
Added the new 'MERCHANT' enum value to the 'paymentTypes/wechatpay/transactionSources/items/transactionSource' response property

Non-Breaking changes

Added the new enum value 'MERCHANT' to the 'query' request parameter 'transactionSource'
Added the optional property 'paymentTypes/card/cardTypes/items/schemeTokenTypes' to the response
Added the optional property 'paymentTypes/klarna' to the response
Added the optional property 'supportedPaymentOperations' to the response

Operations

Create Checkout Session

Breaking changes

The request property ' Create Checkout Session /interaction' became required
The request property ' Create Checkout Session /interaction/operation' became required

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /agreement'
Added the new optional request property ' Create Checkout Session /authentication'
Added the new optional request property ' Create Checkout Session /billing/address/stateProvinceCode'
Added the new optional request property ' Create Checkout Session /shipping/address/sameAsBilling'
Added the new optional request property ' Create Checkout Session /shipping/address/source'
Added the new optional request property ' Create Checkout Session /shipping/address/stateProvinceCode'
Added the new 'AUTHORIZE' enum value to the request property ' Create Checkout Session /interaction/operation'
Added the new 'PURCHASE' enum value to the request property ' Create Checkout Session /interaction/operation'

Operations

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

Breaking changes

Added the new 'KLARNA' enum value to the 'sourceOfFunds/type' response property
Added the new 'MERCHANT' enum value to the 'transaction/source' response property
Added the new 'MERCHANT' enum value to the 'transactionSource' response property
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the 'order/walletProvider' response property
Added the new 'KLARNA' enum value to the 'sourceOfFunds/type' response property
Added the new 'MERCHANT' enum value to the 'transaction/source' response property
Added the new 'MERCHANT' enum value to the 'transactionSource' response property
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the 'order/walletProvider' response property
Added the new 'KLARNA' enum value to the 'sourceOfFunds/type' response property
Added the new 'MERCHANT' enum value to the 'transaction/source' response property
Added the new 'MERCHANT' enum value to the 'transactionSource' response property
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the 'order/walletProvider' response property

Non-Breaking changes

Added the optional property 'agreement' to the response
Added the optional property 'authentication' to the response
Added the optional property 'billing/address/stateProvinceCode' 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 'device/browserDetails' to the response
Added the optional property 'order/subMerchant/authentication' to the response
Added the optional property 'order/subMerchant/websiteUrl' to the response
Added the optional property 'order/supply' to the response
Added the optional property 'order/valueTransfer' to the response
Added the optional property 'shipping/address/sameAsBilling' to the response
Added the optional property 'shipping/address/source' to the response
Added the optional property 'shipping/address/stateProvinceCode' to the response
Added the optional property 'shipping/contact/sameAsBilling' to the response
Added the optional property 'sourceOfFunds/provided/card/maskedFpan' to the response
Added the optional property 'sourceOfFunds/provided/card/maskedFpanExpiry' to the response
Added the optional property 'sourceOfFunds/provided/ideal' to the response
Added the optional property 'sourceOfFunds/provided/paypal/billingAgreement/cardinality' to the response
Added the optional property 'subgatewayMerchant' to the response
Added the optional property 'agreement' to the response
Added the optional property 'authentication' to the response
Added the optional property 'billing/address/stateProvinceCode' 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 'device/browserDetails' to the response
Added the optional property 'order/subMerchant/authentication' to the response
Added the optional property 'order/subMerchant/websiteUrl' to the response
Added the optional property 'order/supply' to the response
Added the optional property 'order/valueTransfer' to the response
Added the optional property 'shipping/address/sameAsBilling' to the response
Added the optional property 'shipping/address/source' to the response
Added the optional property 'shipping/address/stateProvinceCode' to the response
Added the optional property 'shipping/contact/sameAsBilling' to the response
Added the optional property 'sourceOfFunds/provided/card/maskedFpan' to the response
Added the optional property 'sourceOfFunds/provided/card/maskedFpanExpiry' to the response
Added the optional property 'sourceOfFunds/provided/ideal' to the response
Added the optional property 'sourceOfFunds/provided/paypal/billingAgreement/cardinality' to the response
Added the optional property 'subgatewayMerchant' to the response
Added the new optional request property 'agreement'
Added the new optional request property 'authentication'
Added the new optional request property 'billing/address/stateProvinceCode'
Added the new optional request property 'customer/account/authentication'
Added the new optional request property 'customer/account/history'
Added the new optional request property 'device/browserDetails'
Added the new optional request property 'order/subMerchant/authentication'
Added the new optional request property 'order/subMerchant/websiteUrl'
Added the new optional request property 'order/supply'
Added the new optional request property 'order/valueTransfer'
Added the new optional request property 'shipping/address/sameAsBilling'
Added the new optional request property 'shipping/address/source'
Added the new optional request property 'shipping/address/stateProvinceCode'
Added the new optional request property 'shipping/contact/sameAsBilling'
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/ideal'
Added the new optional request property 'sourceOfFunds/provided/paypal/billingAgreement/cardinality'
Added the new optional request property 'subgatewayMerchant'
Added the new 'KLARNA' enum value to the request property 'sourceOfFunds/type'
Added the new 'MERCHANT' enum value to the request property 'transaction/source'
Added the new 'MERCHANT' enum value to the request property 'transactionSource'
Added the new 'SECURE_REMOTE_COMMERCE' enum value to the request property 'order/walletProvider'
Added the optional property 'agreement' to the response
Added the optional property 'authentication' to the response
Added the optional property 'billing/address/stateProvinceCode' 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 'device/browserDetails' to the response
Added the optional property 'order/subMerchant/authentication' to the response
Added the optional property 'order/subMerchant/websiteUrl' to the response
Added the optional property 'order/supply' to the response
Added the optional property 'order/valueTransfer' to the response
Added the optional property 'shipping/address/sameAsBilling' to the response
Added the optional property 'shipping/address/source' to the response
Added the optional property 'shipping/address/stateProvinceCode' to the response
Added the optional property 'shipping/contact/sameAsBilling' to the response
Added the optional property 'sourceOfFunds/provided/card/maskedFpan' to the response
Added the optional property 'sourceOfFunds/provided/card/maskedFpanExpiry' to the response
Added the optional property 'sourceOfFunds/provided/ideal' to the response
Added the optional property 'sourceOfFunds/provided/paypal/billingAgreement/cardinality' to the response
Added the optional property 'subgatewayMerchant' to the response

Operations

Delete Token , Retrieve Token , Create or Update Token

Non-Breaking changes

Added the optional property 'shipping/address/sameAsBilling' to the response
Added the optional property 'shipping/address/source' to the response
Added the optional property 'shipping/address/stateProvinceCode' to the response
Added the optional property 'sourceOfFunds/provided/paypal/billingAgreement/cardinality' to the response

Operations

Search Tokens

Breaking changes

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

Non-Breaking changes

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

October 2018

Version 51

Operations

Create or Update Browser Payment Token

Non-Breaking changes

Endpoint added

Operations

Balance Inquiry

Breaking changes

The response property 'availableBalance/reward/amount' became optional
The response property 'availableBalance/reward/conversionRate' became optional
The response property 'availableBalance/reward/currency' became optional
The response property 'availableBalance/reward/incrementalSpendAmount' became optional
The response property 'availableBalance/reward/maximumSpendAmount' became optional
The response property 'availableBalance/reward/minimumSpendAmount' became optional
The response property 'availableBalance/reward/points' became optional
Added the new 'BALANCE_UNKNOWN' enum value to the 'response/gatewayCode' response property

Non-Breaking changes

Added the optional property 'availableBalance/reward/payerNominatedAmount' to the response

Operations

Retrieve Order

Breaking changes

The response property 'reward/amount' became optional
The response property 'transaction/items/order/reward/amount' became optional
Added the new 'ACTION_REQUIRED' enum value to the 'transaction/items/transaction/dispute/event' response property
Added the new 'AUTHENTICATED' enum value to the 'status' response property
Added the new 'AUTHENTICATED' enum value to the 'transaction/items/order/status' response property
Added the new 'AUTHENTICATION_INITIATED' enum value to the 'status' response property
Added the new 'AUTHENTICATION_INITIATED' enum value to the 'transaction/items/order/status' response property
Added the new 'AUTHENTICATION_IN_PROGRESS' enum value to the 'transaction/items/response/gatewayCode' response property
Added the new 'AUTHENTICATION_UNSUCCESSFUL' enum value to the 'status' response property
Added the new 'AUTHENTICATION_UNSUCCESSFUL' enum value to the 'transaction/items/order/status' response property
Added the new 'BALANCE_UNKNOWN' enum value to the 'transaction/items/response/gatewayCode' response property
Added the new 'INFORMATION_ONLY' enum value to the 'transaction/items/transaction/dispute/event' response property
Added the new 'SCHEME_TOKEN' enum value to the 'sourceOfFunds/type' response property
Added the new 'SCHEME_TOKEN' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property '3dsAcsEci' to the response
Added the optional property 'authenticationStatus' to the response
Added the optional property 'authenticationVersion' to the response
Added the optional property 'reward/availableBalance' to the response
Added the optional property 'reward/previousBalance' to the response
Added the optional property 'sourceOfFunds/provided/sepa/bic' to the response
Added the optional property 'transaction/items/order/reward/availableBalance' to the response
Added the optional property 'transaction/items/order/reward/previousBalance' to the response
Added the optional property 'transaction/items/response/onBehalfOfOperation' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/sepa/bic' to the response
Added the optional property 'transaction/items/subgatewayMerchant' to the response
Added the optional property 'transaction/items/transaction/authenticationStatus' to the response
Added the optional property 'transaction/items/transaction/authorizationAdjustmentActions' to the response
Added the optional property 'transaction/items/transaction/dispute/eventInformation' to the response
Added the optional property 'transaction/items/transaction/dispute/match/RRN' to the response
Added the optional property 'transaction/items/transaction/dispute/match/acquirerTransactionId' to the response
Added the optional property 'transaction/items/transaction/funding/acquirerEventDescription' to the response
Added the optional property 'transaction/items/transaction/funding/settlementIdentifier' to the response
Removed the 'CHARGEBACK_PENDING' enum value from the 'transaction/items/transaction/dispute/event' response property
Removed the 'INFORMATION_RECEIVED' enum value from the 'transaction/items/transaction/dispute/event' response property
Removed the 'INFORMATION_REQUESTED' enum value from the 'transaction/items/transaction/dispute/event' response property
Removed the 'INFORMATION_REQUEST_OUTSTANDING' enum value from the 'transaction/items/transaction/dispute/event' response property
Removed the 'RECURRING_PAYMENT_CANCELLED' enum value from the 'transaction/items/transaction/dispute/event' response property
The 'transaction/items/transaction/dispute/match/stan' response's property pattern '^[0-9]*$' was added
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

The response property 'order/reward/amount' became optional
The request property ' Authorize /order/reward/balanceId' became required
The request property ' Pay /order/reward/balanceId' became required
The response property 'order/reward/amount' became optional
Added the new 'ACTION_REQUIRED' enum value to the 'transaction/dispute/event' response property
Added the new 'AUTHENTICATED' enum value to the 'order/status' response property
Added the new 'AUTHENTICATION_INITIATED' enum value to the 'order/status' response property
Added the new 'AUTHENTICATION_IN_PROGRESS' enum value to the 'response/gatewayCode' response property
Added the new 'AUTHENTICATION_UNSUCCESSFUL' enum value to the 'order/status' response property
Added the new 'BALANCE_UNKNOWN' enum value to the 'response/gatewayCode' response property
Added the new 'INFORMATION_ONLY' enum value to the 'transaction/dispute/event' response property
Added the new 'SCHEME_TOKEN' enum value to the 'sourceOfFunds/type' response property
Added the new 'ACTION_REQUIRED' enum value to the 'transaction/dispute/event' response property
Added the new 'AUTHENTICATED' enum value to the 'order/status' response property
Added the new 'AUTHENTICATION_INITIATED' enum value to the 'order/status' response property
Added the new 'AUTHENTICATION_IN_PROGRESS' enum value to the 'response/gatewayCode' response property
Added the new 'AUTHENTICATION_UNSUCCESSFUL' enum value to the 'order/status' response property
Added the new 'BALANCE_UNKNOWN' enum value to the 'response/gatewayCode' response property
Added the new 'INFORMATION_ONLY' enum value to the 'transaction/dispute/event' response property
Added the new 'SCHEME_TOKEN' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'order/reward/availableBalance' to the response
Added the optional property 'order/reward/previousBalance' to the response
Added the optional property 'response/onBehalfOfOperation' to the response
Added the optional property 'sourceOfFunds/provided/sepa/bic' to the response
Added the optional property 'subgatewayMerchant' to the response
Added the optional property 'transaction/authenticationStatus' to the response
Added the optional property 'transaction/authorizationAdjustmentActions' to the response
Added the optional property 'transaction/dispute/eventInformation' to the response
Added the optional property 'transaction/dispute/match/RRN' to the response
Added the optional property 'transaction/dispute/match/acquirerTransactionId' to the response
Added the optional property 'transaction/funding/acquirerEventDescription' to the response
Added the optional property 'transaction/funding/settlementIdentifier' to the response
Removed the 'CHARGEBACK_PENDING' enum value from the 'transaction/dispute/event' response property
Removed the 'INFORMATION_RECEIVED' enum value from the 'transaction/dispute/event' response property
Removed the 'INFORMATION_REQUESTED' enum value from the 'transaction/dispute/event' response property
Removed the 'INFORMATION_REQUEST_OUTSTANDING' enum value from the 'transaction/dispute/event' response property
Removed the 'RECURRING_PAYMENT_CANCELLED' enum value from the 'transaction/dispute/event' response property
The 'transaction/dispute/match/stan' response's property pattern '^[0-9]*$' was added
Added the new optional request property ' Initiate /sourceOfFunds/provided/sepa/bic'
Added the new optional request property ' Capture /transaction/authorizationAdjustmentActions'
Added the new optional request property ' Refund /billing'
Added the new optional request property ' Refund /posTerminal/store'
Added the new optional request property ' Refund /shipping'
Added the new optional request property ' Refund /sourceOfFunds/provided/sepa'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/devicePayment'
Added the new optional request property ' Verify /transaction/acquirer'
The request property ' Authorize /order/reward/amount' became optional
The request property ' Pay /order/reward/amount' became optional
Added the new 'PAYER_PRESENT' enum value to the request property ' Refund /transaction/source'
Added the new 'SCHEME_TOKEN' enum value to the request property ' Authorize /sourceOfFunds/type'
Added the new 'SCHEME_TOKEN' enum value to the request property ' Capture /sourceOfFunds/type'
Added the new 'SCHEME_TOKEN' enum value to the request property ' Pay /sourceOfFunds/type'
Added the new 'SCHEME_TOKEN' enum value to the request property ' Refund /sourceOfFunds/type'
Added the new 'SCHEME_TOKEN' enum value to the request property ' Verify /sourceOfFunds/type'
Added the new 'SEPA' enum value to the request property ' Refund /sourceOfFunds/type'
Added the optional property 'order/reward/availableBalance' to the response
Added the optional property 'order/reward/previousBalance' to the response
Added the optional property 'response/onBehalfOfOperation' to the response
Added the optional property 'sourceOfFunds/provided/sepa/bic' to the response
Added the optional property 'subgatewayMerchant' to the response
Added the optional property 'transaction/authenticationStatus' to the response
Added the optional property 'transaction/authorizationAdjustmentActions' to the response
Added the optional property 'transaction/dispute/eventInformation' to the response
Added the optional property 'transaction/dispute/match/RRN' to the response
Added the optional property 'transaction/dispute/match/acquirerTransactionId' to the response
Added the optional property 'transaction/funding/acquirerEventDescription' to the response
Added the optional property 'transaction/funding/settlementIdentifier' to the response
Removed the 'CHARGEBACK_PENDING' enum value from the 'transaction/dispute/event' response property
Removed the 'INFORMATION_RECEIVED' enum value from the 'transaction/dispute/event' response property
Removed the 'INFORMATION_REQUESTED' enum value from the 'transaction/dispute/event' response property
Removed the 'INFORMATION_REQUEST_OUTSTANDING' enum value from the 'transaction/dispute/event' response property
Removed the 'RECURRING_PAYMENT_CANCELLED' enum value from the 'transaction/dispute/event' response property
The 'transaction/dispute/match/stan' response's property pattern '^[0-9]*$' was added

Operations

Create Checkout Session

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /interaction/timeout'
Added the new optional request property ' Create Checkout Session /interaction/timeoutUrl'

Operations

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

Breaking changes

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

Non-Breaking changes

Added the optional property 'browserPayment/paypal/agreementConfirmation' to the response
Added the optional property 'sourceOfFunds/provided/paypal' to the response
Added the optional property 'sourceOfFunds/provided/sepa/bic' to the response
Added the optional property 'transaction/authorizationAdjustmentActions' to the response
Added the optional property 'browserPayment/paypal/agreementConfirmation' to the response
Added the optional property 'sourceOfFunds/provided/paypal' to the response
Added the optional property 'sourceOfFunds/provided/sepa/bic' to the response
Added the optional property 'transaction/authorizationAdjustmentActions' to the response
Added the new optional request property 'browserPayment/paypal/agreementConfirmation'
Added the new optional request property 'sourceOfFunds/provided/paypal'
Added the new optional request property 'sourceOfFunds/provided/sepa/bic'
Added the new optional request property 'transaction/authorizationAdjustmentActions'
Added the new 'SCHEME_TOKEN' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'browserPayment/paypal/agreementConfirmation' to the response
Added the optional property 'sourceOfFunds/provided/paypal' to the response
Added the optional property 'sourceOfFunds/provided/sepa/bic' to the response
Added the optional property 'transaction/authorizationAdjustmentActions' to the response

Operations

Create or Update Token (with system-generated token)

Non-Breaking changes

Added the new optional request property 'sourceOfFunds/tokenRequestorID'

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

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

Non-Breaking changes

Added the optional property 'shipping' to the response
Added the optional property 'sourceOfFunds/provided/paypal' to the response
Added the new optional request property 'sourceOfFunds/tokenRequestorID'

July 2018

Version 50

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Breaking changes

Added the new 'FTT' enum value to the 'currencyConversion/provider' response property
Added the new 'GLOBAL_PAYMENTS' enum value to the 'currencyConversion/provider' response property
Added the new 'IBM' enum value to the 'currencyConversion/provider' response property
Added the new 'UNICREDIT' enum value to the 'currencyConversion/provider' response property
Added the new 'FTT' enum value to the 'currencyConversion/provider' response property
Added the new 'GLOBAL_PAYMENTS' enum value to the 'currencyConversion/provider' response property
Added the new 'IBM' enum value to the 'currencyConversion/provider' response property
Added the new 'UNICREDIT' enum value to the 'currencyConversion/provider' response property
Added the new 'FTT' enum value to the 'currencyConversion/provider' response property
Added the new 'GLOBAL_PAYMENTS' enum value to the 'currencyConversion/provider' response property
Added the new 'IBM' enum value to the 'currencyConversion/provider' response property
Added the new 'UNICREDIT' enum value to the 'currencyConversion/provider' response property

Non-Breaking changes

Added the new 'FTT' enum value to the request property 'currencyConversion/provider'
Added the new 'GLOBAL_PAYMENTS' enum value to the request property 'currencyConversion/provider'
Added the new 'IBM' enum value to the request property 'currencyConversion/provider'
Added the new 'UNICREDIT' enum value to the request property 'currencyConversion/provider'

Operations

Retrieve Order

Breaking changes

The response property 'fundingStatus' became optional
The response property 'transaction/items/order/fundingStatus' became optional
Added the new 'APPROVED_AUTO' enum value to the 'transaction/items/response/gatewayCode' response property
Added the new 'FTT' enum value to the 'currencyConversion/provider' response property
Added the new 'FTT' enum value to the 'transaction/items/currencyConversion/provider' response property
Added the new 'GLOBAL_PAYMENTS' enum value to the 'currencyConversion/provider' response property
Added the new 'GLOBAL_PAYMENTS' enum value to the 'transaction/items/currencyConversion/provider' response property
Added the new 'IBM' enum value to the 'currencyConversion/provider' response property
Added the new 'IBM' enum value to the 'transaction/items/currencyConversion/provider' response property
Added the new 'OVERRIDE' enum value to the 'risk/response/rule/items/recommendation' response property
Added the new 'OVERRIDE' enum value to the 'transaction/items/risk/response/rule/items/recommendation' response property
Added the new 'PAYER_PRESENT' enum value to the 'transaction/items/transaction/source' response property
Added the new 'UNICREDIT' enum value to the 'currencyConversion/provider' response property
Added the new 'UNICREDIT' enum value to the 'transaction/items/currencyConversion/provider' response property

Non-Breaking changes

Added the optional property 'customer/account' to the response
Added the optional property 'netAmount' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario' to the response
Added the optional property 'sourceOfFunds/provided/oxxo' to the response
Added the optional property 'surchargeSource' to the response
Added the optional property 'transaction/items/customer/account' to the response
Added the optional property 'transaction/items/order/netAmount' to the response
Added the optional property 'transaction/items/order/surchargeSource' to the response
Added the optional property 'transaction/items/posTerminal/store' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/boletoBancario' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/oxxo' to the response
Added the optional property 'transaction/items/transaction/authorizationAdjustmentAmount' to the response
Removed the 'THREE_PARTY' enum value from the 'transaction/items/gatewayEntryPoint' response property
Removed the 'TWO_PARTY' enum value from the 'transaction/items/gatewayEntryPoint' response property

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

The response property 'order/fundingStatus' became optional
The response property 'order/fundingStatus' became optional
Added the new 'APPROVED_AUTO' enum value to the 'response/gatewayCode' response property
Added the new 'FTT' enum value to the 'currencyConversion/provider' response property
Added the new 'GLOBAL_PAYMENTS' enum value to the 'currencyConversion/provider' response property
Added the new 'IBM' enum value to the 'currencyConversion/provider' response property
Added the new 'OVERRIDE' enum value to the 'risk/response/rule/items/recommendation' response property
Added the new 'PAYER_PRESENT' enum value to the 'transaction/source' response property
Added the new 'UNICREDIT' enum value to the 'currencyConversion/provider' response property
Added the new 'APPROVED_AUTO' enum value to the 'response/gatewayCode' response property
Added the new 'FTT' enum value to the 'currencyConversion/provider' response property
Added the new 'GLOBAL_PAYMENTS' enum value to the 'currencyConversion/provider' response property
Added the new 'IBM' enum value to the 'currencyConversion/provider' response property
Added the new 'OVERRIDE' enum value to the 'risk/response/rule/items/recommendation' response property
Added the new 'PAYER_PRESENT' enum value to the 'transaction/source' response property
Added the new 'UNICREDIT' enum value to the 'currencyConversion/provider' response property

Non-Breaking changes

Added the optional property 'customer/account' to the response
Added the optional property 'order/netAmount' to the response
Added the optional property 'order/surchargeSource' to the response
Added the optional property 'posTerminal/store' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario' to the response
Added the optional property 'sourceOfFunds/provided/oxxo' to the response
Added the optional property 'transaction/authorizationAdjustmentAmount' to the response
Removed the 'THREE_PARTY' enum value from the 'gatewayEntryPoint' response property
Removed the 'TWO_PARTY' enum value from the 'gatewayEntryPoint' response property
Added the new optional request property ' Initiate /billing'
Added the new optional request property ' Initiate /customer/account'
Added the new optional request property ' Initiate /customer/dateOfBirth'
Added the new optional request property ' Initiate /customer/nationalId'
Added the new optional request property ' Initiate /session'
Added the new optional request property ' Initiate /sourceOfFunds/provided/boletoBancario'
Added the new optional request property ' Initiate /sourceOfFunds/provided/oxxo'
Added the new optional request property ' Authorize /order/netAmount'
Added the new optional request property ' Authorize /posTerminal/store'
Added the new optional request property ' Pay /order/netAmount'
Added the new optional request property ' Pay /posTerminal/store'
Added the new optional request property ' Pay /sourceOfFunds/provided/alipay'
The request property ' Authorize /order/amount' became optional
The request property ' Pay /order/amount' became optional
Added the new 'ALIPAY' enum value to the request property ' Pay /sourceOfFunds/type'
Added the new 'FTT' enum value to the request property ' Authorize /currencyConversion/provider'
Added the new 'FTT' enum value to the request property ' Capture /currencyConversion/provider'
Added the new 'FTT' enum value to the request property ' Pay /currencyConversion/provider'
Added the new 'FTT' enum value to the request property ' Refund /currencyConversion/provider'
Added the new 'GLOBAL_PAYMENTS' enum value to the request property ' Authorize /currencyConversion/provider'
Added the new 'GLOBAL_PAYMENTS' enum value to the request property ' Capture /currencyConversion/provider'
Added the new 'GLOBAL_PAYMENTS' enum value to the request property ' Pay /currencyConversion/provider'
Added the new 'GLOBAL_PAYMENTS' enum value to the request property ' Refund /currencyConversion/provider'
Added the new 'IBM' enum value to the request property ' Authorize /currencyConversion/provider'
Added the new 'IBM' enum value to the request property ' Capture /currencyConversion/provider'
Added the new 'IBM' enum value to the request property ' Pay /currencyConversion/provider'
Added the new 'IBM' enum value to the request property ' Refund /currencyConversion/provider'
Added the new 'PAYER_PRESENT' enum value to the request property ' Authorize /transaction/source'
Added the new 'PAYER_PRESENT' enum value to the request property ' Pay /transaction/source'
Added the new 'UNICREDIT' enum value to the request property ' Authorize /currencyConversion/provider'
Added the new 'UNICREDIT' enum value to the request property ' Capture /currencyConversion/provider'
Added the new 'UNICREDIT' enum value to the request property ' Pay /currencyConversion/provider'
Added the new 'UNICREDIT' enum value to the request property ' Refund /currencyConversion/provider'
Added the optional property 'customer/account' to the response
Added the optional property 'order/netAmount' to the response
Added the optional property 'order/surchargeSource' to the response
Added the optional property 'posTerminal/store' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario' to the response
Added the optional property 'sourceOfFunds/provided/oxxo' to the response
Added the optional property 'transaction/authorizationAdjustmentAmount' to the response
Removed the 'THREE_PARTY' enum value from the 'gatewayEntryPoint' response property
Removed the 'TWO_PARTY' enum value from the 'gatewayEntryPoint' response property

Operations

Payment Options Inquiry

Breaking changes

Added the new 'FTT' enum value to the 'paymentTypes/card/currencyConversion/provider' response property
Added the new 'GLOBAL_PAYMENTS' enum value to the 'paymentTypes/card/currencyConversion/provider' response property
Added the new 'IBM' enum value to the 'paymentTypes/card/currencyConversion/provider' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/ach/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/alipay/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/bancanet/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/boletobancario/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/card/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/enets/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/giftCard/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/giropay/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/ideal/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/oxxo/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/paypal/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/poli/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/sepa/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/sofort/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/unionpay/transactionSources/items/transactionSource' response property
Added the new 'PAYER_PRESENT' enum value to the 'paymentTypes/wechatpay/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/ach/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/alipay/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/bancanet/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/boletobancario/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/card/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/enets/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/giftCard/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/giropay/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/ideal/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/oxxo/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/paypal/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/poli/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/sepa/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/sofort/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/unionpay/transactionSources/items/transactionSource' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'paymentTypes/wechatpay/transactionSources/items/transactionSource' response property
Added the new 'UNICREDIT' enum value to the 'paymentTypes/card/currencyConversion/provider' response property

Non-Breaking changes

Added the new optional 'query' request parameter 'gatewayEntryPoint'
Added the new optional 'query' request parameter 'order.netAmount'
Added the new enum value 'PAYER_PRESENT' to the 'query' request parameter 'transactionSource'
Added the optional property 'gatewayEntryPoint' to the response
Added the optional property 'order' to the response

Operations

Create Checkout Session , Create Session

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /order/netAmount'
Added the new optional request property ' Create Session /session'
Added the required property ' Create Session /session/aes256Key' to the response
Added the required property ' Create Session /session/authenticationLimit' to the response

Operations

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

Breaking changes

Removed ' update_session_request, update_session_with_payer_data_request' from the request body 'oneOf' list
Added the new 'ALIPAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'BANCANET' enum value to the 'sourceOfFunds/type' response property
Added the new 'BOLETO_BANCARIO' enum value to the 'sourceOfFunds/type' response property
Added the new 'ENETS' enum value to the 'sourceOfFunds/type' response property
Added the new 'FTT' enum value to the 'currencyConversion/provider' response property
Added the new 'GIROPAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'GLOBAL_PAYMENTS' enum value to the 'currencyConversion/provider' response property
Added the new 'IBM' enum value to the 'currencyConversion/provider' response property
Added the new 'IDEAL' enum value to the 'sourceOfFunds/type' response property
Added the new 'OXXO' enum value to the 'sourceOfFunds/type' response property
Added the new 'PAYER_PRESENT' enum value to the 'transaction/source' response property
Added the new 'PAYER_PRESENT' enum value to the 'transactionSource' response property
Added the new 'PAYPAL' enum value to the 'sourceOfFunds/type' response property
Added the new 'POLI' enum value to the 'sourceOfFunds/type' response property
Added the new 'SEPA' enum value to the 'sourceOfFunds/type' response property
Added the new 'SOFORT' enum value to the 'sourceOfFunds/type' response property
Added the new 'UNICREDIT' enum value to the 'currencyConversion/provider' response property
Added the new 'UNION_PAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'WECHAT_PAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'ALIPAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'BANCANET' enum value to the 'sourceOfFunds/type' response property
Added the new 'BOLETO_BANCARIO' enum value to the 'sourceOfFunds/type' response property
Added the new 'ENETS' enum value to the 'sourceOfFunds/type' response property
Added the new 'FTT' enum value to the 'currencyConversion/provider' response property
Added the new 'GIROPAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'GLOBAL_PAYMENTS' enum value to the 'currencyConversion/provider' response property
Added the new 'IBM' enum value to the 'currencyConversion/provider' response property
Added the new 'IDEAL' enum value to the 'sourceOfFunds/type' response property
Added the new 'OXXO' enum value to the 'sourceOfFunds/type' response property
Added the new 'PAYER_PRESENT' enum value to the 'transaction/source' response property
Added the new 'PAYER_PRESENT' enum value to the 'transactionSource' response property
Added the new 'PAYPAL' enum value to the 'sourceOfFunds/type' response property
Added the new 'POLI' enum value to the 'sourceOfFunds/type' response property
Added the new 'SEPA' enum value to the 'sourceOfFunds/type' response property
Added the new 'SOFORT' enum value to the 'sourceOfFunds/type' response property
Added the new 'UNICREDIT' enum value to the 'currencyConversion/provider' response property
Added the new 'UNION_PAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'WECHAT_PAY' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'browserPayment' to the response
Added the optional property 'customer/account' to the response
Added the optional property 'customer/dateOfBirth' to the response
Added the optional property 'customer/nationalId' to the response
Added the optional property 'gatewayEntryPoint' to the response
Added the optional property 'order/netAmount' to the response
Added the optional property 'posTerminal/store' to the response
Added the optional property 'sourceOfFunds/provided/alipay' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario' to the response
Added the optional property 'sourceOfFunds/provided/enets' to the response
Added the optional property 'sourceOfFunds/provided/giropay' to the response
Added the optional property 'sourceOfFunds/provided/oxxo' to the response
Added the optional property 'sourceOfFunds/provided/poli' to the response
Added the optional property 'sourceOfFunds/provided/sepa' to the response
Added the optional property 'sourceOfFunds/provided/sofort' to the response
Added the optional property 'sourceOfFunds/provided/weChatPay' to the response
Added the optional property 'transaction/bancanet' to the response
Added the optional property 'browserPayment' to the response
Added the optional property 'customer/account' to the response
Added the optional property 'customer/dateOfBirth' to the response
Added the optional property 'customer/nationalId' to the response
Added the optional property 'gatewayEntryPoint' to the response
Added the optional property 'order/netAmount' to the response
Added the optional property 'posTerminal/store' to the response
Added the optional property 'sourceOfFunds/provided/alipay' to the response
Added the optional property 'sourceOfFunds/provided/boletoBancario' to the response
Added the optional property 'sourceOfFunds/provided/enets' to the response
Added the optional property 'sourceOfFunds/provided/giropay' to the response
Added the optional property 'sourceOfFunds/provided/oxxo' to the response
Added the optional property 'sourceOfFunds/provided/poli' to the response
Added the optional property 'sourceOfFunds/provided/sepa' to the response
Added the optional property 'sourceOfFunds/provided/sofort' to the response
Added the optional property 'sourceOfFunds/provided/weChatPay' to the response
Added the optional property 'transaction/bancanet' to the response
Api operation id 'Session: Update Session OR Session: Update Session With Payer Data' removed and replaced with 'Session: Update Session'
Added the new optional request property '3DSecure'
Added the new optional request property '3DSecureId'
Added the new optional request property 'action'
Added the new optional request property 'airline'
Added the new optional request property 'authorizationResponse'
Added the new optional request property 'billing'
Added the new optional request property 'browserPayment'
Added the new optional request property 'constraints'
Added the new optional request property 'correlationId'
Added the new optional request property 'currencyConversion'
Added the new optional request property 'customer'
Added the new optional request property 'device'
Added the new optional request property 'externalTokenProvider'
Added the new optional request property 'gatewayEntryPoint'
Added the new optional request property 'lineOfBusiness'
Added the new optional request property 'locale'
Added the new optional request property 'merchant'
Added the new optional request property 'order'
Added the new optional request property 'partnerSolutionId'
Added the new optional request property 'paymentPlan'
Added the new optional request property 'paymentType'
Added the new optional request property 'posTerminal'
Added the new optional request property 'responseControls'
Added the new optional request property 'risk'
Added the new optional request property 'session'
Added the new optional request property 'shipping'
Added the new optional request property 'sourceOfFunds'
Added the new optional request property 'token'
Added the new optional request property 'transaction'
Added the new optional request property 'transactionSource'
Added the new optional request property 'userId'
Added the new optional request property 'verificationStrategy'
Added the new optional request property 'wallet'
Removed '#/components/schemas/retrieve_session_response, update_session_with_payer_data_response' from the response body 'oneOf' list
Added the optional property '3DSecure' to the response
Added the optional property '3DSecureId' to the response
Added the optional property 'action' to the response
Added the optional property 'airline' to the response
Added the optional property 'authorizationResponse' to the response
Added the optional property 'billing' to the response
Added the optional property 'browserPayment' to the response
Added the optional property 'constraints' to the response
Added the optional property 'correlationId' to the response
Added the optional property 'currencyConversion' to the response
Added the optional property 'customer' to the response
Added the optional property 'device' to the response
Added the optional property 'externalTokenProvider' to the response
Added the optional property 'gatewayEntryPoint' to the response
Added the optional property 'lineOfBusiness' to the response
Added the optional property 'locale' to the response
Added the optional property 'order' to the response
Added the optional property 'partnerSolutionId' to the response
Added the optional property 'paymentPlan' to the response
Added the optional property 'paymentType' to the response
Added the optional property 'posTerminal' to the response
Added the optional property 'responseControls' to the response
Added the optional property 'risk' to the response
Added the optional property 'shipping' to the response
Added the optional property 'sourceOfFunds' to the response
Added the optional property 'token' to the response
Added the optional property 'transaction' to the response
Added the optional property 'transactionSource' to the response
Added the optional property 'userId' to the response
Added the optional property 'verificationStrategy' to the response
Added the optional property 'wallet' to the response
Added the required property 'merchant' to the response
Added the required property 'session' to the response

May 2018

Version 49

Operations

Retrieve Order

Breaking changes

The response property 'transaction/items/transaction/acquirer/id' became optional
The response property 'transaction/items/transaction/funding' became optional
The 'shipping/contact/mobilePhone' response property's maxLength was unset from '20'
The 'shipping/contact/phone' response property's maxLength was unset from '20'
The 'transaction/items/shipping/contact/mobilePhone' response property's maxLength was unset from '20'
The 'transaction/items/shipping/contact/phone' response property's maxLength was unset from '20'
The 'shipping/contact/mobilePhone' response property's minLength was decreased from '1' to '0'
The 'shipping/contact/phone' response property's minLength was decreased from '1' to '0'
The 'transaction/items/shipping/contact/mobilePhone' response property's minLength was decreased from '1' to '0'
The 'transaction/items/shipping/contact/phone' response property's minLength was decreased from '1' to '0'
The 'shipping/contact/mobilePhone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The 'shipping/contact/phone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The 'transaction/items/shipping/contact/mobilePhone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The 'transaction/items/shipping/contact/phone' response's property type/format changed from 'string'/'' to 'string'/'phone'
Added the new 'AUTHENTICATION' enum value to the 'transaction/items/transaction/type' response property
Added the new 'FUNDING' enum value to the 'status' response property
Added the new 'FUNDING' enum value to the 'transaction/items/order/status' response property
Added the new 'NOT_SHIPPED' enum value to the 'shipping/method' response property
Added the new 'NOT_SHIPPED' enum value to the 'transaction/items/shipping/method' response property
Added the new 'PICKUP' enum value to the 'shipping/method' response property
Added the new 'PICKUP' enum value to the 'transaction/items/shipping/method' response property

Non-Breaking changes

Added the optional property 'funding' to the response
Added the optional property 'sourceOfFunds/provided/card/storedOnFile' to the response
Added the optional property 'sourceOfFunds/provided/giropay/iban' to the response
Added the optional property 'sourceOfFunds/provided/ideal/bic' to the response
Added the optional property 'sourceOfFunds/provided/ideal/iban' to the response
Added the optional property 'sourceOfFunds/tokenRequestorID' to the response
Added the optional property 'surchargeAmount' to the response
Added the optional property 'transaction/items/airline/ticket/taxOrFee' to the response
Added the optional property 'transaction/items/authorizationResponse/autoExpiry' to the response
Added the optional property 'transaction/items/order/funding' to the response
Added the optional property 'transaction/items/order/surchargeAmount' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/storedOnFile' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/giropay/iban' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/ideal/bic' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/ideal/iban' to the response
Added the optional property 'transaction/items/sourceOfFunds/tokenRequestorID' to the response
Added the optional property 'transaction/items/transaction/funding/amount' to the response
Added the optional property 'transaction/items/transaction/funding/currency' to the response
Added the optional property 'transaction/items/transaction/funding/date' to the response
Added the optional property 'transaction/items/transaction/funding/estimatedDate' to the response
Added the optional property 'transaction/items/transaction/funding/fee' to the response
Added the optional property 'transaction/items/transaction/funding/feeAmount' to the response
Added the optional property 'transaction/items/transaction/funding/feeCurrency' to the response
Added the optional property 'transaction/items/transaction/funding/initiatedDate' to the response
Added the optional property 'transaction/items/transaction/update' to the response
The 'shipping/contact/mobilePhone' response's property pattern was added
The 'shipping/contact/phone' response's property pattern was added
The 'transaction/items/shipping/contact/mobilePhone' response's property pattern was added
The 'transaction/items/shipping/contact/phone' response's property pattern was added

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

The response property 'transaction/acquirer/id' became optional
The response property 'transaction/funding' became optional
The 'shipping/contact/mobilePhone' response property's maxLength was unset from '20'
The 'shipping/contact/phone' response property's maxLength was unset from '20'
The 'shipping/contact/mobilePhone' response property's minLength was decreased from '1' to '0'
The 'shipping/contact/phone' response property's minLength was decreased from '1' to '0'
The 'shipping/contact/mobilePhone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The 'shipping/contact/phone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The ' Initiate /customer/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Initiate /customer/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Initiate /shipping/contact/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Initiate /shipping/contact/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Authorize /customer/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Authorize /customer/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Authorize /shipping/contact/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Authorize /shipping/contact/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Capture /customer/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Capture /customer/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Capture /shipping/contact/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Capture /shipping/contact/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Pay /customer/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Pay /customer/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Pay /shipping/contact/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Pay /shipping/contact/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Refund /customer/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Refund /customer/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Verify /customer/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Verify /customer/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Verify /shipping/contact/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Verify /shipping/contact/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The response property 'transaction/acquirer/id' became optional
The response property 'transaction/funding' became optional
The 'shipping/contact/mobilePhone' response property's maxLength was unset from '20'
The 'shipping/contact/phone' response property's maxLength was unset from '20'
The 'shipping/contact/mobilePhone' response property's minLength was decreased from '1' to '0'
The 'shipping/contact/phone' response property's minLength was decreased from '1' to '0'
The 'shipping/contact/mobilePhone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The 'shipping/contact/phone' response's property type/format changed from 'string'/'' to 'string'/'phone'
Added the new 'AUTHENTICATION' enum value to the 'transaction/type' response property
Added the new 'FUNDING' enum value to the 'order/status' response property
Added the new 'NOT_SHIPPED' enum value to the 'shipping/method' response property
Added the new 'PICKUP' enum value to the 'shipping/method' response property
Added the pattern to the request property ' Initiate /customer/mobilePhone'
Added the pattern to the request property ' Initiate /customer/phone'
Added the pattern to the request property ' Initiate /shipping/contact/mobilePhone'
Added the pattern to the request property ' Initiate /shipping/contact/phone'
Added the pattern to the request property ' Authorize /customer/mobilePhone'
Added the pattern to the request property ' Authorize /customer/phone'
Added the pattern to the request property ' Authorize /shipping/contact/mobilePhone'
Added the pattern to the request property ' Authorize /shipping/contact/phone'
Added the pattern to the request property ' Capture /customer/mobilePhone'
Added the pattern to the request property ' Capture /customer/phone'
Added the pattern to the request property ' Capture /shipping/contact/mobilePhone'
Added the pattern to the request property ' Capture /shipping/contact/phone'
Added the pattern to the request property ' Pay /customer/mobilePhone'
Added the pattern to the request property ' Pay /customer/phone'
Added the pattern to the request property ' Pay /shipping/contact/mobilePhone'
Added the pattern to the request property ' Pay /shipping/contact/phone'
Added the pattern to the request property ' Refund /customer/mobilePhone'
Added the pattern to the request property ' Refund /customer/phone'
Added the pattern to the request property ' Verify /customer/mobilePhone'
Added the pattern to the request property ' Verify /customer/phone'
Added the pattern to the request property ' Verify /shipping/contact/mobilePhone'
Added the pattern to the request property ' Verify /shipping/contact/phone'
Added the new 'AUTHENTICATION' enum value to the 'transaction/type' response property
Added the new 'FUNDING' enum value to the 'order/status' response property
Added the new 'NOT_SHIPPED' enum value to the 'shipping/method' response property
Added the new 'PICKUP' enum value to the 'shipping/method' response property

Non-Breaking changes

Added the optional property 'airline/ticket/taxOrFee' to the response
Added the optional property 'authorizationResponse/autoExpiry' to the response
Added the optional property 'order/funding' to the response
Added the optional property 'order/surchargeAmount' to the response
Added the optional property 'sourceOfFunds/provided/card/storedOnFile' to the response
Added the optional property 'sourceOfFunds/provided/giropay/iban' to the response
Added the optional property 'sourceOfFunds/provided/ideal/bic' to the response
Added the optional property 'sourceOfFunds/provided/ideal/iban' to the response
Added the optional property 'sourceOfFunds/tokenRequestorID' to the response
Added the optional property 'transaction/funding/amount' to the response
Added the optional property 'transaction/funding/currency' to the response
Added the optional property 'transaction/funding/date' to the response
Added the optional property 'transaction/funding/estimatedDate' to the response
Added the optional property 'transaction/funding/fee' to the response
Added the optional property 'transaction/funding/feeAmount' to the response
Added the optional property 'transaction/funding/feeCurrency' to the response
Added the optional property 'transaction/funding/initiatedDate' to the response
Added the optional property 'transaction/update' to the response
The 'shipping/contact/mobilePhone' response's property pattern was added
The 'shipping/contact/phone' response's property pattern was added
Added the new optional request property ' Authorize /airline/ticket/taxOrFee'
Added the new optional request property ' Authorize /order/surchargeAmount'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/storedOnFile'
Added the new optional request property ' Capture /airline/ticket/taxOrFee'
Added the new optional request property ' Capture /order/surchargeAmount'
Added the new optional request property ' Capture /sourceOfFunds/provided/card/storedOnFile'
Added the new optional request property ' Pay /airline/ticket/taxOrFee'
Added the new optional request property ' Pay /order/surchargeAmount'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/storedOnFile'
Added the new optional request property ' Refund /airline/ticket/taxOrFee'
Added the new optional request property ' Refund /customer/taxRegistrationId'
Added the new optional request property ' Refund /sourceOfFunds/provided/card/storedOnFile'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/storedOnFile'
Added the new optional request property ' Verify /sourceOfFunds/tokenRequestorID'
Added the new 'NOT_SHIPPED' enum value to the request property ' Initiate /shipping/method'
Added the new 'NOT_SHIPPED' enum value to the request property ' Authorize /shipping/method'
Added the new 'NOT_SHIPPED' enum value to the request property ' Capture /shipping/method'
Added the new 'NOT_SHIPPED' enum value to the request property ' Pay /shipping/method'
Added the new 'NOT_SHIPPED' enum value to the request property ' Verify /shipping/method'
Added the new 'PICKUP' enum value to the request property ' Initiate /shipping/method'
Added the new 'PICKUP' enum value to the request property ' Authorize /shipping/method'
Added the new 'PICKUP' enum value to the request property ' Capture /shipping/method'
Added the new 'PICKUP' enum value to the request property ' Pay /shipping/method'
Added the new 'PICKUP' enum value to the request property ' Verify /shipping/method'
The ' Initiate /customer/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Initiate /customer/phone' request property's minLength was decreased from '1' to '0'
The ' Initiate /shipping/contact/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Initiate /shipping/contact/phone' request property's minLength was decreased from '1' to '0'
The ' Authorize /customer/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Authorize /customer/phone' request property's minLength was decreased from '1' to '0'
The ' Authorize /shipping/contact/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Authorize /shipping/contact/phone' request property's minLength was decreased from '1' to '0'
The ' Capture /customer/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Capture /customer/phone' request property's minLength was decreased from '1' to '0'
The ' Capture /shipping/contact/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Capture /shipping/contact/phone' request property's minLength was decreased from '1' to '0'
The ' Pay /customer/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Pay /customer/phone' request property's minLength was decreased from '1' to '0'
The ' Pay /shipping/contact/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Pay /shipping/contact/phone' request property's minLength was decreased from '1' to '0'
The ' Refund /customer/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Refund /customer/phone' request property's minLength was decreased from '1' to '0'
The ' Verify /customer/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Verify /customer/phone' request property's minLength was decreased from '1' to '0'
The ' Verify /shipping/contact/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Verify /shipping/contact/phone' request property's minLength was decreased from '1' to '0'
Added the optional property 'airline/ticket/taxOrFee' to the response
Added the optional property 'authorizationResponse/autoExpiry' to the response
Added the optional property 'order/funding' to the response
Added the optional property 'order/surchargeAmount' to the response
Added the optional property 'sourceOfFunds/provided/card/storedOnFile' to the response
Added the optional property 'sourceOfFunds/provided/giropay/iban' to the response
Added the optional property 'sourceOfFunds/provided/ideal/bic' to the response
Added the optional property 'sourceOfFunds/provided/ideal/iban' to the response
Added the optional property 'sourceOfFunds/tokenRequestorID' to the response
Added the optional property 'transaction/funding/amount' to the response
Added the optional property 'transaction/funding/currency' to the response
Added the optional property 'transaction/funding/date' to the response
Added the optional property 'transaction/funding/estimatedDate' to the response
Added the optional property 'transaction/funding/fee' to the response
Added the optional property 'transaction/funding/feeAmount' to the response
Added the optional property 'transaction/funding/feeCurrency' to the response
Added the optional property 'transaction/funding/initiatedDate' to the response
Added the optional property 'transaction/update' to the response
The 'shipping/contact/mobilePhone' response's property pattern was added
The 'shipping/contact/phone' response's property pattern was added

Operations

Payment Options Inquiry

Breaking changes

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

Operations

Create Checkout Session

Breaking changes

The ' Create Checkout Session /customer/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Create Checkout Session /customer/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Create Checkout Session /shipping/contact/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Create Checkout Session /shipping/contact/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
Added the pattern to the request property ' Create Checkout Session /customer/mobilePhone'
Added the pattern to the request property ' Create Checkout Session /customer/phone'
Added the pattern to the request property ' Create Checkout Session /shipping/contact/mobilePhone'
Added the pattern to the request property ' Create Checkout Session /shipping/contact/phone'

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /airline/ticket/taxOrFee'
Added the new 'NOT_SHIPPED' enum value to the request property ' Create Checkout Session /shipping/method'
Added the new 'PICKUP' enum value to the request property ' Create Checkout Session /shipping/method'
The ' Create Checkout Session /customer/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Create Checkout Session /customer/phone' request property's minLength was decreased from '1' to '0'
The ' Create Checkout Session /shipping/contact/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Create Checkout Session /shipping/contact/phone' request property's minLength was decreased from '1' to '0'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session , Update Session With Payer Data

Breaking changes

The 'customer/mobilePhone' response property's maxLength was unset from '20'
The 'customer/phone' response property's maxLength was unset from '20'
The 'shipping/contact/mobilePhone' response property's maxLength was unset from '20'
The 'shipping/contact/phone' response property's maxLength was unset from '20'
The 'customer/mobilePhone' response property's minLength was decreased from '1' to '0'
The 'customer/phone' response property's minLength was decreased from '1' to '0'
The 'shipping/contact/mobilePhone' response property's minLength was decreased from '1' to '0'
The 'shipping/contact/phone' response property's minLength was decreased from '1' to '0'
The 'customer/mobilePhone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The 'customer/phone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The 'shipping/contact/mobilePhone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The 'shipping/contact/phone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The 'customer/mobilePhone' response property's maxLength was unset from '20'
The 'customer/phone' response property's maxLength was unset from '20'
The 'shipping/contact/mobilePhone' response property's maxLength was unset from '20'
The 'shipping/contact/phone' response property's maxLength was unset from '20'
The 'customer/mobilePhone' response property's minLength was decreased from '1' to '0'
The 'customer/phone' response property's minLength was decreased from '1' to '0'
The 'shipping/contact/mobilePhone' response property's minLength was decreased from '1' to '0'
The 'shipping/contact/phone' response property's minLength was decreased from '1' to '0'
The 'customer/mobilePhone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The 'customer/phone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The 'shipping/contact/mobilePhone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The 'shipping/contact/phone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The ' Update Session /customer/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Update Session /customer/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Update Session /shipping/contact/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Update Session /shipping/contact/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Update Session With Payer Data /customer/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Update Session With Payer Data /customer/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Update Session With Payer Data /shipping/contact/mobilePhone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Update Session With Payer Data /shipping/contact/phone' request property type/format changed from 'string'/'' to 'string'/'phone'
The ' Retrieve Session /customer/mobilePhone' response property's maxLength was unset from '20'
The ' Retrieve Session /customer/phone' response property's maxLength was unset from '20'
The ' Retrieve Session /shipping/contact/mobilePhone' response property's maxLength was unset from '20'
The ' Retrieve Session /shipping/contact/phone' response property's maxLength was unset from '20'
The ' Retrieve Session /customer/mobilePhone' response property's minLength was decreased from '1' to '0'
The ' Retrieve Session /customer/phone' response property's minLength was decreased from '1' to '0'
The ' Retrieve Session /shipping/contact/mobilePhone' response property's minLength was decreased from '1' to '0'
The ' Retrieve Session /shipping/contact/phone' response property's minLength was decreased from '1' to '0'
The ' Retrieve Session /customer/mobilePhone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The ' Retrieve Session /customer/phone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The ' Retrieve Session /shipping/contact/mobilePhone' response's property type/format changed from 'string'/'' to 'string'/'phone'
The ' Retrieve Session /shipping/contact/phone' response's property type/format changed from 'string'/'' to 'string'/'phone'
Added the new 'NOT_SHIPPED' enum value to the 'shipping/method' response property
Added the new 'PICKUP' enum value to the 'shipping/method' response property
Added the new 'NOT_SHIPPED' enum value to the 'shipping/method' response property
Added the new 'PICKUP' enum value to the 'shipping/method' response property
Added the pattern to the request property ' Update Session /customer/mobilePhone'
Added the pattern to the request property ' Update Session /customer/phone'
Added the pattern to the request property ' Update Session /shipping/contact/mobilePhone'
Added the pattern to the request property ' Update Session /shipping/contact/phone'
Added the pattern to the request property ' Update Session With Payer Data /customer/mobilePhone'
Added the pattern to the request property ' Update Session With Payer Data /customer/phone'
Added the pattern to the request property ' Update Session With Payer Data /shipping/contact/mobilePhone'
Added the pattern to the request property ' Update Session With Payer Data /shipping/contact/phone'
Removed the request property ' Update Session With Payer Data /shipping/method'
Added the new 'NOT_SHIPPED' enum value to the ' Retrieve Session /shipping/method' response property
Added the new 'PICKUP' enum value to the ' Retrieve Session /shipping/method' response property

Non-Breaking changes

Added the optional property 'airline/ticket/taxOrFee' to the response
Added the optional property 'order/surchargeAmount' to the response
Added the optional property 'sourceOfFunds/provided/card/storedOnFile' to the response
The 'customer/mobilePhone' response's property pattern was added
The 'customer/phone' response's property pattern was added
The 'shipping/contact/mobilePhone' response's property pattern was added
The 'shipping/contact/phone' response's property pattern was added
Added the optional property 'airline/ticket/taxOrFee' to the response
Added the optional property 'order/surchargeAmount' to the response
Added the optional property 'sourceOfFunds/provided/card/storedOnFile' to the response
The 'customer/mobilePhone' response's property pattern was added
The 'customer/phone' response's property pattern was added
The 'shipping/contact/mobilePhone' response's property pattern was added
The 'shipping/contact/phone' response's property pattern was added
Added the new optional request property ' Update Session /airline/ticket/taxOrFee'
Added the new optional request property ' Update Session /order/surchargeAmount'
Added the new optional request property ' Update Session /sourceOfFunds/provided/card/storedOnFile'
Added the new optional request property ' Update Session With Payer Data /transaction/id'
Added the new 'NOT_SHIPPED' enum value to the request property ' Update Session /shipping/method'
Added the new 'PICKUP' enum value to the request property ' Update Session /shipping/method'
The ' Update Session /customer/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Update Session /customer/phone' request property's minLength was decreased from '1' to '0'
The ' Update Session /shipping/contact/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Update Session /shipping/contact/phone' request property's minLength was decreased from '1' to '0'
The ' Update Session With Payer Data /customer/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Update Session With Payer Data /customer/phone' request property's minLength was decreased from '1' to '0'
The ' Update Session With Payer Data /shipping/contact/mobilePhone' request property's minLength was decreased from '1' to '0'
The ' Update Session With Payer Data /shipping/contact/phone' request property's minLength was decreased from '1' to '0'
Added the optional property ' Retrieve Session /airline/ticket/taxOrFee' to the response
Added the optional property ' Retrieve Session /order/surchargeAmount' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/card/storedOnFile' to the response
The ' Retrieve Session /customer/mobilePhone' response's property pattern was added
The ' Retrieve Session /customer/phone' response's property pattern was added
The ' Retrieve Session /shipping/contact/mobilePhone' response's property pattern was added
The ' Retrieve Session /shipping/contact/phone' response's property pattern was added

March 2018

Version 48

Operations

Retrieve Order

Breaking changes

Removed the optional property 'item/items/detail/unitTax' from the response
Removed the optional property 'sourceOfFunds/provided/ideal/bankAccountNumber' from the response
Removed the optional property 'sourceOfFunds/provided/ideal/bankIdentifier' from the response
Removed the optional property 'transaction/items/order/item/items/detail/unitTax' from the response
Removed the optional property 'transaction/items/sourceOfFunds/provided/ideal/bankAccountNumber' from the response
Removed the optional property 'transaction/items/sourceOfFunds/provided/ideal/bankIdentifier' from the response
Removed the optional property 'transaction/items/transaction/item/items/detail/unitTax' from the response
Added the new 'BOLETO_BANCARIO' enum value to the 'sourceOfFunds/type' response property
Added the new 'BOLETO_BANCARIO' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'CHASE_PAY' enum value to the 'transaction/items/order/walletProvider' response property
Added the new 'CHASE_PAY' enum value to the 'walletProvider' response property
Added the new 'OXXO' enum value to the 'sourceOfFunds/type' response property
Added the new 'OXXO' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'item/items/detail/tax' to the response
Added the optional property 'transaction/items/availableBalance/ebt' to the response
Added the optional property 'transaction/items/order/item/items/detail/tax' to the response
Added the optional property 'transaction/items/response/gatewayRecommendation' to the response
Added the optional property 'transaction/items/transaction/item/items/detail/tax' to the response
The 'sourceOfFunds/provided/giropay/bic' response's property pattern was changed from '^[0-9]*$' to '^[0-9a-zA-Z]*$'
The 'transaction/items/sourceOfFunds/provided/giropay/bic' response's property pattern was changed from '^[0-9]*$' to '^[0-9a-zA-Z]*$'
Added the required property 'fundingStatus' to the response
Added the required property 'transaction/items/order/fundingStatus' to the response
Added the required property 'transaction/items/transaction/funding' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Removed the optional property 'order/item/items/detail/unitTax' from the response
Removed the optional property 'sourceOfFunds/provided/ideal/bankAccountNumber' from the response
Removed the optional property 'sourceOfFunds/provided/ideal/bankIdentifier' from the response
Removed the optional property 'transaction/item/items/detail/unitTax' from the response
Added the new 'BOLETO_BANCARIO' enum value to the 'sourceOfFunds/type' response property
Added the new 'CHASE_PAY' enum value to the 'order/walletProvider' response property
Added the new 'OXXO' enum value to the 'sourceOfFunds/type' response property
Changed the pattern of the request property ' Initiate /sourceOfFunds/provided/giropay/bic' from '^[0-9]*$' to '^[0-9a-zA-Z]*$'
Removed the request property ' Confirm /order/item/items/detail/unitTax'
Removed the request property ' Initiate /order/item/items/detail/unitTax'
Removed the request property ' Authorize /order/item/items/detail/unitTax'
Removed the request property ' Capture /transaction/item/items/detail/unitTax'
Removed the request property ' Pay /order/item/items/detail/unitTax'
Removed the request property ' Refund /transaction/item/items/detail/unitTax'
Removed the request property ' Verify /order/item/items/detail/unitTax'
Removed the optional property 'order/item/items/detail/unitTax' from the response
Removed the optional property 'sourceOfFunds/provided/ideal/bankAccountNumber' from the response
Removed the optional property 'sourceOfFunds/provided/ideal/bankIdentifier' from the response
Removed the optional property 'transaction/item/items/detail/unitTax' from the response
Added the new 'BOLETO_BANCARIO' enum value to the 'sourceOfFunds/type' response property
Added the new 'CHASE_PAY' enum value to the 'order/walletProvider' response property
Added the new 'OXXO' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'availableBalance/ebt' to the response
Added the optional property 'order/item/items/detail/tax' to the response
Added the optional property 'response/gatewayRecommendation' to the response
Added the optional property 'transaction/item/items/detail/tax' to the response
The 'sourceOfFunds/provided/giropay/bic' response's property pattern was changed from '^[0-9]*$' to '^[0-9a-zA-Z]*$'
Added the required property 'order/fundingStatus' to the response
Added the required property 'transaction/funding' to the response
Added the new optional request property ' Confirm /order/item/items/detail/tax'
Added the new optional request property ' Initiate /order/item/items/detail/tax'
Added the new optional request property ' Authorize /order/item/items/detail/tax'
Added the new optional request property ' Authorize /sourceOfFunds/tokenRequestorID'
Added the new optional request property ' Capture /sourceOfFunds/tokenRequestorID'
Added the new optional request property ' Capture /transaction/item/items/detail/tax'
Added the new optional request property ' Pay /order/item/items/detail/tax'
Added the new optional request property ' Pay /sourceOfFunds/tokenRequestorID'
Added the new optional request property ' Refund /sourceOfFunds/tokenRequestorID'
Added the new optional request property ' Refund /transaction/item/items/detail/tax'
Added the new optional request property ' Verify /order/item/items/detail/tax'
Added the new 'APPLE_PAY' enum value to the request property ' Capture /order/walletProvider'
Added the new 'APPLE_PAY' enum value to the request property ' Refund /order/walletProvider'
Added the new 'APPLE_PAY' enum value to the request property ' Verify /order/walletProvider'
Added the new 'BOLETO_BANCARIO' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'CHASE_PAY' enum value to the request property ' Authorize /order/walletProvider'
Added the new 'CHASE_PAY' enum value to the request property ' Capture /order/walletProvider'
Added the new 'CHASE_PAY' enum value to the request property ' Pay /order/walletProvider'
Added the new 'CHASE_PAY' enum value to the request property ' Refund /order/walletProvider'
Added the new 'CHASE_PAY' enum value to the request property ' Verify /order/walletProvider'
Added the new 'GOOGLE_PAY' enum value to the request property ' Capture /order/walletProvider'
Added the new 'GOOGLE_PAY' enum value to the request property ' Refund /order/walletProvider'
Added the new 'GOOGLE_PAY' enum value to the request property ' Verify /order/walletProvider'
Added the new 'OXXO' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'SAMSUNG_PAY' enum value to the request property ' Capture /order/walletProvider'
Added the new 'SAMSUNG_PAY' enum value to the request property ' Refund /order/walletProvider'
Added the new 'SAMSUNG_PAY' enum value to the request property ' Verify /order/walletProvider'
Added the optional property 'availableBalance/ebt' to the response
Added the optional property 'order/item/items/detail/tax' to the response
Added the optional property 'response/gatewayRecommendation' to the response
Added the optional property 'transaction/item/items/detail/tax' to the response
The 'sourceOfFunds/provided/giropay/bic' response's property pattern was changed from '^[0-9]*$' to '^[0-9a-zA-Z]*$'
Added the required property 'order/fundingStatus' to the response
Added the required property 'transaction/funding' to the response

Operations

Pair With Wallet , Retrieve Wallet Pairing Result

Non-Breaking changes

Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the request property ' Pair With Wallet /order/walletProvider'
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the request property ' Retrieve Wallet Pairing Result /order/walletProvider'
Added the new 'APPLE_PAY' enum value to the request property ' Pair With Wallet /order/walletProvider'
Added the new 'APPLE_PAY' enum value to the request property ' Retrieve Wallet Pairing Result /order/walletProvider'
Added the new 'CHASE_PAY' enum value to the request property ' Pair With Wallet /order/walletProvider'
Added the new 'CHASE_PAY' enum value to the request property ' Retrieve Wallet Pairing Result /order/walletProvider'
Added the new 'GOOGLE_PAY' enum value to the request property ' Pair With Wallet /order/walletProvider'
Added the new 'GOOGLE_PAY' enum value to the request property ' Retrieve Wallet Pairing Result /order/walletProvider'
Added the new 'SAMSUNG_PAY' enum value to the request property ' Pair With Wallet /order/walletProvider'
Added the new 'SAMSUNG_PAY' enum value to the request property ' Retrieve Wallet Pairing Result /order/walletProvider'

Operations

Payment Options Inquiry

Breaking changes

Added the new 'APPLE_PAY' enum value to the 'paymentTypes/card/walletProviders/items/walletProvider' response property
Added the new 'CHASE_PAY' enum value to the 'paymentTypes/card/walletProviders/items/walletProvider' response property
Added the new 'GOOGLE_PAY' enum value to the 'paymentTypes/card/walletProviders/items/walletProvider' response property
Added the new 'SAMSUNG_PAY' enum value to the 'paymentTypes/card/walletProviders/items/walletProvider' response property

Non-Breaking changes

Added the new enum value 'ALIPAY' to the 'query' request parameter 'paymentType'
Added the new enum value 'BOLETO_BANCARIO' to the 'query' request parameter 'paymentType'
Added the new enum value 'ENETS' to the 'query' request parameter 'paymentType'
Added the new enum value 'IDEAL' to the 'query' request parameter 'paymentType'
Added the new enum value 'OXXO' to the 'query' request parameter 'paymentType'
Added the new enum value 'POLI' to the 'query' request parameter 'paymentType'
Added the new enum value 'SEPA' to the 'query' request parameter 'paymentType'
Added the new enum value 'WECHAT_PAY' to the 'query' request parameter 'paymentType'
Added the optional property 'paymentTypes/alipay' to the response
Added the optional property 'paymentTypes/boletobancario' to the response
Added the optional property 'paymentTypes/enets' to the response
Added the optional property 'paymentTypes/ideal' to the response
Added the optional property 'paymentTypes/oxxo' to the response
Added the optional property 'paymentTypes/poli' to the response
Added the optional property 'paymentTypes/sepa' to the response
Added the optional property 'paymentTypes/wechatpay' to the response

Operations

Create Checkout Session

Breaking changes

Removed the request property ' Create Checkout Session /interaction/action/bypass3DSecure'
Removed the request property ' Create Checkout Session /sourceOfFunds/provided/card/p2pe'

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /interaction/action/3DSecure'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session , Update Session With Payer Data

Breaking changes

Removed the optional property 'order/item/items/detail/unitTax' from the response
Removed the optional property 'transaction/item/items/detail/unitTax' from the response
Added the new 'ALIPAY' enum value to the 'paymentType' response property
Added the new 'BOLETO_BANCARIO' enum value to the 'paymentType' response property
Added the new 'CHASE_PAY' enum value to the 'order/walletProvider' response property
Added the new 'ENETS' enum value to the 'paymentType' response property
Added the new 'IDEAL' enum value to the 'paymentType' response property
Added the new 'OXXO' enum value to the 'paymentType' response property
Added the new 'POLI' enum value to the 'paymentType' response property
Added the new 'SEPA' enum value to the 'paymentType' response property
Added the new 'WECHAT_PAY' enum value to the 'paymentType' response property
Removed the request property ' Open Wallet /order/item/items/detail/unitTax'
Removed the optional property 'order/item/items/detail/unitTax' from the response
Removed the optional property 'transaction/item/items/detail/unitTax' from the response
Added the new 'ALIPAY' enum value to the 'paymentType' response property
Added the new 'BOLETO_BANCARIO' enum value to the 'paymentType' response property
Added the new 'CHASE_PAY' enum value to the 'order/walletProvider' response property
Added the new 'ENETS' enum value to the 'paymentType' response property
Added the new 'IDEAL' enum value to the 'paymentType' response property
Added the new 'OXXO' enum value to the 'paymentType' response property
Added the new 'POLI' enum value to the 'paymentType' response property
Added the new 'SEPA' enum value to the 'paymentType' response property
Added the new 'WECHAT_PAY' enum value to the 'paymentType' response property
Removed the request property ' Update Session /order/item/items/detail/unitTax'
Removed the request property ' Update Session /transaction/item/items/detail/unitTax'
Removed the optional property ' Retrieve Session /order/item/items/detail/unitTax' from the response
Removed the optional property ' Retrieve Session /transaction/item/items/detail/unitTax' from the response
Added the new 'ALIPAY' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'BOLETO_BANCARIO' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'CHASE_PAY' enum value to the ' Retrieve Session /order/walletProvider' response property
Added the new 'ENETS' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'IDEAL' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'OXXO' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'POLI' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'SEPA' enum value to the ' Retrieve Session /paymentType' response property
Added the new 'WECHAT_PAY' enum value to the ' Retrieve Session /paymentType' response property

Non-Breaking changes

Added the optional property 'order/item/items/detail/tax' to the response
Added the optional property 'sourceOfFunds/tokenRequestorID' to the response
Added the optional property 'transaction/item/items/detail/tax' to the response
Added the new optional request property ' Open Wallet /order/item/items/detail/tax'
Added the new 'APPLE_PAY' enum value to the request property ' Open Wallet /order/walletProvider'
Added the new 'APPLE_PAY' enum value to the request property ' Update Session From Wallet /order/walletProvider'
Added the new 'CHASE_PAY' enum value to the request property ' Open Wallet /order/walletProvider'
Added the new 'CHASE_PAY' enum value to the request property ' Update Session From Wallet /order/walletProvider'
Added the new 'GOOGLE_PAY' enum value to the request property ' Open Wallet /order/walletProvider'
Added the new 'GOOGLE_PAY' enum value to the request property ' Update Session From Wallet /order/walletProvider'
Added the new 'SAMSUNG_PAY' enum value to the request property ' Open Wallet /order/walletProvider'
Added the new 'SAMSUNG_PAY' enum value to the request property ' Update Session From Wallet /order/walletProvider'
Added the optional property 'order/item/items/detail/tax' to the response
Added the optional property 'sourceOfFunds/tokenRequestorID' to the response
Added the optional property 'transaction/item/items/detail/tax' to the response
Added the new optional request property ' Update Session /order/item/items/detail/tax'
Added the new optional request property ' Update Session /sourceOfFunds/tokenRequestorID'
Added the new optional request property ' Update Session /transaction/item/items/detail/tax'
Added the new 'ALIPAY' enum value to the request property ' Update Session /paymentType'
Added the new 'BOLETO_BANCARIO' enum value to the request property ' Update Session /paymentType'
Added the new 'CHASE_PAY' enum value to the request property ' Update Session /order/walletProvider'
Added the new 'CHASE_PAY' enum value to the request property ' Update Session With Payer Data /order/walletProvider'
Added the new 'ENETS' enum value to the request property ' Update Session /paymentType'
Added the new 'IDEAL' enum value to the request property ' Update Session /paymentType'
Added the new 'OXXO' enum value to the request property ' Update Session /paymentType'
Added the new 'POLI' enum value to the request property ' Update Session /paymentType'
Added the new 'SEPA' enum value to the request property ' Update Session /paymentType'
Added the new 'WECHAT_PAY' enum value to the request property ' Update Session /paymentType'
Added the optional property ' Retrieve Session /order/item/items/detail/tax' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/tokenRequestorID' to the response
Added the optional property ' Retrieve Session /transaction/item/items/detail/tax' to the response

Operations

Retrieve Wallet Options

Non-Breaking changes

Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the request property 'order/walletProvider'
Added the new 'APPLE_PAY' enum value to the request property 'order/walletProvider'
Added the new 'CHASE_PAY' enum value to the request property 'order/walletProvider'
Added the new 'GOOGLE_PAY' enum value to the request property 'order/walletProvider'
Added the new 'SAMSUNG_PAY' enum value to the request property 'order/walletProvider'

December 2017

Version 47

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Breaking changes

The response property '3DSecure' became optional
The response property '3DSecure/authenticationRedirect' became optional
Removed the required property '3DSecure/summaryStatus' from the response
Removed the required property 'response/3DSecure' from the response
The response property '3DSecure' became optional
The response property '3DSecure/authenticationRedirect' became optional
Removed the required property '3DSecure/summaryStatus' from the response
Removed the required property 'response/3DSecure' from the response
The response property '3DSecure' became optional
The response property '3DSecure/authenticationRedirect' became optional
Removed the required property '3DSecure/summaryStatus' from the response
Removed the required property 'response/3DSecure' from the response

Non-Breaking changes

Added the optional property '3DSecure/paResStatus' to the response
Added the optional property '3DSecure/veResEnrolled' to the response
Added the required property 'response/gatewayRecommendation' to the response
Added the optional property '3DSecure/paResStatus' to the response
Added the optional property '3DSecure/veResEnrolled' to the response
Added the required property 'response/gatewayRecommendation' to the response
Added the optional property '3DSecure/paResStatus' to the response
Added the optional property '3DSecure/veResEnrolled' to the response
Added the required property 'response/gatewayRecommendation' to the response

Operations

Retrieve Order

Breaking changes

Removed the required property 'transaction/items/3DSecure/enrollmentStatus' from the response
Removed the optional property 'transaction/items/3DSecure/authenticationStatus' from the response
Added the new 'DIGITAL_WALLET' enum value to the 'sourceOfFunds/provided/card/encryption' response property
Added the new 'DIGITAL_WALLET' enum value to the 'transaction/items/sourceOfFunds/provided/card/encryption' response property
Added the new 'EBT_CARD' enum value to the 'sourceOfFunds/type' response property
Added the new 'EBT_CARD' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'ENETS' enum value to the 'sourceOfFunds/type' response property
Added the new 'ENETS' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'GOOGLE_PAY' enum value to the 'transaction/items/order/walletProvider' response property
Added the new 'GOOGLE_PAY' enum value to the 'walletProvider' response property
Added the new 'POLI' enum value to the 'sourceOfFunds/type' response property
Added the new 'POLI' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'WECHAT_PAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'WECHAT_PAY' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/ebt' to the response
Added the optional property 'sourceOfFunds/provided/enets' to the response
Added the optional property 'sourceOfFunds/provided/poli' to the response
Added the optional property 'sourceOfFunds/provided/sepa' to the response
Added the optional property 'sourceOfFunds/provided/weChatPay' to the response
Added the optional property 'transaction/items/3DSecure/paResStatus' to the response
Added the optional property 'transaction/items/3DSecure/veResEnrolled' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/ebt' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/enets' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/poli' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/sepa' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/weChatPay' to the response
Removed the 'ANDROID_PAY' enum value from the 'transaction/items/order/walletProvider' response property
Removed the 'ANDROID_PAY' enum value from the 'walletProvider' response property
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Removed the required property '3DSecure/enrollmentStatus' from the response
Added the new required request property ' Authorize /3DSecure/veResEnrolled'
Added the new required request property ' Capture /3DSecure/veResEnrolled'
Added the new required request property ' Pay /3DSecure/veResEnrolled'
Removed the enum value 'ANDROID_PAY' of the request property ' Authorize /order/walletProvider'
Removed the enum value 'ANDROID_PAY' of the request property ' Pay /order/walletProvider'
Removed the required property '3DSecure/enrollmentStatus' from the response
Removed the optional property '3DSecure/authenticationStatus' from the response
Added the new 'DIGITAL_WALLET' enum value to the 'sourceOfFunds/provided/card/encryption' response property
Added the new 'EBT_CARD' enum value to the 'sourceOfFunds/type' response property
Added the new 'ENETS' enum value to the 'sourceOfFunds/type' response property
Added the new 'GOOGLE_PAY' enum value to the 'order/walletProvider' response property
Added the new 'POLI' enum value to the 'sourceOfFunds/type' response property
Added the new 'WECHAT_PAY' enum value to the 'sourceOfFunds/type' response property
Removed the request property ' Authorize /3DSecure/authenticationStatus'
Removed the request property ' Authorize /3DSecure/enrollmentStatus'
Removed the request property ' Capture /3DSecure/authenticationStatus'
Removed the request property ' Capture /3DSecure/enrollmentStatus'
Removed the request property ' Pay /3DSecure/authenticationStatus'
Removed the request property ' Pay /3DSecure/enrollmentStatus'
Removed the optional property '3DSecure/authenticationStatus' from the response
Added the new 'DIGITAL_WALLET' enum value to the 'sourceOfFunds/provided/card/encryption' response property
Added the new 'EBT_CARD' enum value to the 'sourceOfFunds/type' response property
Added the new 'ENETS' enum value to the 'sourceOfFunds/type' response property
Added the new 'GOOGLE_PAY' enum value to the 'order/walletProvider' response property
Added the new 'POLI' enum value to the 'sourceOfFunds/type' response property
Added the new 'WECHAT_PAY' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property '3DSecure/paResStatus' to the response
Added the optional property '3DSecure/veResEnrolled' to the response
Added the optional property 'sourceOfFunds/provided/ebt' to the response
Added the optional property 'sourceOfFunds/provided/enets' to the response
Added the optional property 'sourceOfFunds/provided/poli' to the response
Added the optional property 'sourceOfFunds/provided/sepa' to the response
Added the optional property 'sourceOfFunds/provided/weChatPay' to the response
Removed the 'ANDROID_PAY' enum value from the 'order/walletProvider' response property
Added the new optional request property ' Initiate /customer/mobilePhone'
Added the new optional request property ' Initiate /customer/phone'
Added the new optional request property ' Initiate /sourceOfFunds/provided/enets'
Added the new optional request property ' Initiate /sourceOfFunds/provided/poli'
Added the new optional request property ' Initiate /sourceOfFunds/provided/sepa'
Added the new optional request property ' Initiate /sourceOfFunds/provided/weChatPay'
Added the new optional request property ' Initiate /transaction/frequency'
Added the new optional request property ' Authorize /3DSecure/paResStatus'
Added the new optional request property ' Authorize /sourceOfFunds/provided/ebt'
Added the new optional request property ' Capture /3DSecure/paResStatus'
Added the new optional request property ' Capture /order/merchantCategoryCode'
Added the new optional request property ' Capture /sourceOfFunds/provided/ebt'
Added the new optional request property ' Pay /3DSecure/paResStatus'
Added the new optional request property ' Pay /sourceOfFunds/provided/ebt'
Added the new optional request property ' Refund /order/merchantCategoryCode'
Added the new optional request property ' Refund /sourceOfFunds/provided/ebt'
Added the new 'EBT_CARD' enum value to the request property ' Authorize /sourceOfFunds/type'
Added the new 'EBT_CARD' enum value to the request property ' Capture /sourceOfFunds/type'
Added the new 'EBT_CARD' enum value to the request property ' Pay /sourceOfFunds/type'
Added the new 'EBT_CARD' enum value to the request property ' Refund /sourceOfFunds/type'
Added the new 'ENETS' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'GOOGLE_PAY' enum value to the request property ' Authorize /order/walletProvider'
Added the new 'GOOGLE_PAY' enum value to the request property ' Pay /order/walletProvider'
Added the new 'POLI' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'SEPA' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'WECHAT_PAY' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the optional property '3DSecure/paResStatus' to the response
Added the optional property '3DSecure/veResEnrolled' to the response
Added the optional property 'sourceOfFunds/provided/ebt' to the response
Added the optional property 'sourceOfFunds/provided/enets' to the response
Added the optional property 'sourceOfFunds/provided/poli' to the response
Added the optional property 'sourceOfFunds/provided/sepa' to the response
Added the optional property 'sourceOfFunds/provided/weChatPay' to the response
Removed the 'ANDROID_PAY' enum value from the 'order/walletProvider' response property

Operations

Create Checkout Session

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /device/fingerprint'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session , Update Session With Payer Data

Breaking changes

Removed the enum value 'ANDROID_PAY' of the request property ' Update Session /order/walletProvider'
Removed the enum value 'ANDROID_PAY' of the request property ' Update Session With Payer Data /order/walletProvider'
Removed the optional property '3DSecure/authenticationStatus' from the response
Removed the optional property '3DSecure/enrollmentStatus' from the response
Added the new 'EBT_CARD' enum value to the 'sourceOfFunds/type' response property
Added the new 'GOOGLE_PAY' enum value to the 'order/walletProvider' response property
Removed the optional property '3DSecure/authenticationStatus' from the response
Removed the optional property '3DSecure/enrollmentStatus' from the response
Added the new 'EBT_CARD' enum value to the 'sourceOfFunds/type' response property
Added the new 'GOOGLE_PAY' enum value to the 'order/walletProvider' response property
Removed the request property ' Update Session /3DSecure/authenticationStatus'
Removed the request property ' Update Session /3DSecure/enrollmentStatus'
Removed the optional property ' Retrieve Session /3DSecure/authenticationStatus' from the response
Removed the optional property ' Retrieve Session /3DSecure/enrollmentStatus' from the response
Added the new 'EBT_CARD' enum value to the ' Retrieve Session /sourceOfFunds/type' response property
Added the new 'GOOGLE_PAY' enum value to the ' Retrieve Session /order/walletProvider' response property

Non-Breaking changes

Added the optional property '3DSecure/paResStatus' to the response
Added the optional property '3DSecure/veResEnrolled' to the response
Added the optional property 'sourceOfFunds/provided/ebt' to the response
Removed the 'ANDROID_PAY' enum value from the 'order/walletProvider' response property
Added the optional property '3DSecure/paResStatus' to the response
Added the optional property '3DSecure/veResEnrolled' to the response
Added the optional property 'sourceOfFunds/provided/ebt' to the response
Removed the 'ANDROID_PAY' enum value from the 'order/walletProvider' response property
Added the new optional request property ' Update Session /3DSecure/paResStatus'
Added the new optional request property ' Update Session /3DSecure/veResEnrolled'
Added the new optional request property ' Update Session /sourceOfFunds/provided/ebt'
Added the new optional request property ' Update Session With Payer Data /sourceOfFunds/provided/card/prefix'
Added the new optional request property ' Update Session With Payer Data /sourceOfFunds/token'
Added the new 'EBT_CARD' enum value to the request property ' Update Session /sourceOfFunds/type'
Added the new 'GOOGLE_PAY' enum value to the request property ' Update Session /order/walletProvider'
Added the new 'GOOGLE_PAY' enum value to the request property ' Update Session With Payer Data /order/walletProvider'
Added the optional property ' Retrieve Session /3DSecure/paResStatus' to the response
Added the optional property ' Retrieve Session /3DSecure/veResEnrolled' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/ebt' to the response
Removed the 'ANDROID_PAY' enum value from the ' Retrieve Session /order/walletProvider' response property
Added the required property ' Update Session With Payer Data /merchant' to the response

September 2017

Version 46

Operations

Balance Inquiry

Breaking changes

Added the new required request property 'sourceOfFunds/type'
Removed the optional property 'acquirerCode' from the response
Removed the optional property 'acquirerMessage' from the response
Removed the optional property 'availableBalance/amount' from the response
Removed the optional property 'availableBalance/currency' from the response
Added the new 'BALANCE_AVAILABLE' enum value to the 'response/gatewayCode' response property
Added the new 'NO_BALANCE' enum value to the 'response/gatewayCode' response property

Non-Breaking changes

Api operation id 'Gift Card: Balance Inquiry' removed and replaced with 'Transaction: Balance Inquiry'
Api tag 'Transaction' added
Api tag 'Gift Card' removed
Added the new optional request property 'action'
Added the new optional request property 'order/subMerchant'
Added the new optional request property 'sourceOfFunds/provided/card'
Added the optional property 'availableBalance/funds' to the response
Added the optional property 'availableBalance/reward' to the response
Added the optional property 'balanceId' to the response
Added the optional property 'order/subMerchant' to the response
Added the optional property 'response/acquirerCode' to the response
Added the optional property 'response/acquirerMessage' to the response
Added the optional property 'sourceOfFunds/token' to the response
Added the optional property 'sourceOfFunds/type' to the response
The response property 'availableBalance' became required
The response property 'response' became required
The response property 'sourceOfFunds' became required
Removed the 'ABORTED' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_SYSTEM_ERROR' enum value from the 'response/gatewayCode' response property
Removed the 'APPROVED' enum value from the 'response/gatewayCode' response property
Removed the 'APPROVED_PENDING_SETTLEMENT' enum value from the 'response/gatewayCode' response property
Removed the 'AUTHENTICATION_FAILED' enum value from the 'response/gatewayCode' response property
Removed the 'BLOCKED' enum value from the 'response/gatewayCode' response property
Removed the 'CANCELLED' enum value from the 'response/gatewayCode' response property
Removed the 'DECLINED' enum value from the 'response/gatewayCode' response property
Removed the 'DECLINED_AVS' enum value from the 'response/gatewayCode' response property
Removed the 'DECLINED_AVS_CSC' enum value from the 'response/gatewayCode' response property
Removed the 'DECLINED_CSC' enum value from the 'response/gatewayCode' response property
Removed the 'DECLINED_DO_NOT_CONTACT' enum value from the 'response/gatewayCode' response property
Removed the 'DECLINED_PAYMENT_PLAN' enum value from the 'response/gatewayCode' response property
Removed the 'DEFERRED_TRANSACTION_RECEIVED' enum value from the 'response/gatewayCode' response property
Removed the 'DUPLICATE_BATCH' enum value from the 'response/gatewayCode' response property
Removed the 'EXCEEDED_RETRY_LIMIT' enum value from the 'response/gatewayCode' response property
Removed the 'EXPIRED_CARD' enum value from the 'response/gatewayCode' response property
Removed the 'INSUFFICIENT_FUNDS' enum value from the 'response/gatewayCode' response property
Removed the 'INVALID_CSC' enum value from the 'response/gatewayCode' response property
Removed the 'LOCK_FAILURE' enum value from the 'response/gatewayCode' response property
Removed the 'NOT_ENROLLED_3D_SECURE' enum value from the 'response/gatewayCode' response property
Removed the 'NOT_SUPPORTED' enum value from the 'response/gatewayCode' response property
Removed the 'PENDING' enum value from the 'response/gatewayCode' response property
Removed the 'REFERRED' enum value from the 'response/gatewayCode' response property
Removed the 'SUBMITTED' enum value from the 'response/gatewayCode' response property
Removed the 'SYSTEM_ERROR' enum value from the 'response/gatewayCode' response property
Removed the 'UNKNOWN' enum value from the 'response/gatewayCode' response property
Removed the 'UNSPECIFIED_FAILURE' enum value from the 'response/gatewayCode' response property

Operations

Retrieve Order

Breaking changes

The 'item/items/quantity' response property's min was decreased from '1.00' to '0.00'
The 'transaction/items/order/item/items/quantity' response property's min was decreased from '1.00' to '0.00'
The 'transaction/items/transaction/item/items/quantity' response property's min was decreased from '1.00' to '0.00'
The 'item/items/quantity' response's property type/format changed from 'integer'/'' to 'number'/''
The 'transaction/items/order/item/items/quantity' response's property type/format changed from 'integer'/'' to 'number'/''
The 'transaction/items/transaction/item/items/quantity' response's property type/format changed from 'integer'/'' to 'number'/''
Removed the optional property 'sourceOfFunds/provided/card/mobileWallet' from the response
Removed the optional property 'transaction/items/giftCard' from the response
Removed the optional property 'transaction/items/sourceOfFunds/provided/card/mobileWallet' from the response
Added the new 'BALANCE_AVAILABLE' enum value to the 'transaction/items/response/gatewayCode' response property
Added the new 'CHARGEBACK' enum value to the 'transaction/items/transaction/type' response property
Added the new 'CHARGEBACK_PROCESSED' enum value to the 'status' response property
Added the new 'CHARGEBACK_PROCESSED' enum value to the 'transaction/items/order/status' response property
Added the new 'DEVICE' enum value to the 'sourceOfFunds/provided/card/encryption' response property
Added the new 'DEVICE' enum value to the 'transaction/items/sourceOfFunds/provided/card/encryption' response property
Added the new 'DISPUTED' enum value to the 'status' response property
Added the new 'DISPUTED' enum value to the 'transaction/items/order/status' response property
Added the new 'NO_BALANCE' enum value to the 'transaction/items/response/gatewayCode' response property
Added the new 'SEPA' enum value to the 'sourceOfFunds/type' response property
Added the new 'SEPA' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'transaction/items/transaction/source' response property
Added the new 'SERVICE_PROVIDER_API' enum value to the 'transaction/items/gatewayEntryPoint' response property

Non-Breaking changes

Added the optional property 'chargeback' to the response
Added the optional property 'merchantCategoryCode' to the response
Added the optional property 'reward' to the response
Added the optional property 'sourceOfFunds/provided/card/devicePayment' to the response
Added the optional property 'transaction/items/availableBalance' to the response
Added the optional property 'transaction/items/order/chargeback' to the response
Added the optional property 'transaction/items/order/merchantCategoryCode' to the response
Added the optional property 'transaction/items/order/reward' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/devicePayment' to the response
Added the optional property 'transaction/items/transaction/dispute' to the response
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

The 'order/item/items/quantity' response property's min was decreased from '1.00' to '0.00'
The 'transaction/item/items/quantity' response property's min was decreased from '1.00' to '0.00'
The 'order/item/items/quantity' response's property type/format changed from 'integer'/'' to 'number'/''
The 'transaction/item/items/quantity' response's property type/format changed from 'integer'/'' to 'number'/''
The 'order/item/items/quantity' response property's min was decreased from '1.00' to '0.00'
The 'transaction/item/items/quantity' response property's min was decreased from '1.00' to '0.00'
The 'order/item/items/quantity' response's property type/format changed from 'integer'/'' to 'number'/''
The 'transaction/item/items/quantity' response's property type/format changed from 'integer'/'' to 'number'/''
Removed the optional property 'giftCard' from the response
Removed the optional property 'sourceOfFunds/provided/card/mobileWallet' from the response
Added the new 'BALANCE_AVAILABLE' enum value to the 'response/gatewayCode' response property
Added the new 'CHARGEBACK' enum value to the 'transaction/type' response property
Added the new 'CHARGEBACK_PROCESSED' enum value to the 'order/status' response property
Added the new 'DEVICE' enum value to the 'sourceOfFunds/provided/card/encryption' response property
Added the new 'DISPUTED' enum value to the 'order/status' response property
Added the new 'NO_BALANCE' enum value to the 'response/gatewayCode' response property
Added the new 'SEPA' enum value to the 'sourceOfFunds/type' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'transaction/source' response property
Added the new 'SERVICE_PROVIDER_API' enum value to the 'gatewayEntryPoint' response property
Changed the pattern of the request property ' Confirm /order/item/items/quantity'
Changed the pattern of the request property ' Initiate /order/item/items/quantity'
Changed the pattern of the request property ' Authorize /order/item/items/quantity'
Changed the pattern of the request property ' Capture /transaction/item/items/quantity'
Changed the pattern of the request property ' Pay /order/item/items/quantity'
Changed the pattern of the request property ' Refund /transaction/item/items/quantity'
Changed the pattern of the request property ' Verify /order/item/items/quantity'
Removed the request property ' Authorize /sourceOfFunds/provided/card/mobileWallet'
Removed the request property ' Pay /sourceOfFunds/provided/card/mobileWallet'
Removed the optional property 'giftCard' from the response
Removed the optional property 'sourceOfFunds/provided/card/mobileWallet' from the response
Added the new 'BALANCE_AVAILABLE' enum value to the 'response/gatewayCode' response property
Added the new 'CHARGEBACK' enum value to the 'transaction/type' response property
Added the new 'CHARGEBACK_PROCESSED' enum value to the 'order/status' response property
Added the new 'DEVICE' enum value to the 'sourceOfFunds/provided/card/encryption' response property
Added the new 'DISPUTED' enum value to the 'order/status' response property
Added the new 'NO_BALANCE' enum value to the 'response/gatewayCode' response property
Added the new 'SEPA' enum value to the 'sourceOfFunds/type' response property
Added the new 'SERVICE_PROVIDER' enum value to the 'transaction/source' response property
Added the new 'SERVICE_PROVIDER_API' enum value to the 'gatewayEntryPoint' response property

Non-Breaking changes

Added the optional property 'availableBalance' to the response
Added the optional property 'order/chargeback' to the response
Added the optional property 'order/merchantCategoryCode' to the response
Added the optional property 'order/reward' to the response
Added the optional property 'sourceOfFunds/provided/card/devicePayment' to the response
Added the optional property 'transaction/dispute' to the response
Added the new optional request property ' Authorize /order/merchantCategoryCode'
Added the new optional request property ' Authorize /order/reward'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/devicePayment'
Added the new optional request property ' Pay /order/merchantCategoryCode'
Added the new optional request property ' Pay /order/reward'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/devicePayment'
Added the new optional request property ' Verify /order/merchantCategoryCode'
The ' Confirm /order/item/items/quantity' request property's maxLength was increased from '16' to '30'
The ' Initiate /order/item/items/quantity' request property's maxLength was increased from '16' to '30'
The ' Authorize /order/item/items/quantity' request property's maxLength was increased from '16' to '30'
The ' Capture /transaction/item/items/quantity' request property's maxLength was increased from '16' to '30'
The ' Pay /order/item/items/quantity' request property's maxLength was increased from '16' to '30'
The ' Refund /transaction/item/items/quantity' request property's maxLength was increased from '16' to '30'
The ' Verify /order/item/items/quantity' request property's maxLength was increased from '16' to '30'
The ' Confirm /order/item/items/quantity' request property's minLength was decreased from '1' to '0'
The ' Initiate /order/item/items/quantity' request property's minLength was decreased from '1' to '0'
The ' Authorize /order/item/items/quantity' request property's minLength was decreased from '1' to '0'
The ' Capture /transaction/item/items/quantity' request property's minLength was decreased from '1' to '0'
The ' Pay /order/item/items/quantity' request property's minLength was decreased from '1' to '0'
The ' Refund /transaction/item/items/quantity' request property's minLength was decreased from '1' to '0'
The ' Verify /order/item/items/quantity' request property's minLength was decreased from '1' to '0'
Added the optional property 'availableBalance' to the response
Added the optional property 'order/chargeback' to the response
Added the optional property 'order/merchantCategoryCode' to the response
Added the optional property 'order/reward' to the response
Added the optional property 'sourceOfFunds/provided/card/devicePayment' to the response
Added the optional property 'transaction/dispute' to the response

Operations

Create Checkout Session

Breaking changes

Changed the pattern of the request property ' Create Checkout Session /order/item/items/quantity'
Removed the request property ' Create Checkout Session /sourceOfFunds/provided/card/mobileWallet'

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /order/merchantCategoryCode'
Added the new optional request property ' Create Checkout Session /order/reward'
Added the new optional request property ' Create Checkout Session /sourceOfFunds/provided/card/devicePayment'
The ' Create Checkout Session /order/item/items/quantity' request property's maxLength was increased from '16' to '30'
The ' Create Checkout Session /order/item/items/quantity' request property's minLength was decreased from '1' to '0'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session , Update Session With Payer Data

Breaking changes

The 'order/item/items/quantity' response property's maxLength was increased from '16' to '30'
The 'transaction/item/items/quantity' response property's maxLength was increased from '16' to '30'
The 'order/item/items/quantity' response property's minLength was decreased from '1' to '0'
The 'transaction/item/items/quantity' response property's minLength was decreased from '1' to '0'
The 'order/item/items/quantity' response property's maxLength was increased from '16' to '30'
The 'transaction/item/items/quantity' response property's maxLength was increased from '16' to '30'
The 'order/item/items/quantity' response property's minLength was decreased from '1' to '0'
The 'transaction/item/items/quantity' response property's minLength was decreased from '1' to '0'
The ' Retrieve Session /order/item/items/quantity' response property's maxLength was increased from '16' to '30'
The ' Retrieve Session /transaction/item/items/quantity' response property's maxLength was increased from '16' to '30'
The ' Retrieve Session /order/item/items/quantity' response property's minLength was decreased from '1' to '0'
The ' Retrieve Session /transaction/item/items/quantity' response property's minLength was decreased from '1' to '0'
Changed the pattern of the request property ' Open Wallet /order/item/items/quantity'
Changed the pattern of the request property ' Update Session /order/item/items/quantity'
Changed the pattern of the request property ' Update Session /transaction/item/items/quantity'

Non-Breaking changes

Added the optional property 'order/merchantCategoryCode' to the response
Added the optional property 'order/reward' to the response
Added the optional property 'sourceOfFunds/provided/card/devicePayment' to the response
The 'order/item/items/quantity' response's property pattern was changed
The 'transaction/item/items/quantity' response's property pattern was changed
The ' Open Wallet /order/item/items/quantity' request property's maxLength was increased from '16' to '30'
The ' Open Wallet /order/item/items/quantity' request property's minLength was decreased from '1' to '0'
Added the optional property 'order/merchantCategoryCode' to the response
Added the optional property 'order/reward' to the response
Added the optional property 'sourceOfFunds/provided/card/devicePayment' to the response
The 'order/item/items/quantity' response's property pattern was changed
The 'transaction/item/items/quantity' response's property pattern was changed
Added the new optional request property ' Update Session /order/merchantCategoryCode'
Added the new optional request property ' Update Session /order/reward'
Added the new optional request property ' Update Session /sourceOfFunds/provided/card/devicePayment'
Added the new optional request property ' Update Session With Payer Data /sourceOfFunds/provided/card/devicePayment'
The ' Update Session /order/item/items/quantity' request property's maxLength was increased from '16' to '30'
The ' Update Session /transaction/item/items/quantity' request property's maxLength was increased from '16' to '30'
The ' Update Session /order/item/items/quantity' request property's minLength was decreased from '1' to '0'
The ' Update Session /transaction/item/items/quantity' request property's minLength was decreased from '1' to '0'
Added the optional property ' Retrieve Session /order/merchantCategoryCode' to the response
Added the optional property ' Retrieve Session /order/reward' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/card/devicePayment' to the response
The ' Retrieve Session /order/item/items/quantity' response's property pattern was changed from
The ' Retrieve Session /transaction/item/items/quantity' response's property pattern was changed

August 2017

Version 45

Operations

Close Batch

Breaking changes

Removed the request property 'acquirer/customData'

Operations

Retrieve Order

Breaking changes

The response property 'sourceOfFunds/provided/giropay/bankIdentifier' became optional
The response property 'transaction/items/sourceOfFunds/provided/giropay/bankIdentifier' became optional
Added the new 'ALIPAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'ALIPAY' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'ESTIMATED' enum value to the 'certainty' response property
Added the new 'ESTIMATED' enum value to the 'transaction/items/order/certainty' response property
Added the new 'FINAL' enum value to the 'certainty' response property
Added the new 'FINAL' enum value to the 'transaction/items/order/certainty' response property
Added the new 'FUNDING' enum value to the 'transaction/items/transaction/type' response property
Added the new 'IDEAL' enum value to the 'sourceOfFunds/type' response property
Added the new 'IDEAL' enum value to the 'transaction/items/sourceOfFunds/type' response property
Added the new 'NONE' enum value to the 'sourceOfFunds/type' response property
Added the new 'NONE' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/giropay/bic' to the response
Added the optional property 'sourceOfFunds/provided/ideal' to the response
Added the optional property 'transaction/items/authorizationResponse/trackQuality' to the response
Added the optional property 'transaction/items/browserPayment/preferredLanguage' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/giropay/bic' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/ideal' to the response
Removed the 'ESTIMATED_MAXIMUM_AMOUNT' enum value from the 'certainty' response property
Removed the 'ESTIMATED_MAXIMUM_AMOUNT' enum value from the 'transaction/items/order/certainty' response property
Removed the 'ESTIMATED_MINIMUM_AMOUNT' enum value from the 'certainty' response property
Removed the 'ESTIMATED_MINIMUM_AMOUNT' enum value from the 'transaction/items/order/certainty' response property
Removed the 'FINAL_AMOUNT' enum value from the 'certainty' response property
Removed the 'FINAL_AMOUNT' enum value from the 'transaction/items/order/certainty' response property

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

The response property 'sourceOfFunds/provided/giropay/bankIdentifier' became optional
Removed the enum value 'ESTIMATED_MAXIMUM_AMOUNT' of the request property ' Authorize /order/certainty'
Removed the enum value 'ESTIMATED_MINIMUM_AMOUNT' of the request property ' Authorize /order/certainty'
Removed the enum value 'FINAL_AMOUNT' of the request property ' Authorize /order/certainty'
The response property 'sourceOfFunds/provided/giropay/bankIdentifier' became optional
Added the new 'ALIPAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'ESTIMATED' enum value to the 'order/certainty' response property
Added the new 'FINAL' enum value to the 'order/certainty' response property
Added the new 'FUNDING' enum value to the 'transaction/type' response property
Added the new 'IDEAL' enum value to the 'sourceOfFunds/type' response property
Added the new 'NONE' enum value to the 'sourceOfFunds/type' response property
Added the new 'ALIPAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'ESTIMATED' enum value to the 'order/certainty' response property
Added the new 'FINAL' enum value to the 'order/certainty' response property
Added the new 'FUNDING' enum value to the 'transaction/type' response property
Added the new 'IDEAL' enum value to the 'sourceOfFunds/type' response property
Added the new 'NONE' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'authorizationResponse/trackQuality' to the response
Added the optional property 'browserPayment/preferredLanguage' to the response
Added the optional property 'sourceOfFunds/provided/giropay/bic' to the response
Added the optional property 'sourceOfFunds/provided/ideal' to the response
Removed the 'ESTIMATED_MAXIMUM_AMOUNT' enum value from the 'order/certainty' response property
Removed the 'ESTIMATED_MINIMUM_AMOUNT' enum value from the 'order/certainty' response property
Removed the 'FINAL_AMOUNT' enum value from the 'order/certainty' response property
Added the new optional request property ' Initiate /browserPayment/preferredLanguage'
Added the new optional request property ' Initiate /sourceOfFunds/provided/giropay/bic'
Added the new optional request property ' Initiate /sourceOfFunds/provided/sofort'
Added the new optional request property ' Capture /authorizationResponse/posData'
Added the new optional request property ' Capture /authorizationResponse/posEntryMode'
Added the new optional request property ' Capture /authorizationResponse/processingCode'
Added the new optional request property ' Capture /authorizationResponse/responseCode'
Added the new optional request property ' Capture /authorizationResponse/trackQuality'
The request property ' Initiate /sourceOfFunds/provided/giropay/bankIdentifier' became optional
Added the new 'ALIPAY' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'ESTIMATED' enum value to the request property ' Authorize /order/certainty'
Added the new 'FINAL' enum value to the request property ' Authorize /order/certainty'
Added the new 'IDEAL' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the optional property 'authorizationResponse/trackQuality' to the response
Added the optional property 'browserPayment/preferredLanguage' to the response
Added the optional property 'sourceOfFunds/provided/giropay/bic' to the response
Added the optional property 'sourceOfFunds/provided/ideal' to the response
Removed the 'ESTIMATED_MAXIMUM_AMOUNT' enum value from the 'order/certainty' response property
Removed the 'ESTIMATED_MINIMUM_AMOUNT' enum value from the 'order/certainty' response property
Removed the 'FINAL_AMOUNT' enum value from the 'order/certainty' response property

Operations

Payment Options Inquiry

Breaking changes

For the 'query' request parameter 'sourceOfFunds.provided.card.prefix', the minLength was increased from '6' to '10'
The response property 'paymentTypes/card/brand' became optional
The response property 'paymentTypes/card/fundingMethod' became optional
The response property 'paymentTypes/card/scheme' became optional

Non-Breaking changes

For the 'query' request parameter 'sourceOfFunds.provided.card.prefix', the maxLength was increased from '9' to '10'

Operations

Create Checkout Session

Breaking changes

Removed the enum value 'ESTIMATED_MAXIMUM_AMOUNT' of the request property ' Create Checkout Session /order/certainty'
Removed the enum value 'ESTIMATED_MINIMUM_AMOUNT' of the request property ' Create Checkout Session /order/certainty'
Removed the enum value 'FINAL_AMOUNT' of the request property ' Create Checkout Session /order/certainty'

Non-Breaking changes

Added the new 'ESTIMATED' enum value to the request property ' Create Checkout Session /order/certainty'
Added the new 'FINAL' enum value to the request property ' Create Checkout Session /order/certainty'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session , Update Session With Payer Data

Breaking changes

The 'sourceOfFunds/provided/card/prefix' response property's maxLength was increased from '9' to '10'
The 'sourceOfFunds/provided/card/prefix' response property's maxLength was increased from '9' to '10'
Removed the enum value 'ESTIMATED_MAXIMUM_AMOUNT' of the request property ' Update Session /order/certainty'
Removed the enum value 'ESTIMATED_MINIMUM_AMOUNT' of the request property ' Update Session /order/certainty'
Removed the enum value 'FINAL_AMOUNT' of the request property ' Update Session /order/certainty'
The ' Update Session /sourceOfFunds/provided/card/prefix' request property's minLength was increased from '6' to '10'
The ' Retrieve Session /sourceOfFunds/provided/card/prefix' response property's maxLength was increased from '9' to '10'
Added the new 'ESTIMATED' enum value to the 'order/certainty' response property
Added the new 'FINAL' enum value to the 'order/certainty' response property
Added the new 'ESTIMATED' enum value to the 'order/certainty' response property
Added the new 'FINAL' enum value to the 'order/certainty' response property
Added the new 'ESTIMATED' enum value to the ' Retrieve Session /order/certainty' response property
Added the new 'FINAL' enum value to the ' Retrieve Session /order/certainty' response property

Non-Breaking changes

Added the optional property 'authorizationResponse/posData' to the response
Added the optional property 'authorizationResponse/posEntryMode' to the response
Added the optional property 'authorizationResponse/processingCode' to the response
Added the optional property 'authorizationResponse/responseCode' to the response
Added the optional property 'authorizationResponse/trackQuality' to the response
Removed the 'ESTIMATED_MAXIMUM_AMOUNT' enum value from the 'order/certainty' response property
Removed the 'ESTIMATED_MINIMUM_AMOUNT' enum value from the 'order/certainty' response property
Removed the 'FINAL_AMOUNT' enum value from the 'order/certainty' response property
Added the optional property 'authorizationResponse/posData' to the response
Added the optional property 'authorizationResponse/posEntryMode' to the response
Added the optional property 'authorizationResponse/processingCode' to the response
Added the optional property 'authorizationResponse/responseCode' to the response
Added the optional property 'authorizationResponse/trackQuality' to the response
Removed the 'ESTIMATED_MAXIMUM_AMOUNT' enum value from the 'order/certainty' response property
Removed the 'ESTIMATED_MINIMUM_AMOUNT' enum value from the 'order/certainty' response property
Removed the 'FINAL_AMOUNT' enum value from the 'order/certainty' response property
Added the new optional request property ' Update Session /authorizationResponse/posData'
Added the new optional request property ' Update Session /authorizationResponse/posEntryMode'
Added the new optional request property ' Update Session /authorizationResponse/processingCode'
Added the new optional request property ' Update Session /authorizationResponse/responseCode'
Added the new optional request property ' Update Session /authorizationResponse/trackQuality'
Added the new 'ESTIMATED' enum value to the request property ' Update Session /order/certainty'
Added the new 'FINAL' enum value to the request property ' Update Session /order/certainty'
The ' Update Session /sourceOfFunds/provided/card/prefix' request property's maxLength was increased from '9' to '10'
Added the optional property ' Retrieve Session /authorizationResponse/posData' to the response
Added the optional property ' Retrieve Session /authorizationResponse/posEntryMode' to the response
Added the optional property ' Retrieve Session /authorizationResponse/processingCode' to the response
Added the optional property ' Retrieve Session /authorizationResponse/responseCode' to the response
Added the optional property ' Retrieve Session /authorizationResponse/trackQuality' to the response
Removed the 'ESTIMATED_MAXIMUM_AMOUNT' enum value from the ' Retrieve Session /order/certainty' response property
Removed the 'ESTIMATED_MINIMUM_AMOUNT' enum value from the ' Retrieve Session /order/certainty' response property
Removed the 'FINAL_AMOUNT' enum value from the ' Retrieve Session /order/certainty' response property

Operations

Create or Update Token (with system-generated token)

Breaking changes

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

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

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

May 2017

Version 44

Operations

Retrieve Order

Breaking changes

Added the new 'DECLINED_INVALID_PIN' enum value to the 'transaction/items/response/gatewayCode' response property
Added the new 'DECLINED_PIN_REQUIRED' enum value to the 'transaction/items/response/gatewayCode' response property
Added the new 'SAMSUNG_PAY' enum value to the 'transaction/items/order/walletProvider' response property
Added the new 'SAMSUNG_PAY' enum value to the 'walletProvider' response property

Non-Breaking changes

The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Added the new 'DECLINED_INVALID_PIN' enum value to the 'response/gatewayCode' response property
Added the new 'DECLINED_PIN_REQUIRED' enum value to the 'response/gatewayCode' response property
Added the new 'SAMSUNG_PAY' enum value to the 'order/walletProvider' response property
Added the new 'DECLINED_INVALID_PIN' enum value to the 'response/gatewayCode' response property
Added the new 'DECLINED_PIN_REQUIRED' enum value to the 'response/gatewayCode' response property
Added the new 'SAMSUNG_PAY' enum value to the 'order/walletProvider' response property

Non-Breaking changes

Added the new optional request property ' Capture /order/expectedNumberOfCaptures'
Added the new 'SAMSUNG_PAY' enum value to the request property ' Authorize /order/walletProvider'
Added the new 'SAMSUNG_PAY' enum value to the request property ' Pay /order/walletProvider'

Operations

Create Checkout Session

Breaking changes

Removed the enum value 'READ_ONLY' of the request property ' Create Checkout Session /interaction/displayControl/orderSummary'

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /interaction/displayControl/paymentConfirmation'
Added the new 'SHOW' enum value to the request property ' Create Checkout Session /interaction/displayControl/orderSummary'
Added the new 'SHOW_PARTIAL' enum value to the request property ' Create Checkout Session /interaction/displayControl/orderSummary'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session , Update Session With Payer Data

Breaking changes

Added the new 'SAMSUNG_PAY' enum value to the 'order/walletProvider' response property
Added the new 'SAMSUNG_PAY' enum value to the 'order/walletProvider' response property
Added the new 'SAMSUNG_PAY' enum value to the ' Retrieve Session /order/walletProvider' response property

Non-Breaking changes

Added the optional property 'order/expectedNumberOfCaptures' to the response
Added the optional property 'order/expectedNumberOfCaptures' to the response
Added the new optional request property ' Update Session /order/expectedNumberOfCaptures'
Added the new optional request property ' Update Session With Payer Data /order'
Added the new 'SAMSUNG_PAY' enum value to the request property ' Update Session /order/walletProvider'
Added the optional property ' Retrieve Session /order/expectedNumberOfCaptures' to the response

April 2017

Version 43

Operations

Retrieve Order

Breaking changes

Removed the optional property 'transaction/items/authorizationResponse/trackQuality' from the response
Added the new 'SEMI_ATTENDED' enum value to the 'transaction/items/posTerminal/attended' response property

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/card/deviceSpecificExpiry' to the response
Added the optional property 'sourceOfFunds/provided/card/encryption' to the response
Added the optional property 'sourceOfFunds/provided/card/pin' to the response
Added the optional property 'transaction/items/posTerminal/cardPresenceCapability' to the response
Added the optional property 'transaction/items/posTerminal/pinLengthCapability' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/deviceSpecificExpiry' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/encryption' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/pin' to the response
Added the optional property 'transaction/items/transaction/acquirer/additionalResponseData' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Removed the optional property 'authorizationResponse/trackQuality' from the response
Added the new 'SEMI_ATTENDED' enum value to the 'posTerminal/attended' response property
Removed the request property ' Verify /posTerminal/cardholderActivated'
Removed the request property ' Verify /posTerminal/inputCapability'
Removed the optional property 'authorizationResponse/trackQuality' from the response
Added the new 'SEMI_ATTENDED' enum value to the 'posTerminal/attended' response property

Non-Breaking changes

Added the optional property 'posTerminal/cardPresenceCapability' to the response
Added the optional property 'posTerminal/pinLengthCapability' to the response
Added the optional property 'sourceOfFunds/provided/card/deviceSpecificExpiry' to the response
Added the optional property 'sourceOfFunds/provided/card/encryption' to the response
Added the optional property 'sourceOfFunds/provided/card/pin' to the response
Added the optional property 'transaction/acquirer/additionalResponseData' to the response
Added the new optional request property ' Authorize /posTerminal/cardPresenceCapability'
Added the new optional request property ' Authorize /posTerminal/pinLengthCapability'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/pin'
Added the new optional request property ' Capture /posTerminal/cardPresenceCapability'
Added the new optional request property ' Capture /posTerminal/pinLengthCapability'
Added the new optional request property ' Capture /sourceOfFunds/provided/card/pin'
Added the new optional request property ' Pay /posTerminal/cardPresenceCapability'
Added the new optional request property ' Pay /posTerminal/pinLengthCapability'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/pin'
Added the new optional request property ' Refund /posTerminal/cardPresenceCapability'
Added the new optional request property ' Refund /posTerminal/pinLengthCapability'
Added the new optional request property ' Refund /sourceOfFunds/provided/card/pin'
Added the new optional request property ' Verify /posTerminal/pinLengthCapability'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/pin'
Added the new 'BARCODE' enum value to the request property ' Authorize /posTerminal/inputCapability'
Added the new 'BARCODE' enum value to the request property ' Capture /posTerminal/inputCapability'
Added the new 'BARCODE' enum value to the request property ' Pay /posTerminal/inputCapability'
Added the new 'BARCODE' enum value to the request property ' Refund /posTerminal/inputCapability'
Added the new 'CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID' enum value to the request property ' Authorize /posTerminal/inputCapability'
Added the new 'CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID' enum value to the request property ' Capture /posTerminal/inputCapability'
Added the new 'CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID' enum value to the request property ' Pay /posTerminal/inputCapability'
Added the new 'CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID' enum value to the request property ' Refund /posTerminal/inputCapability'
Added the new 'CONTACTLESS_OR_MAGNETIC_STRIPE' enum value to the request property ' Authorize /posTerminal/inputCapability'
Added the new 'CONTACTLESS_OR_MAGNETIC_STRIPE' enum value to the request property ' Capture /posTerminal/inputCapability'
Added the new 'CONTACTLESS_OR_MAGNETIC_STRIPE' enum value to the request property ' Pay /posTerminal/inputCapability'
Added the new 'CONTACTLESS_OR_MAGNETIC_STRIPE' enum value to the request property ' Refund /posTerminal/inputCapability'
Added the new 'ELECTRONIC_COMMERCE' enum value to the request property ' Authorize /posTerminal/cardholderActivated'
Added the new 'ELECTRONIC_COMMERCE' enum value to the request property ' Capture /posTerminal/cardholderActivated'
Added the new 'ELECTRONIC_COMMERCE' enum value to the request property ' Pay /posTerminal/cardholderActivated'
Added the new 'ELECTRONIC_COMMERCE' enum value to the request property ' Refund /posTerminal/cardholderActivated'
Added the new 'IN_FLIGHT_COMMERCE' enum value to the request property ' Authorize /posTerminal/cardholderActivated'
Added the new 'IN_FLIGHT_COMMERCE' enum value to the request property ' Capture /posTerminal/cardholderActivated'
Added the new 'IN_FLIGHT_COMMERCE' enum value to the request property ' Pay /posTerminal/cardholderActivated'
Added the new 'IN_FLIGHT_COMMERCE' enum value to the request property ' Refund /posTerminal/cardholderActivated'
Added the new 'LIMITED_AMOUNT_TERMINAL' enum value to the request property ' Authorize /posTerminal/cardholderActivated'
Added the new 'LIMITED_AMOUNT_TERMINAL' enum value to the request property ' Capture /posTerminal/cardholderActivated'
Added the new 'LIMITED_AMOUNT_TERMINAL' enum value to the request property ' Pay /posTerminal/cardholderActivated'
Added the new 'LIMITED_AMOUNT_TERMINAL' enum value to the request property ' Refund /posTerminal/cardholderActivated'
Added the new 'MPOS_ACCEPTANCE_DEVICE' enum value to the request property ' Authorize /posTerminal/cardholderActivated'
Added the new 'MPOS_ACCEPTANCE_DEVICE' enum value to the request property ' Capture /posTerminal/cardholderActivated'
Added the new 'MPOS_ACCEPTANCE_DEVICE' enum value to the request property ' Pay /posTerminal/cardholderActivated'
Added the new 'MPOS_ACCEPTANCE_DEVICE' enum value to the request property ' Refund /posTerminal/cardholderActivated'
Added the new 'SEMI_ATTENDED' enum value to the request property ' Authorize /posTerminal/attended'
Added the new 'SEMI_ATTENDED' enum value to the request property ' Capture /posTerminal/attended'
Added the new 'SEMI_ATTENDED' enum value to the request property ' Pay /posTerminal/attended'
Added the new 'SEMI_ATTENDED' enum value to the request property ' Refund /posTerminal/attended'
Added the new 'SEMI_ATTENDED' enum value to the request property ' Verify /posTerminal/attended'
Added the new 'TRANSPONDER_TRANSACTION' enum value to the request property ' Authorize /posTerminal/cardholderActivated'
Added the new 'TRANSPONDER_TRANSACTION' enum value to the request property ' Capture /posTerminal/cardholderActivated'
Added the new 'TRANSPONDER_TRANSACTION' enum value to the request property ' Pay /posTerminal/cardholderActivated'
Added the new 'TRANSPONDER_TRANSACTION' enum value to the request property ' Refund /posTerminal/cardholderActivated'
Added the new 'UNKNOWN' enum value to the request property ' Authorize /posTerminal/inputCapability'
Added the new 'UNKNOWN' enum value to the request property ' Capture /posTerminal/inputCapability'
Added the new 'UNKNOWN' enum value to the request property ' Pay /posTerminal/inputCapability'
Added the new 'UNKNOWN' enum value to the request property ' Refund /posTerminal/inputCapability'
Added the new 'VOICE_AUDIO_RESPONSE' enum value to the request property ' Authorize /posTerminal/inputCapability'
Added the new 'VOICE_AUDIO_RESPONSE' enum value to the request property ' Capture /posTerminal/inputCapability'
Added the new 'VOICE_AUDIO_RESPONSE' enum value to the request property ' Pay /posTerminal/inputCapability'
Added the new 'VOICE_AUDIO_RESPONSE' enum value to the request property ' Refund /posTerminal/inputCapability'
Added the optional property 'posTerminal/cardPresenceCapability' to the response
Added the optional property 'posTerminal/pinLengthCapability' to the response
Added the optional property 'sourceOfFunds/provided/card/deviceSpecificExpiry' to the response
Added the optional property 'sourceOfFunds/provided/card/encryption' to the response
Added the optional property 'sourceOfFunds/provided/card/pin' to the response
Added the optional property 'transaction/acquirer/additionalResponseData' to the response

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session , Update Session With Payer Data

Breaking changes

Added the new 'BARCODE' enum value to the 'posTerminal/inputCapability' response property
Added the new 'CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID' enum value to the 'posTerminal/inputCapability' response property
Added the new 'CONTACTLESS_OR_MAGNETIC_STRIPE' enum value to the 'posTerminal/inputCapability' response property
Added the new 'ELECTRONIC_COMMERCE' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'IN_FLIGHT_COMMERCE' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'LIMITED_AMOUNT_TERMINAL' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'MPOS_ACCEPTANCE_DEVICE' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'SEMI_ATTENDED' enum value to the 'posTerminal/attended' response property
Added the new 'TRANSPONDER_TRANSACTION' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'UNKNOWN' enum value to the 'posTerminal/inputCapability' response property
Added the new 'VOICE_AUDIO_RESPONSE' enum value to the 'posTerminal/inputCapability' response property
Added the new 'BARCODE' enum value to the 'posTerminal/inputCapability' response property
Added the new 'CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID' enum value to the 'posTerminal/inputCapability' response property
Added the new 'CONTACTLESS_OR_MAGNETIC_STRIPE' enum value to the 'posTerminal/inputCapability' response property
Added the new 'ELECTRONIC_COMMERCE' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'IN_FLIGHT_COMMERCE' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'LIMITED_AMOUNT_TERMINAL' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'MPOS_ACCEPTANCE_DEVICE' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'SEMI_ATTENDED' enum value to the 'posTerminal/attended' response property
Added the new 'TRANSPONDER_TRANSACTION' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'UNKNOWN' enum value to the 'posTerminal/inputCapability' response property
Added the new 'VOICE_AUDIO_RESPONSE' enum value to the 'posTerminal/inputCapability' response property
Added the new 'BARCODE' enum value to the ' Retrieve Session /posTerminal/inputCapability' response property
Added the new 'CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID' enum value to the ' Retrieve Session /posTerminal/inputCapability' response property
Added the new 'CONTACTLESS_OR_MAGNETIC_STRIPE' enum value to the ' Retrieve Session /posTerminal/inputCapability' response property
Added the new 'ELECTRONIC_COMMERCE' enum value to the ' Retrieve Session /posTerminal/cardholderActivated' response property
Added the new 'IN_FLIGHT_COMMERCE' enum value to the ' Retrieve Session /posTerminal/cardholderActivated' response property
Added the new 'LIMITED_AMOUNT_TERMINAL' enum value to the ' Retrieve Session /posTerminal/cardholderActivated' response property
Added the new 'MPOS_ACCEPTANCE_DEVICE' enum value to the ' Retrieve Session /posTerminal/cardholderActivated' response property
Added the new 'SEMI_ATTENDED' enum value to the ' Retrieve Session /posTerminal/attended' response property
Added the new 'TRANSPONDER_TRANSACTION' enum value to the ' Retrieve Session /posTerminal/cardholderActivated' response property
Added the new 'UNKNOWN' enum value to the ' Retrieve Session /posTerminal/inputCapability' response property
Added the new 'VOICE_AUDIO_RESPONSE' enum value to the ' Retrieve Session /posTerminal/inputCapability' response property

Non-Breaking changes

Added the optional property 'posTerminal/cardPresenceCapability' to the response
Added the optional property 'posTerminal/pinLengthCapability' to the response
Added the optional property 'sourceOfFunds/provided/card/pin' to the response
Added the optional property 'posTerminal/cardPresenceCapability' to the response
Added the optional property 'posTerminal/pinLengthCapability' to the response
Added the optional property 'sourceOfFunds/provided/card/pin' to the response
Added the new optional request property ' Update Session /posTerminal/cardPresenceCapability'
Added the new optional request property ' Update Session /posTerminal/pinLengthCapability'
Added the new optional request property ' Update Session /sourceOfFunds/provided/card/pin'
Added the new 'BARCODE' enum value to the request property ' Update Session /posTerminal/inputCapability'
Added the new 'CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID' enum value to the request property ' Update Session /posTerminal/inputCapability'
Added the new 'CONTACTLESS_OR_MAGNETIC_STRIPE' enum value to the request property ' Update Session /posTerminal/inputCapability'
Added the new 'ELECTRONIC_COMMERCE' enum value to the request property ' Update Session /posTerminal/cardholderActivated'
Added the new 'IN_FLIGHT_COMMERCE' enum value to the request property ' Update Session /posTerminal/cardholderActivated'
Added the new 'LIMITED_AMOUNT_TERMINAL' enum value to the request property ' Update Session /posTerminal/cardholderActivated'
Added the new 'MPOS_ACCEPTANCE_DEVICE' enum value to the request property ' Update Session /posTerminal/cardholderActivated'
Added the new 'SEMI_ATTENDED' enum value to the request property ' Update Session /posTerminal/attended'
Added the new 'TRANSPONDER_TRANSACTION' enum value to the request property ' Update Session /posTerminal/cardholderActivated'
Added the new 'UNKNOWN' enum value to the request property ' Update Session /posTerminal/inputCapability'
Added the new 'VOICE_AUDIO_RESPONSE' enum value to the request property ' Update Session /posTerminal/inputCapability'
Added the optional property ' Retrieve Session /posTerminal/cardPresenceCapability' to the response
Added the optional property ' Retrieve Session /posTerminal/pinLengthCapability' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/card/pin' to the response

February 2017

Version 42

Operations

Retrieve Order

Breaking changes

The 'taxRegistrationId' response property's maxLength was increased from '20' to '30'
The 'transaction/items/order/taxRegistrationId' response property's maxLength was increased from '20' to '30'
Removed the optional property 'transaction/items/transaction/cashAdvance' from the response
Added the new 'BARCODE' enum value to the 'transaction/items/posTerminal/inputCapability' response property
Added the new 'CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID' enum value to the 'transaction/items/posTerminal/inputCapability' response property
Added the new 'CONTACTLESS_OR_MAGNETIC_STRIPE' enum value to the 'transaction/items/posTerminal/inputCapability' response property
Added the new 'ELECTRONIC_COMMERCE' enum value to the 'transaction/items/posTerminal/cardholderActivated' response property
Added the new 'IN_FLIGHT_COMMERCE' enum value to the 'transaction/items/posTerminal/cardholderActivated' response property
Added the new 'LIMITED_AMOUNT_TERMINAL' enum value to the 'transaction/items/posTerminal/cardholderActivated' response property
Added the new 'MPOS_ACCEPTANCE_DEVICE' enum value to the 'transaction/items/posTerminal/cardholderActivated' response property
Added the new 'TRANSPONDER_TRANSACTION' enum value to the 'transaction/items/posTerminal/cardholderActivated' response property
Added the new 'UNKNOWN' enum value to the 'transaction/items/posTerminal/inputCapability' response property
Added the new 'VOICE_AUDIO_RESPONSE' enum value to the 'transaction/items/posTerminal/inputCapability' response property

Non-Breaking changes

Added the optional property 'cashAdvance' to the response
Added the optional property 'customer/taxRegistrationId' to the response
Added the optional property 'invoiceNumber' to the response
Added the optional property 'item/items/detail' to the response
Added the optional property 'item/items/unitDiscountAmount' to the response
Added the optional property 'item/items/unitOfMeasure' to the response
Added the optional property 'localTaxRegistrationId' to the response
Added the optional property 'shipping/origin' to the response
Added the optional property 'tax/items/rate' to the response
Added the optional property 'taxStatus' to the response
Added the optional property 'transaction/items/customer/taxRegistrationId' to the response
Added the optional property 'transaction/items/order/cashAdvance' to the response
Added the optional property 'transaction/items/order/invoiceNumber' to the response
Added the optional property 'transaction/items/order/item/items/detail' to the response
Added the optional property 'transaction/items/order/item/items/unitDiscountAmount' to the response
Added the optional property 'transaction/items/order/item/items/unitOfMeasure' to the response
Added the optional property 'transaction/items/order/localTaxRegistrationId' to the response
Added the optional property 'transaction/items/order/tax/items/rate' to the response
Added the optional property 'transaction/items/order/taxStatus' to the response
Added the optional property 'transaction/items/posTerminal/address' to the response
Added the optional property 'transaction/items/posTerminal/authorizationMethod' to the response
Added the optional property 'transaction/items/posTerminal/onlineReasonCode' to the response
Added the optional property 'transaction/items/shipping/origin' to the response
Added the optional property 'transaction/items/transaction/discountAmount' to the response
Added the optional property 'transaction/items/transaction/item/items/detail' to the response
Added the optional property 'transaction/items/transaction/item/items/unitDiscountAmount' to the response
Added the optional property 'transaction/items/transaction/item/items/unitOfMeasure' to the response
Added the optional property 'transaction/items/transaction/itemAmount' to the response
Added the optional property 'transaction/items/transaction/shippingAndHandlingAmount' to the response
Added the optional property 'transaction/items/transaction/tax/items/rate' to the response
Added the optional property 'transaction/items/transaction/taxStatus' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

The 'order/taxRegistrationId' response property's maxLength was increased from '20' to '30'
The 'order/taxRegistrationId' response property's maxLength was increased from '20' to '30'
Removed the optional property 'transaction/cashAdvance' from the response
Added the new 'BARCODE' enum value to the 'posTerminal/inputCapability' response property
Added the new 'CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID' enum value to the 'posTerminal/inputCapability' response property
Added the new 'CONTACTLESS_OR_MAGNETIC_STRIPE' enum value to the 'posTerminal/inputCapability' response property
Added the new 'ELECTRONIC_COMMERCE' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'IN_FLIGHT_COMMERCE' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'LIMITED_AMOUNT_TERMINAL' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'MPOS_ACCEPTANCE_DEVICE' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'TRANSPONDER_TRANSACTION' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'UNKNOWN' enum value to the 'posTerminal/inputCapability' response property
Added the new 'VOICE_AUDIO_RESPONSE' enum value to the 'posTerminal/inputCapability' response property
Removed the request property ' Authorize /transaction/cashAdvance'
Removed the request property ' Pay /transaction/cashAdvance'
Removed the request property ' Refund /billing'
Removed the request property ' Refund /order/customerOrderDate'
Removed the request property ' Refund /order/customerReference'
Removed the request property ' Refund /order/requestorName'
Removed the request property ' Refund /order/taxRegistrationId'
Removed the request property ' Refund /shipping'
Removed the optional property 'transaction/cashAdvance' from the response
Added the new 'BARCODE' enum value to the 'posTerminal/inputCapability' response property
Added the new 'CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID' enum value to the 'posTerminal/inputCapability' response property
Added the new 'CONTACTLESS_OR_MAGNETIC_STRIPE' enum value to the 'posTerminal/inputCapability' response property
Added the new 'ELECTRONIC_COMMERCE' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'IN_FLIGHT_COMMERCE' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'LIMITED_AMOUNT_TERMINAL' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'MPOS_ACCEPTANCE_DEVICE' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'TRANSPONDER_TRANSACTION' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'UNKNOWN' enum value to the 'posTerminal/inputCapability' response property
Added the new 'VOICE_AUDIO_RESPONSE' enum value to the 'posTerminal/inputCapability' response property

Non-Breaking changes

Added the optional property 'customer/taxRegistrationId' to the response
Added the optional property 'order/cashAdvance' to the response
Added the optional property 'order/invoiceNumber' to the response
Added the optional property 'order/item/items/detail' to the response
Added the optional property 'order/item/items/unitDiscountAmount' to the response
Added the optional property 'order/item/items/unitOfMeasure' to the response
Added the optional property 'order/localTaxRegistrationId' to the response
Added the optional property 'order/tax/items/rate' to the response
Added the optional property 'order/taxStatus' to the response
Added the optional property 'posTerminal/address' to the response
Added the optional property 'posTerminal/authorizationMethod' to the response
Added the optional property 'posTerminal/onlineReasonCode' to the response
Added the optional property 'shipping/origin' to the response
Added the optional property 'transaction/discountAmount' to the response
Added the optional property 'transaction/item/items/detail' to the response
Added the optional property 'transaction/item/items/unitDiscountAmount' to the response
Added the optional property 'transaction/item/items/unitOfMeasure' to the response
Added the optional property 'transaction/itemAmount' to the response
Added the optional property 'transaction/shippingAndHandlingAmount' to the response
Added the optional property 'transaction/tax/items/rate' to the response
Added the optional property 'transaction/taxStatus' to the response
Added the new optional request property ' Void /posTerminal'
Added the new optional request property ' Confirm /order/item/items/detail'
Added the new optional request property ' Confirm /order/item/items/unitDiscountAmount'
Added the new optional request property ' Confirm /order/item/items/unitOfMeasure'
Added the new optional request property ' Initiate /order/item/items/detail'
Added the new optional request property ' Initiate /order/item/items/unitDiscountAmount'
Added the new optional request property ' Initiate /order/item/items/unitOfMeasure'
Added the new optional request property ' Initiate /order/tax/items/rate'
Added the new optional request property ' Authorize /customer/taxRegistrationId'
Added the new optional request property ' Authorize /order/cashAdvance'
Added the new optional request property ' Authorize /order/invoiceNumber'
Added the new optional request property ' Authorize /order/item/items/detail'
Added the new optional request property ' Authorize /order/item/items/unitDiscountAmount'
Added the new optional request property ' Authorize /order/item/items/unitOfMeasure'
Added the new optional request property ' Authorize /order/localTaxRegistrationId'
Added the new optional request property ' Authorize /order/tax/items/rate'
Added the new optional request property ' Authorize /order/taxStatus'
Added the new optional request property ' Authorize /posTerminal/address'
Added the new optional request property ' Authorize /posTerminal/onlineReasonCode'
Added the new optional request property ' Authorize /shipping/origin'
Added the new optional request property ' Capture /customer/taxRegistrationId'
Added the new optional request property ' Capture /order/invoiceNumber'
Added the new optional request property ' Capture /order/localTaxRegistrationId'
Added the new optional request property ' Capture /order/taxStatus'
Added the new optional request property ' Capture /posTerminal/address'
Added the new optional request property ' Capture /posTerminal/authorizationMethod'
Added the new optional request property ' Capture /posTerminal/onlineReasonCode'
Added the new optional request property ' Capture /shipping/origin'
Added the new optional request property ' Capture /transaction/discountAmount'
Added the new optional request property ' Capture /transaction/item/items/detail'
Added the new optional request property ' Capture /transaction/item/items/unitDiscountAmount'
Added the new optional request property ' Capture /transaction/item/items/unitOfMeasure'
Added the new optional request property ' Capture /transaction/itemAmount'
Added the new optional request property ' Capture /transaction/shippingAndHandlingAmount'
Added the new optional request property ' Capture /transaction/tax/items/rate'
Added the new optional request property ' Capture /transaction/taxStatus'
Added the new optional request property ' Pay /customer/taxRegistrationId'
Added the new optional request property ' Pay /order/cashAdvance'
Added the new optional request property ' Pay /order/invoiceNumber'
Added the new optional request property ' Pay /order/item/items/detail'
Added the new optional request property ' Pay /order/item/items/unitDiscountAmount'
Added the new optional request property ' Pay /order/item/items/unitOfMeasure'
Added the new optional request property ' Pay /order/localTaxRegistrationId'
Added the new optional request property ' Pay /order/tax/items/rate'
Added the new optional request property ' Pay /order/taxStatus'
Added the new optional request property ' Pay /posTerminal/address'
Added the new optional request property ' Pay /posTerminal/onlineReasonCode'
Added the new optional request property ' Pay /shipping/origin'
Added the new optional request property ' Refund /posTerminal/address'
Added the new optional request property ' Refund /posTerminal/onlineReasonCode'
Added the new optional request property ' Refund /transaction/discountAmount'
Added the new optional request property ' Refund /transaction/item/items/detail'
Added the new optional request property ' Refund /transaction/item/items/unitDiscountAmount'
Added the new optional request property ' Refund /transaction/item/items/unitOfMeasure'
Added the new optional request property ' Refund /transaction/itemAmount'
Added the new optional request property ' Refund /transaction/shippingAndHandlingAmount'
Added the new optional request property ' Refund /transaction/tax/items/rate'
Added the new optional request property ' Refund /transaction/taxStatus'
Added the new optional request property ' Verify /customer/taxRegistrationId'
Added the new optional request property ' Verify /order/customerOrderDate'
Added the new optional request property ' Verify /order/customerReference'
Added the new optional request property ' Verify /order/invoiceNumber'
Added the new optional request property ' Verify /order/item/items/detail'
Added the new optional request property ' Verify /order/item/items/unitDiscountAmount'
Added the new optional request property ' Verify /order/item/items/unitOfMeasure'
Added the new optional request property ' Verify /order/localTaxRegistrationId'
Added the new optional request property ' Verify /order/requestorName'
Added the new optional request property ' Verify /order/tax/items/rate'
Added the new optional request property ' Verify /order/taxRegistrationId'
Added the new optional request property ' Verify /order/taxStatus'
Added the new optional request property ' Verify /shipping/origin'
The ' Authorize /order/taxRegistrationId' request property's maxLength was increased from '20' to '30'
The ' Capture /order/taxRegistrationId' request property's maxLength was increased from '20' to '30'
The ' Pay /order/taxRegistrationId' request property's maxLength was increased from '20' to '30'
Added the optional property 'customer/taxRegistrationId' to the response
Added the optional property 'order/cashAdvance' to the response
Added the optional property 'order/invoiceNumber' to the response
Added the optional property 'order/item/items/detail' to the response
Added the optional property 'order/item/items/unitDiscountAmount' to the response
Added the optional property 'order/item/items/unitOfMeasure' to the response
Added the optional property 'order/localTaxRegistrationId' to the response
Added the optional property 'order/tax/items/rate' to the response
Added the optional property 'order/taxStatus' to the response
Added the optional property 'posTerminal/address' to the response
Added the optional property 'posTerminal/authorizationMethod' to the response
Added the optional property 'posTerminal/onlineReasonCode' to the response
Added the optional property 'shipping/origin' to the response
Added the optional property 'transaction/discountAmount' to the response
Added the optional property 'transaction/item/items/detail' to the response
Added the optional property 'transaction/item/items/unitDiscountAmount' to the response
Added the optional property 'transaction/item/items/unitOfMeasure' to the response
Added the optional property 'transaction/itemAmount' to the response
Added the optional property 'transaction/shippingAndHandlingAmount' to the response
Added the optional property 'transaction/tax/items/rate' to the response
Added the optional property 'transaction/taxStatus' to the response

Operations

Create Checkout Session

Breaking changes

The ' Create Checkout Session /risk/paymentRecipient' request property type/format changed from 'object'/'' to ''/''
Removed the request property ' Create Checkout Session /order/acceptPartialAmount'
Removed the request property ' Create Checkout Session /risk/paymentRecipient/accountIdentifier'
Removed the request property ' Create Checkout Session /risk/paymentRecipient/dateOfBirth'
Removed the request property ' Create Checkout Session /risk/paymentRecipient/lastName'
Removed the request property ' Create Checkout Session /risk/paymentRecipient/postcodeZip'
Removed the request property ' Create Checkout Session /transaction/cashAdvance'

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /order/cashAdvance'
Added the new optional request property ' Create Checkout Session /order/item/items/detail'
Added the new optional request property ' Create Checkout Session /posTerminal'
The ' Create Checkout Session /order/taxRegistrationId' request property's maxLength was increased from '20' to '30'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session , Update Session With Payer Data

Breaking changes

The 'order/taxRegistrationId' response property's maxLength was increased from '20' to '30'
The 'order/taxRegistrationId' response property's maxLength was increased from '20' to '30'
The ' Retrieve Session /order/taxRegistrationId' response property's maxLength was increased from '20' to '30'
Removed the optional property 'transaction/cashAdvance' from the response
Removed the optional property 'transaction/cashAdvance' from the response
Removed the request property ' Update Session /transaction/cashAdvance'
Removed the optional property ' Retrieve Session /transaction/cashAdvance' from the response

Non-Breaking changes

Added the optional property 'customer/taxRegistrationId' to the response
Added the optional property 'order/cashAdvance' to the response
Added the optional property 'order/invoiceNumber' to the response
Added the optional property 'order/item/items/detail' to the response
Added the optional property 'order/item/items/unitDiscountAmount' to the response
Added the optional property 'order/item/items/unitOfMeasure' to the response
Added the optional property 'order/localTaxRegistrationId' to the response
Added the optional property 'order/tax/items/rate' to the response
Added the optional property 'order/taxStatus' to the response
Added the optional property 'posTerminal/address' to the response
Added the optional property 'posTerminal/authorizationMethod' to the response
Added the optional property 'posTerminal/onlineReasonCode' to the response
Added the optional property 'shipping/origin' to the response
Added the optional property 'transaction/discountAmount' to the response
Added the optional property 'transaction/item/items/detail' to the response
Added the optional property 'transaction/item/items/unitDiscountAmount' to the response
Added the optional property 'transaction/item/items/unitOfMeasure' to the response
Added the optional property 'transaction/itemAmount' to the response
Added the optional property 'transaction/shippingAndHandlingAmount' to the response
Added the optional property 'transaction/tax/items/rate' to the response
Added the optional property 'transaction/taxStatus' to the response
Added the new optional request property ' Open Wallet /order/item/items/detail'
Added the new optional request property ' Open Wallet /order/item/items/unitDiscountAmount'
Added the new optional request property ' Open Wallet /order/item/items/unitOfMeasure'
Added the new optional request property ' Open Wallet /order/tax/items/rate'
Added the optional property 'customer/taxRegistrationId' to the response
Added the optional property 'order/cashAdvance' to the response
Added the optional property 'order/invoiceNumber' to the response
Added the optional property 'order/item/items/detail' to the response
Added the optional property 'order/item/items/unitDiscountAmount' to the response
Added the optional property 'order/item/items/unitOfMeasure' to the response
Added the optional property 'order/localTaxRegistrationId' to the response
Added the optional property 'order/tax/items/rate' to the response
Added the optional property 'order/taxStatus' to the response
Added the optional property 'posTerminal/address' to the response
Added the optional property 'posTerminal/authorizationMethod' to the response
Added the optional property 'posTerminal/onlineReasonCode' to the response
Added the optional property 'shipping/origin' to the response
Added the optional property 'transaction/discountAmount' to the response
Added the optional property 'transaction/item/items/detail' to the response
Added the optional property 'transaction/item/items/unitDiscountAmount' to the response
Added the optional property 'transaction/item/items/unitOfMeasure' to the response
Added the optional property 'transaction/itemAmount' to the response
Added the optional property 'transaction/shippingAndHandlingAmount' to the response
Added the optional property 'transaction/tax/items/rate' to the response
Added the optional property 'transaction/taxStatus' to the response
Added the new optional request property ' Update Session /customer/taxRegistrationId'
Added the new optional request property ' Update Session /order/cashAdvance'
Added the new optional request property ' Update Session /order/invoiceNumber'
Added the new optional request property ' Update Session /order/item/items/detail'
Added the new optional request property ' Update Session /order/item/items/unitDiscountAmount'
Added the new optional request property ' Update Session /order/item/items/unitOfMeasure'
Added the new optional request property ' Update Session /order/localTaxRegistrationId'
Added the new optional request property ' Update Session /order/tax/items/rate'
Added the new optional request property ' Update Session /order/taxStatus'
Added the new optional request property ' Update Session /posTerminal/address'
Added the new optional request property ' Update Session /posTerminal/authorizationMethod'
Added the new optional request property ' Update Session /posTerminal/onlineReasonCode'
Added the new optional request property ' Update Session /shipping/origin'
Added the new optional request property ' Update Session /transaction/discountAmount'
Added the new optional request property ' Update Session /transaction/item/items/detail'
Added the new optional request property ' Update Session /transaction/item/items/unitDiscountAmount'
Added the new optional request property ' Update Session /transaction/item/items/unitOfMeasure'
Added the new optional request property ' Update Session /transaction/itemAmount'
Added the new optional request property ' Update Session /transaction/shippingAndHandlingAmount'
Added the new optional request property ' Update Session /transaction/tax/items/rate'
Added the new optional request property ' Update Session /transaction/taxStatus'
Added the new optional request property ' Update Session With Payer Data /customer/taxRegistrationId'
Added the new optional request property ' Update Session With Payer Data /shipping/origin'
The ' Update Session /order/taxRegistrationId' request property's maxLength was increased from '20' to '30'
Added the optional property ' Retrieve Session /customer/taxRegistrationId' to the response
Added the optional property ' Retrieve Session /order/cashAdvance' to the response
Added the optional property ' Retrieve Session /order/invoiceNumber' to the response
Added the optional property ' Retrieve Session /order/item/items/detail' to the response
Added the optional property ' Retrieve Session /order/item/items/unitDiscountAmount' to the response
Added the optional property ' Retrieve Session /order/item/items/unitOfMeasure' to the response
Added the optional property ' Retrieve Session /order/localTaxRegistrationId' to the response
Added the optional property ' Retrieve Session /order/tax/items/rate' to the response
Added the optional property ' Retrieve Session /order/taxStatus' to the response
Added the optional property ' Retrieve Session /posTerminal/address' to the response
Added the optional property ' Retrieve Session /posTerminal/authorizationMethod' to the response
Added the optional property ' Retrieve Session /posTerminal/onlineReasonCode' to the response
Added the optional property ' Retrieve Session /shipping/origin' to the response
Added the optional property ' Retrieve Session /transaction/discountAmount' to the response
Added the optional property ' Retrieve Session /transaction/item/items/detail' to the response
Added the optional property ' Retrieve Session /transaction/item/items/unitDiscountAmount' to the response
Added the optional property ' Retrieve Session /transaction/item/items/unitOfMeasure' to the response
Added the optional property ' Retrieve Session /transaction/itemAmount' to the response
Added the optional property ' Retrieve Session /transaction/shippingAndHandlingAmount' to the response
Added the optional property ' Retrieve Session /transaction/tax/items/rate' to the response
Added the optional property ' Retrieve Session /transaction/taxStatus' to the response

December 2016

Version 41

Operations

Retrieve Order

Breaking changes

Removed the optional property 'productSKU' from the response
Removed the optional property 'transaction/items/order/productSKU' from the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Removed the optional property 'order/productSKU' from the response
Removed the request property ' Authorize /order/productSKU'
Removed the request property ' Capture /order/productSKU'
Removed the request property ' Pay /order/productSKU'
Removed the request property ' Refund /order/productSKU'
Removed the request property ' Verify /order/productSKU'
Removed the optional property 'order/productSKU' from the response

Non-Breaking changes

Added the new optional request property ' Confirm /order/discount'
Added the new optional request property ' Confirm /order/item/items/industryCategory'
Added the new optional request property ' Initiate /order/discount'
Added the new optional request property ' Initiate /order/item/items/industryCategory'
Added the new optional request property ' Capture /order/cashbackAmount'
Added the new optional request property ' Capture /order/gratuityAmount'
Added the new optional request property ' Verify /order/item/items/industryCategory'

Operations

Create Checkout Session

Breaking changes

Removed the request property ' Create Checkout Session /order/productSKU'

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session , Update Session With Payer Data

Breaking changes

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

Non-Breaking changes

Added the new optional request property ' Open Wallet /order/cashbackAmount'
Added the new optional request property ' Open Wallet /order/discount'
Added the new optional request property ' Open Wallet /order/gratuityAmount'
Added the new optional request property ' Open Wallet /order/item/items/industryCategory'

August 2016

Version 40

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Non-Breaking changes

Added the new optional request property 'lineOfBusiness'

Operations

Retrieve Order

Breaking changes

The response property 'transaction/items/posTerminal/lane' became optional
Removed the optional property 'transaction/items/posTerminal/entryMode' from the response
Removed the optional property 'transaction/items/posTerminal/eposId' from the response
Added the new 'AUTOMATED_DISPENSING_MACHINE_WITH_PIN' enum value to the 'transaction/items/posTerminal/cardholderActivated' response property
Added the new 'MERCHANT_TERMINAL_OFF_PREMISES' enum value to the 'transaction/items/posTerminal/location' response property
Added the new 'MERCHANT_TERMINAL_ON_PREMISES' enum value to the 'transaction/items/posTerminal/location' response property
Added the new 'NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE' enum value to the 'transaction/items/posTerminal/location' response property
Added the new 'PAYER_TERMINAL_OFF_PREMISES' enum value to the 'transaction/items/posTerminal/location' response property
Added the new 'PAYER_TERMINAL_ON_PREMISES' enum value to the 'transaction/items/posTerminal/location' response property

Non-Breaking changes

Added the optional property 'cashbackAmount' to the response
Added the optional property 'gratuityAmount' to the response
Added the optional property 'lineOfBusiness' to the response
Added the optional property 'sourceOfFunds/provided/card/emvRequest' to the response
Added the optional property 'sourceOfFunds/provided/card/emvResponse' to the response
Added the optional property 'transaction/items/lineOfBusiness' to the response
Added the optional property 'transaction/items/order/cashbackAmount' to the response
Added the optional property 'transaction/items/order/gratuityAmount' to the response
Added the optional property 'transaction/items/posTerminal/panEntryMode' to the response
Added the optional property 'transaction/items/posTerminal/pinEntryCapability' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/emvRequest' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/emvResponse' to the response
Added the optional property 'transaction/items/transaction/acquirer/settlementDate' to the response
Added the optional property 'transaction/items/transaction/acquirer/timeZone' to the response
Removed the 'OFF_CARD_ACCEPTOR_PREMISES' enum value from the 'transaction/items/posTerminal/location' response property
Removed the 'ON_CARD_ACCEPTOR_PREMISES' enum value from the 'transaction/items/posTerminal/location' response property
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

The response property 'posTerminal/lane' became optional
Added the new required request property ' Authorize /sourceOfFunds/provided/card/p2pe/payload'
Added the new required request property ' Capture /sourceOfFunds/provided/card/p2pe/payload'
Added the new required request property ' Pay /sourceOfFunds/provided/card/p2pe/payload'
Added the new required request property ' Refund /sourceOfFunds/provided/card/p2pe/payload'
Added the new required request property ' Verify /sourceOfFunds/provided/card/p2pe/payload'
Request property ' Capture /sourceOfFunds/provided/card/p2pe/encryptionState' was restricted to a list of enum values
Request property ' Refund /sourceOfFunds/provided/card/p2pe/encryptionState' was restricted to a list of enum values
Request property ' Verify /sourceOfFunds/provided/card/p2pe/encryptionState' was restricted to a list of enum values
The request property ' Authorize /sourceOfFunds/provided/card/p2pe/keySerialNumber' became required
The request property ' Capture /sourceOfFunds/provided/card/p2pe/keySerialNumber' became required
The request property ' Pay /sourceOfFunds/provided/card/p2pe/keySerialNumber' became required
The request property ' Refund /sourceOfFunds/provided/card/p2pe/keySerialNumber' became required
The request property ' Verify /sourceOfFunds/provided/card/p2pe/keySerialNumber' became required
Removed the enum value 'OFF_CARD_ACCEPTOR_PREMISES' of the request property ' Authorize /posTerminal/location'
Removed the enum value 'OFF_CARD_ACCEPTOR_PREMISES' of the request property ' Capture /posTerminal/location'
Removed the enum value 'OFF_CARD_ACCEPTOR_PREMISES' of the request property ' Pay /posTerminal/location'
Removed the enum value 'OFF_CARD_ACCEPTOR_PREMISES' of the request property ' Refund /posTerminal/location'
Removed the enum value 'OFF_CARD_ACCEPTOR_PREMISES' of the request property ' Verify /posTerminal/location'
Removed the enum value 'ON_CARD_ACCEPTOR_PREMISES' of the request property ' Authorize /posTerminal/location'
Removed the enum value 'ON_CARD_ACCEPTOR_PREMISES' of the request property ' Capture /posTerminal/location'
Removed the enum value 'ON_CARD_ACCEPTOR_PREMISES' of the request property ' Pay /posTerminal/location'
Removed the enum value 'ON_CARD_ACCEPTOR_PREMISES' of the request property ' Refund /posTerminal/location'
Removed the enum value 'ON_CARD_ACCEPTOR_PREMISES' of the request property ' Verify /posTerminal/location'
The response property 'posTerminal/lane' became optional
Removed the optional property 'posTerminal/entryMode' from the response
Removed the optional property 'posTerminal/eposId' from the response
Added the new 'AUTOMATED_DISPENSING_MACHINE_WITH_PIN' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'MERCHANT_TERMINAL_OFF_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'MERCHANT_TERMINAL_ON_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE' enum value to the 'posTerminal/location' response property
Added the new 'PAYER_TERMINAL_OFF_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'PAYER_TERMINAL_ON_PREMISES' enum value to the 'posTerminal/location' response property
Added the pattern to the request property ' Void /sourceOfFunds/provided/card/track1'
Added the pattern to the request property ' Authorize /sourceOfFunds/provided/card/track1'
Added the pattern to the request property ' Capture /sourceOfFunds/provided/card/track1'
Added the pattern to the request property ' Pay /sourceOfFunds/provided/card/track1'
Added the pattern to the request property ' Refund /sourceOfFunds/provided/card/track1'
Added the pattern to the request property ' Void /sourceOfFunds/provided/card/track2'
Added the pattern to the request property ' Authorize /sourceOfFunds/provided/card/track2'
Added the pattern to the request property ' Capture /sourceOfFunds/provided/card/track2'
Added the pattern to the request property ' Pay /sourceOfFunds/provided/card/track2'
Added the pattern to the request property ' Refund /sourceOfFunds/provided/card/track2'
Removed the request property ' Authorize /posTerminal/entryMode'
Removed the request property ' Authorize /posTerminal/eposId'
Removed the request property ' Authorize /sourceOfFunds/provided/card/payload'
Removed the request property ' Capture /posTerminal/entryMode'
Removed the request property ' Capture /posTerminal/eposId'
Removed the request property ' Capture /sourceOfFunds/provided/card/payload'
Removed the request property ' Pay /posTerminal/entryMode'
Removed the request property ' Pay /posTerminal/eposId'
Removed the request property ' Pay /sourceOfFunds/provided/card/payload'
Removed the request property ' Refund /posTerminal/entryMode'
Removed the request property ' Refund /posTerminal/eposId'
Removed the request property ' Refund /sourceOfFunds/provided/card/payload'
Removed the request property ' Verify /posTerminal/entryMode'
Removed the request property ' Verify /posTerminal/eposId'
Removed the request property ' Verify /sourceOfFunds/provided/card/payload'
Removed the optional property 'posTerminal/entryMode' from the response
Removed the optional property 'posTerminal/eposId' from the response
Added the new 'AUTOMATED_DISPENSING_MACHINE_WITH_PIN' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'MERCHANT_TERMINAL_OFF_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'MERCHANT_TERMINAL_ON_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE' enum value to the 'posTerminal/location' response property
Added the new 'PAYER_TERMINAL_OFF_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'PAYER_TERMINAL_ON_PREMISES' enum value to the 'posTerminal/location' response property

Non-Breaking changes

Added the optional property 'lineOfBusiness' to the response
Added the optional property 'order/cashbackAmount' to the response
Added the optional property 'order/gratuityAmount' to the response
Added the optional property 'posTerminal/panEntryMode' to the response
Added the optional property 'posTerminal/pinEntryCapability' to the response
Added the optional property 'sourceOfFunds/provided/card/emvRequest' to the response
Added the optional property 'sourceOfFunds/provided/card/emvResponse' to the response
Added the optional property 'transaction/acquirer/settlementDate' to the response
Added the optional property 'transaction/acquirer/timeZone' to the response
Removed the 'OFF_CARD_ACCEPTOR_PREMISES' enum value from the 'posTerminal/location' response property
Removed the 'ON_CARD_ACCEPTOR_PREMISES' enum value from the 'posTerminal/location' response property
Added the new optional request property ' Void /action'
Added the new optional request property ' Void /sourceOfFunds/provided/card/emvRequest'
Added the new optional request property ' Void /sourceOfFunds/provided/card/p2pe'
Added the new optional request property ' Initiate /lineOfBusiness'
Added the new optional request property ' Authorize /lineOfBusiness'
Added the new optional request property ' Authorize /posTerminal/panEntryMode'
Added the new optional request property ' Authorize /posTerminal/pinEntryCapability'
Added the new optional request property ' Capture /lineOfBusiness'
Added the new optional request property ' Capture /posTerminal/panEntryMode'
Added the new optional request property ' Capture /posTerminal/pinEntryCapability'
Added the new optional request property ' Capture /sourceOfFunds/provided/card/emvRequest'
Added the new optional request property ' Pay /lineOfBusiness'
Added the new optional request property ' Pay /posTerminal/panEntryMode'
Added the new optional request property ' Pay /posTerminal/pinEntryCapability'
Added the new optional request property ' Refund /lineOfBusiness'
Added the new optional request property ' Refund /posTerminal/panEntryMode'
Added the new optional request property ' Refund /posTerminal/pinEntryCapability'
Added the new optional request property ' Refund /sourceOfFunds/provided/card/emvRequest'
Added the new optional request property ' Verify /lineOfBusiness'
Added the new optional request property ' Verify /posTerminal/panEntryMode'
Added the new optional request property ' Verify /posTerminal/pinEntryCapability'
The request property ' Authorize /posTerminal/lane' became optional
The request property ' Capture /posTerminal/lane' became optional
The request property ' Pay /posTerminal/lane' became optional
The request property ' Refund /posTerminal/lane' became optional
The request property ' Verify /posTerminal/lane' became optional
Added the new 'AUTOMATED_DISPENSING_MACHINE_WITH_PIN' enum value to the request property ' Authorize /posTerminal/cardholderActivated'
Added the new 'AUTOMATED_DISPENSING_MACHINE_WITH_PIN' enum value to the request property ' Capture /posTerminal/cardholderActivated'
Added the new 'AUTOMATED_DISPENSING_MACHINE_WITH_PIN' enum value to the request property ' Pay /posTerminal/cardholderActivated'
Added the new 'AUTOMATED_DISPENSING_MACHINE_WITH_PIN' enum value to the request property ' Refund /posTerminal/cardholderActivated'
Added the new 'AUTOMATED_DISPENSING_MACHINE_WITH_PIN' enum value to the request property ' Verify /posTerminal/cardholderActivated'
Added the new 'INVALID' enum value to the request property ' Capture /sourceOfFunds/provided/card/p2pe/encryptionState'
Added the new 'INVALID' enum value to the request property ' Refund /sourceOfFunds/provided/card/p2pe/encryptionState'
Added the new 'INVALID' enum value to the request property ' Verify /sourceOfFunds/provided/card/p2pe/encryptionState'
Added the new 'MERCHANT_TERMINAL_OFF_PREMISES' enum value to the request property ' Authorize /posTerminal/location'
Added the new 'MERCHANT_TERMINAL_OFF_PREMISES' enum value to the request property ' Capture /posTerminal/location'
Added the new 'MERCHANT_TERMINAL_OFF_PREMISES' enum value to the request property ' Pay /posTerminal/location'
Added the new 'MERCHANT_TERMINAL_OFF_PREMISES' enum value to the request property ' Refund /posTerminal/location'
Added the new 'MERCHANT_TERMINAL_OFF_PREMISES' enum value to the request property ' Verify /posTerminal/location'
Added the new 'MERCHANT_TERMINAL_ON_PREMISES' enum value to the request property ' Authorize /posTerminal/location'
Added the new 'MERCHANT_TERMINAL_ON_PREMISES' enum value to the request property ' Capture /posTerminal/location'
Added the new 'MERCHANT_TERMINAL_ON_PREMISES' enum value to the request property ' Pay /posTerminal/location'
Added the new 'MERCHANT_TERMINAL_ON_PREMISES' enum value to the request property ' Refund /posTerminal/location'
Added the new 'MERCHANT_TERMINAL_ON_PREMISES' enum value to the request property ' Verify /posTerminal/location'
Added the new 'NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE' enum value to the request property ' Authorize /posTerminal/location'
Added the new 'NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE' enum value to the request property ' Capture /posTerminal/location'
Added the new 'NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE' enum value to the request property ' Pay /posTerminal/location'
Added the new 'NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE' enum value to the request property ' Refund /posTerminal/location'
Added the new 'NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE' enum value to the request property ' Verify /posTerminal/location'
Added the new 'PAYER_TERMINAL_OFF_PREMISES' enum value to the request property ' Authorize /posTerminal/location'
Added the new 'PAYER_TERMINAL_OFF_PREMISES' enum value to the request property ' Capture /posTerminal/location'
Added the new 'PAYER_TERMINAL_OFF_PREMISES' enum value to the request property ' Pay /posTerminal/location'
Added the new 'PAYER_TERMINAL_OFF_PREMISES' enum value to the request property ' Refund /posTerminal/location'
Added the new 'PAYER_TERMINAL_OFF_PREMISES' enum value to the request property ' Verify /posTerminal/location'
Added the new 'PAYER_TERMINAL_ON_PREMISES' enum value to the request property ' Authorize /posTerminal/location'
Added the new 'PAYER_TERMINAL_ON_PREMISES' enum value to the request property ' Capture /posTerminal/location'
Added the new 'PAYER_TERMINAL_ON_PREMISES' enum value to the request property ' Pay /posTerminal/location'
Added the new 'PAYER_TERMINAL_ON_PREMISES' enum value to the request property ' Refund /posTerminal/location'
Added the new 'PAYER_TERMINAL_ON_PREMISES' enum value to the request property ' Verify /posTerminal/location'
Added the new 'VALID' enum value to the request property ' Capture /sourceOfFunds/provided/card/p2pe/encryptionState'
Added the new 'VALID' enum value to the request property ' Refund /sourceOfFunds/provided/card/p2pe/encryptionState'
Added the new 'VALID' enum value to the request property ' Verify /sourceOfFunds/provided/card/p2pe/encryptionState'
The ' Capture /sourceOfFunds/provided/card/p2pe/encryptionState' request property's minLength was decreased from '1' to '0'
The ' Refund /sourceOfFunds/provided/card/p2pe/encryptionState' request property's minLength was decreased from '1' to '0'
The ' Verify /sourceOfFunds/provided/card/p2pe/encryptionState' request property's minLength was decreased from '1' to '0'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property ' Capture /sourceOfFunds/provided/card/p2pe/encryptionState'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property ' Refund /sourceOfFunds/provided/card/p2pe/encryptionState'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property ' Verify /sourceOfFunds/provided/card/p2pe/encryptionState'
Added the optional property 'lineOfBusiness' to the response
Added the optional property 'order/cashbackAmount' to the response
Added the optional property 'order/gratuityAmount' to the response
Added the optional property 'posTerminal/panEntryMode' to the response
Added the optional property 'posTerminal/pinEntryCapability' to the response
Added the optional property 'sourceOfFunds/provided/card/emvRequest' to the response
Added the optional property 'sourceOfFunds/provided/card/emvResponse' to the response
Added the optional property 'transaction/acquirer/settlementDate' to the response
Added the optional property 'transaction/acquirer/timeZone' to the response
Removed the 'OFF_CARD_ACCEPTOR_PREMISES' enum value from the 'posTerminal/location' response property
Removed the 'ON_CARD_ACCEPTOR_PREMISES' enum value from the 'posTerminal/location' response property

Operations

Payment Options Inquiry

Breaking changes

Added the new required 'query' request parameter 'sourceOfFunds.provided.card.p2pe.payload'
The 'query' request parameter 'sourceOfFunds.provided.card.p2pe.encryptionState' was restricted to a list of enum values
The 'query' request parameter 'sourceOfFunds.provided.card.p2pe.keySerialNumber' became required
Deleted the 'query' request parameter 'posTerminal.eposId'
Deleted the 'query' request parameter 'sourceOfFunds.provided.card'
Deleted the 'query' request parameter 'sourceOfFunds.provided.card.payload'

Non-Breaking changes

Added the new optional 'query' request parameter 'lineOfBusiness'
Added the new optional 'query' request parameter 'sourceOfFunds.provided.card.p2pe'
Added the new enum value 'INVALID' to the 'query' request parameter 'sourceOfFunds.provided.card.p2pe.encryptionState'
Added the new enum value 'VALID' to the 'query' request parameter 'sourceOfFunds.provided.card.p2pe.encryptionState'
For the 'query' request parameter 'sourceOfFunds.provided.card.p2pe.encryptionState', the minLength was decreased from '1' to '0'
Removed the pattern '^[0-9a-zA-Z]*$' from the 'query' request parameter 'sourceOfFunds.provided.card.p2pe.encryptionState'

Operations

Create Checkout Session , Create Session

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /device/mobilePhoneModel'
Added the new optional request property ' Create Checkout Session /lineOfBusiness'
Added the new optional request property ' Create Checkout Session /sourceOfFunds/provided/card/mobileWallet'
Added the new optional request property ' Create Checkout Session /sourceOfFunds/provided/card/p2pe'
Added the new optional request property ' Create Checkout Session /transaction/transit'
Added the new optional request property ' Create Session /lineOfBusiness'
Added the optional property ' Create Checkout Session /lineOfBusiness' to the response
Added the optional property ' Create Session /lineOfBusiness' to the response

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session , Update Session With Payer Data

Breaking changes

The 'sourceOfFunds/provided/card/p2pe/encryptionState' response property's maxLength was unset from '5'
The 'sourceOfFunds/provided/card/p2pe/encryptionState' response property's minLength was decreased from '1' to '0'
The 'sourceOfFunds/provided/card/p2pe/encryptionState' response property's maxLength was unset from '5'
The 'sourceOfFunds/provided/card/p2pe/encryptionState' response property's minLength was decreased from '1' to '0'
Request property ' Update Session /sourceOfFunds/provided/card/p2pe/encryptionState' was restricted to a list of enum values
Removed the enum value 'OFF_CARD_ACCEPTOR_PREMISES' of the request property ' Update Session /posTerminal/location'
Removed the enum value 'ON_CARD_ACCEPTOR_PREMISES' of the request property ' Update Session /posTerminal/location'
The ' Retrieve Session /sourceOfFunds/provided/card/p2pe/encryptionState' response property's maxLength was unset from '5'
The ' Retrieve Session /sourceOfFunds/provided/card/p2pe/encryptionState' response property's minLength was decreased from '1' to '0'
Removed the optional property 'posTerminal/entryMode' from the response
Removed the optional property 'posTerminal/eposId' from the response
Removed the optional property 'sourceOfFunds/provided/card/payload' from the response
Added the new 'AUTOMATED_DISPENSING_MACHINE_WITH_PIN' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'INVALID' enum value to the 'sourceOfFunds/provided/card/p2pe/encryptionState' response property
Added the new 'MERCHANT_TERMINAL_OFF_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'MERCHANT_TERMINAL_ON_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE' enum value to the 'posTerminal/location' response property
Added the new 'PAYER_TERMINAL_OFF_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'PAYER_TERMINAL_ON_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'VALID' enum value to the 'sourceOfFunds/provided/card/p2pe/encryptionState' response property
Removed the optional property 'posTerminal/entryMode' from the response
Removed the optional property 'posTerminal/eposId' from the response
Removed the optional property 'sourceOfFunds/provided/card/payload' from the response
Added the new 'AUTOMATED_DISPENSING_MACHINE_WITH_PIN' enum value to the 'posTerminal/cardholderActivated' response property
Added the new 'INVALID' enum value to the 'sourceOfFunds/provided/card/p2pe/encryptionState' response property
Added the new 'MERCHANT_TERMINAL_OFF_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'MERCHANT_TERMINAL_ON_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE' enum value to the 'posTerminal/location' response property
Added the new 'PAYER_TERMINAL_OFF_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'PAYER_TERMINAL_ON_PREMISES' enum value to the 'posTerminal/location' response property
Added the new 'VALID' enum value to the 'sourceOfFunds/provided/card/p2pe/encryptionState' response property
Removed the request property ' Update Session /posTerminal/entryMode'
Removed the request property ' Update Session /posTerminal/eposId'
Removed the request property ' Update Session /sourceOfFunds/provided/card/payload'
Removed the optional property ' Retrieve Session /posTerminal/entryMode' from the response
Removed the optional property ' Retrieve Session /posTerminal/eposId' from the response
Removed the optional property ' Retrieve Session /sourceOfFunds/provided/card/payload' from the response
Added the new 'AUTOMATED_DISPENSING_MACHINE_WITH_PIN' enum value to the ' Retrieve Session /posTerminal/cardholderActivated' response property
Added the new 'INVALID' enum value to the ' Retrieve Session /sourceOfFunds/provided/card/p2pe/encryptionState' response property
Added the new 'MERCHANT_TERMINAL_OFF_PREMISES' enum value to the ' Retrieve Session /posTerminal/location' response property
Added the new 'MERCHANT_TERMINAL_ON_PREMISES' enum value to the ' Retrieve Session /posTerminal/location' response property
Added the new 'NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE' enum value to the ' Retrieve Session /posTerminal/location' response property
Added the new 'PAYER_TERMINAL_OFF_PREMISES' enum value to the ' Retrieve Session /posTerminal/location' response property
Added the new 'PAYER_TERMINAL_ON_PREMISES' enum value to the ' Retrieve Session /posTerminal/location' response property
Added the new 'VALID' enum value to the ' Retrieve Session /sourceOfFunds/provided/card/p2pe/encryptionState' response property

Non-Breaking changes

Added the optional property 'lineOfBusiness' to the response
Added the optional property 'posTerminal/panEntryMode' to the response
Added the optional property 'posTerminal/pinEntryCapability' to the response
Added the optional property 'sourceOfFunds/provided/card/p2pe/payload' to the response
Removed the 'OFF_CARD_ACCEPTOR_PREMISES' enum value from the 'posTerminal/location' response property
Removed the 'ON_CARD_ACCEPTOR_PREMISES' enum value from the 'posTerminal/location' response property
The 'sourceOfFunds/provided/card/p2pe/encryptionState' response's property pattern '^[0-9a-zA-Z]*$' was removed
Added the optional property 'lineOfBusiness' to the response
Added the optional property 'posTerminal/panEntryMode' to the response
Added the optional property 'posTerminal/pinEntryCapability' to the response
Added the optional property 'sourceOfFunds/provided/card/p2pe/payload' to the response
Removed the 'OFF_CARD_ACCEPTOR_PREMISES' enum value from the 'posTerminal/location' response property
Removed the 'ON_CARD_ACCEPTOR_PREMISES' enum value from the 'posTerminal/location' response property
The 'sourceOfFunds/provided/card/p2pe/encryptionState' response's property pattern '^[0-9a-zA-Z]*$' was removed
Added the new optional request property ' Update Session /lineOfBusiness'
Added the new optional request property ' Update Session /posTerminal/panEntryMode'
Added the new optional request property ' Update Session /posTerminal/pinEntryCapability'
Added the new optional request property ' Update Session /sourceOfFunds/provided/card/p2pe/payload'
Added the new 'AUTOMATED_DISPENSING_MACHINE_WITH_PIN' enum value to the request property ' Update Session /posTerminal/cardholderActivated'
Added the new 'INVALID' enum value to the request property ' Update Session /sourceOfFunds/provided/card/p2pe/encryptionState'
Added the new 'MERCHANT_TERMINAL_OFF_PREMISES' enum value to the request property ' Update Session /posTerminal/location'
Added the new 'MERCHANT_TERMINAL_ON_PREMISES' enum value to the request property ' Update Session /posTerminal/location'
Added the new 'NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE' enum value to the request property ' Update Session /posTerminal/location'
Added the new 'PAYER_TERMINAL_OFF_PREMISES' enum value to the request property ' Update Session /posTerminal/location'
Added the new 'PAYER_TERMINAL_ON_PREMISES' enum value to the request property ' Update Session /posTerminal/location'
Added the new 'VALID' enum value to the request property ' Update Session /sourceOfFunds/provided/card/p2pe/encryptionState'
The ' Update Session /sourceOfFunds/provided/card/p2pe/encryptionState' request property's minLength was decreased from '1' to '0'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property ' Update Session /sourceOfFunds/provided/card/p2pe/encryptionState'
Added the optional property ' Retrieve Session /lineOfBusiness' to the response
Added the optional property ' Retrieve Session /posTerminal/panEntryMode' to the response
Added the optional property ' Retrieve Session /posTerminal/pinEntryCapability' to the response
Added the optional property ' Retrieve Session /sourceOfFunds/provided/card/p2pe/payload' to the response
Removed the 'OFF_CARD_ACCEPTOR_PREMISES' enum value from the ' Retrieve Session /posTerminal/location' response property
Removed the 'ON_CARD_ACCEPTOR_PREMISES' enum value from the ' Retrieve Session /posTerminal/location' response property
The ' Retrieve Session /sourceOfFunds/provided/card/p2pe/encryptionState' response's property pattern '^[0-9a-zA-Z]*$' was removed

Operations

Create or Update Token (with system-generated token)

Breaking changes

Added the new required request property 'sourceOfFunds/provided/card/p2pe/payload'
Request property 'sourceOfFunds/provided/card/p2pe/encryptionState' was restricted to a list of enum values
The request property 'sourceOfFunds/provided/card/p2pe/keySerialNumber' became required
Removed the request property 'posTerminal/eposId'
Removed the request property 'sourceOfFunds/provided/card/payload'

Non-Breaking changes

Added the new 'INVALID' enum value to the request property 'sourceOfFunds/provided/card/p2pe/encryptionState'
Added the new 'VALID' enum value to the request property 'sourceOfFunds/provided/card/p2pe/encryptionState'
The 'sourceOfFunds/provided/card/p2pe/encryptionState' request property's minLength was decreased from '1' to '0'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property 'sourceOfFunds/provided/card/p2pe/encryptionState'

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

Added the new required request property 'sourceOfFunds/provided/card/p2pe/payload'
Request property 'sourceOfFunds/provided/card/p2pe/encryptionState' was restricted to a list of enum values
The request property 'sourceOfFunds/provided/card/p2pe/keySerialNumber' became required
Removed the request property 'posTerminal/eposId'
Removed the request property 'sourceOfFunds/provided/card/payload'

Non-Breaking changes

Added the new 'INVALID' enum value to the request property 'sourceOfFunds/provided/card/p2pe/encryptionState'
Added the new 'VALID' enum value to the request property 'sourceOfFunds/provided/card/p2pe/encryptionState'
The 'sourceOfFunds/provided/card/p2pe/encryptionState' request property's minLength was decreased from '1' to '0'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property 'sourceOfFunds/provided/card/p2pe/encryptionState'

July 2016

Version 39

Operations

Retrieve Order

Breaking changes

Added the new 'ANDROID_PAY' enum value to the 'transaction/items/order/walletProvider' response property
Added the new 'ANDROID_PAY' enum value to the 'walletProvider' response property
Added the new 'APPLE_PAY' enum value to the 'transaction/items/order/walletProvider' response property
Added the new 'APPLE_PAY' enum value to the 'walletProvider' response property

Non-Breaking changes

Added the optional property 'device/mobilePhoneModel' to the response
Added the optional property 'item/items/industryCategory' to the response
Added the optional property 'sourceOfFunds/provided/card/mobileWallet' to the response
Added the optional property 'transaction/items/device/mobilePhoneModel' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/mobileWallet' to the response
Added the optional property 'transaction/items/transaction/item/items/industryCategory' to the response
Added the optional property 'transaction/items/transaction/transit' to the response
Added the required property 'sourceOfFunds/provided/card/deviceSpecificNumber' to the response
Added the required property 'transaction/items/sourceOfFunds/provided/card/deviceSpecificNumber' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Request property ' Authorize /sourceOfFunds/provided/card/p2pe/encryptionState' was restricted to a list of enum values
Request property ' Pay /sourceOfFunds/provided/card/p2pe/encryptionState' was restricted to a list of enum values
Added the new 'ANDROID_PAY' enum value to the 'order/walletProvider' response property
Added the new 'APPLE_PAY' enum value to the 'order/walletProvider' response property
Added the new 'ANDROID_PAY' enum value to the 'order/walletProvider' response property
Added the new 'APPLE_PAY' enum value to the 'order/walletProvider' response property

Non-Breaking changes

Added the optional property 'device/mobilePhoneModel' to the response
Added the optional property 'sourceOfFunds/provided/card/mobileWallet' to the response
Added the optional property 'transaction/item/items/industryCategory' to the response
Added the optional property 'transaction/transit' to the response
Added the required property 'sourceOfFunds/provided/card/deviceSpecificNumber' to the response
Added the new optional request property ' Authorize /device/mobilePhoneModel'
Added the new optional request property ' Authorize /order/cashbackAmount'
Added the new optional request property ' Authorize /order/gratuityAmount'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/emvRequest'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/mobileWallet'
Added the new optional request property ' Authorize /transaction/transit'
Added the new optional request property ' Pay /device/mobilePhoneModel'
Added the new optional request property ' Pay /order/cashbackAmount'
Added the new optional request property ' Pay /order/gratuityAmount'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/emvRequest'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/mobileWallet'
Added the new 'ANDROID_PAY' enum value to the request property ' Authorize /order/walletProvider'
Added the new 'ANDROID_PAY' enum value to the request property ' Pay /order/walletProvider'
Added the new 'APPLE_PAY' enum value to the request property ' Authorize /order/walletProvider'
Added the new 'APPLE_PAY' enum value to the request property ' Pay /order/walletProvider'
Added the new 'INVALID' enum value to the request property ' Authorize /sourceOfFunds/provided/card/p2pe/encryptionState'
Added the new 'INVALID' enum value to the request property ' Pay /sourceOfFunds/provided/card/p2pe/encryptionState'
Added the new 'VALID' enum value to the request property ' Authorize /sourceOfFunds/provided/card/p2pe/encryptionState'
Added the new 'VALID' enum value to the request property ' Pay /sourceOfFunds/provided/card/p2pe/encryptionState'
The ' Authorize /sourceOfFunds/provided/card/p2pe/encryptionState' request property's minLength was decreased from '1' to '0'
The ' Pay /sourceOfFunds/provided/card/p2pe/encryptionState' request property's minLength was decreased from '1' to '0'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property ' Authorize /sourceOfFunds/provided/card/p2pe/encryptionState'
Removed the pattern '^[0-9a-zA-Z]*$' from the request property ' Pay /sourceOfFunds/provided/card/p2pe/encryptionState'
Added the optional property 'device/mobilePhoneModel' to the response
Added the optional property 'sourceOfFunds/provided/card/mobileWallet' to the response
Added the optional property 'transaction/item/items/industryCategory' to the response
Added the optional property 'transaction/transit' to the response
Added the required property 'sourceOfFunds/provided/card/deviceSpecificNumber' to the response

Operations

Open Wallet , Update Session From Wallet , Retrieve Session , Update Session , Update Session With Payer Data

Breaking changes

Added '#/components/schemas/retrieve_session_response, update_session_with_payer_data_response' to the response body 'oneOf' list
Removed the required property 'merchant' from the response
Removed the required property 'session' from the response
Added the new 'ANDROID_PAY' enum value to the 'order/walletProvider' response property
Added the new 'APPLE_PAY' enum value to the 'order/walletProvider' response property
Added the new 'ANDROID_PAY' enum value to the 'order/walletProvider' response property
Added the new 'APPLE_PAY' enum value to the 'order/walletProvider' response property
Removed the request property '3DSecure'
Removed the request property '3DSecureId'
Removed the request property 'action'
Removed the request property 'airline'
Removed the request property 'authorizationResponse'
Removed the request property 'billing'
Removed the request property 'constraints'
Removed the request property 'correlationId'
Removed the request property 'currencyConversion'
Removed the request property 'customer'
Removed the request property 'device'
Removed the request property 'externalTokenProvider'
Removed the request property 'locale'
Removed the request property 'merchant'
Removed the request property 'order'
Removed the request property 'partnerSolutionId'
Removed the request property 'paymentPlan'
Removed the request property 'paymentType'
Removed the request property 'posTerminal'
Removed the request property 'responseControls'
Removed the request property 'risk'
Removed the request property 'session'
Removed the request property 'shipping'
Removed the request property 'sourceOfFunds'
Removed the request property 'token'
Removed the request property 'transaction'
Removed the request property 'transactionSource'
Removed the request property 'userId'
Removed the request property 'verificationStrategy'
Removed the request property 'wallet'
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 'airline' from the response
Removed the optional property 'authorizationResponse' from the response
Removed the optional property 'billing' from the response
Removed the optional property 'constraints' from the response
Removed the optional property 'correlationId' from the response
Removed the optional property 'currencyConversion' from the response
Removed the optional property 'customer' from the response
Removed the optional property 'device' from the response
Removed the optional property 'externalTokenProvider' 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 '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

Non-Breaking changes

Added the optional property 'device/mobilePhoneModel' to the response
Added the optional property 'order/cashbackAmount' to the response
Added the optional property 'order/gratuityAmount' to the response
Added the optional property 'sourceOfFunds/provided/card/emvRequest' to the response
Added the optional property 'sourceOfFunds/provided/card/mobileWallet' to the response
Added the optional property 'transaction/transit' to the response
Added the optional property 'device/mobilePhoneModel' to the response
Added the optional property 'order/cashbackAmount' to the response
Added the optional property 'order/gratuityAmount' to the response
Added the optional property 'sourceOfFunds/provided/card/emvRequest' to the response
Added the optional property 'sourceOfFunds/provided/card/mobileWallet' to the response
Added the optional property 'transaction/transit' to the response
Api operation id 'Session: Update Session' removed and replaced with 'Session: Update Session OR Session: Update Session With Payer Data'
Added ' update_session_request, update_session_with_payer_data_request' to the request body 'oneOf' list

May 2016

Version 38

Operations

Retrieve Order

Breaking changes

Removed the required property 'transaction/items/posTerminal/name' from the response

Non-Breaking changes

Added the optional property 'certainty' to the response
Added the optional property 'transaction/items/order/certainty' to the response
Added the optional property 'transaction/items/order/owningEntity' to the response
Added the required property 'transaction/items/posTerminal/lane' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Removed the required property 'posTerminal/name' from the response
Added the new required request property ' Authorize /posTerminal/lane'
Added the new required request property ' Capture /posTerminal/lane'
Added the new required request property ' Pay /posTerminal/lane'
Added the new required request property ' Refund /posTerminal/lane'
Added the new required request property ' Verify /posTerminal/lane'
Removed the required property 'posTerminal/name' from the response
Removed the request property ' Authorize /posTerminal/name'
Removed the request property ' Capture /posTerminal/name'
Removed the request property ' Pay /posTerminal/name'
Removed the request property ' Refund /posTerminal/name'
Removed the request property ' Verify /posTerminal/name'

Non-Breaking changes

Added the optional property 'order/certainty' to the response
Added the optional property 'order/owningEntity' to the response
Added the required property 'posTerminal/lane' to the response
Added the new optional request property ' Initiate /order/owningEntity'
Added the new optional request property ' Authorize /order/certainty'
Added the new optional request property ' Authorize /order/owningEntity'
Added the new optional request property ' Capture /order/owningEntity'
Added the new optional request property ' Pay /order/owningEntity'
Added the new optional request property ' Refund /order/owningEntity'
Added the new optional request property ' Verify /order/owningEntity'
Added the optional property 'order/certainty' to the response
Added the optional property 'order/owningEntity' to the response
Added the required property 'posTerminal/lane' to the response

Operations

Create Checkout Session

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /order/certainty'
Added the new optional request property ' Create Checkout Session /order/owningEntity'
Added the new optional request property ' Create Checkout Session /transaction/acquirer/transactionId'

Operations

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

Breaking changes

Removed the optional property 'posTerminal/name' from the response
Removed the optional property 'posTerminal/name' from the response
Removed the request property 'posTerminal/name'
Removed the optional property 'posTerminal/name' from the response

Non-Breaking changes

Added the optional property 'order/certainty' to the response
Added the optional property 'order/owningEntity' to the response
Added the optional property 'posTerminal/lane' to the response
Added the optional property 'order/certainty' to the response
Added the optional property 'order/owningEntity' to the response
Added the optional property 'posTerminal/lane' to the response
Added the new optional request property 'order/certainty'
Added the new optional request property 'order/owningEntity'
Added the new optional request property 'posTerminal/lane'
Added the optional property 'order/certainty' to the response
Added the optional property 'order/owningEntity' to the response
Added the optional property 'posTerminal/lane' to the response

May 2016

Version 37

Operations

Close Batch

Non-Breaking changes

Added the new optional request property 'acquirer/customData'

Operations

Authorize , Capture , Pay , Refund

Non-Breaking changes

Added the new optional request property ' Authorize /transaction/acquirer/transactionId'
Added the new optional request property ' Capture /transaction/acquirer/transactionId'
Added the new optional request property ' Capture /transaction/item/items/industryCategory'
Added the new optional request property ' Pay /transaction/acquirer/transactionId'
Added the new optional request property ' Refund /transaction/acquirer/transactionId'
Added the new optional request property ' Refund /transaction/item/items/industryCategory'

Operations

Payment Options Inquiry

Non-Breaking changes

Added the optional property 'paymentTypes/card/issuer' to the response
Added the optional property 'paymentTypes/card/localBrand' to the response
Added the required property 'paymentTypes/card/brand' to the response
Added the required property 'paymentTypes/card/fundingMethod' to the response
Added the required property 'paymentTypes/card/scheme' to the response

Operations

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

Non-Breaking changes

Added the optional property 'transaction/acquirer/transactionId' to the response
Added the optional property 'transaction/item/items/industryCategory' to the response
Added the optional property 'transaction/acquirer/transactionId' to the response
Added the optional property 'transaction/item/items/industryCategory' to the response
Added the new optional request property 'transaction/acquirer/transactionId'
Added the new optional request property 'transaction/item/items/industryCategory'
Added the optional property 'transaction/acquirer/transactionId' to the response
Added the optional property 'transaction/item/items/industryCategory' to the response

March 2016

Version 36

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'transaction/items/order/item/items/industryCategory' to the response
Added the optional property 'transaction/items/order/statementDescriptor' to the response
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Non-Breaking changes

Added the optional property 'order/item/items/industryCategory' to the response
Added the optional property 'order/statementDescriptor' to the response
Added the new optional request property ' Authorize /order/item/items/industryCategory'
Added the new optional request property ' Authorize /order/statementDescriptor'
Added the new optional request property ' Capture /order/statementDescriptor'
Added the new optional request property ' Pay /order/item/items/industryCategory'
Added the new optional request property ' Pay /order/statementDescriptor'
Added the new optional request property ' Refund /order/statementDescriptor'
Added the optional property 'order/item/items/industryCategory' to the response
Added the optional property 'order/statementDescriptor' to the response

Operations

Payment Options Inquiry

Non-Breaking changes

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

Operations

Create Checkout Session

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /order/item/items/industryCategory'
Added the new optional request property ' Create Checkout Session /order/statementDescriptor'
Added the new optional request property ' Create Checkout Session /risk/paymentRecipient'

Operations

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

Breaking changes

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

Non-Breaking changes

Added the optional property 'order/item/items/industryCategory' to the response
Added the optional property 'order/statementDescriptor' to the response
Added the optional property 'order/item/items/industryCategory' to the response
Added the optional property 'order/statementDescriptor' to the response
Added the new optional request property 'order/item/items/industryCategory'
Added the new optional request property 'order/statementDescriptor'
Added the new 'UNION_PAY' enum value to the request property 'paymentType'
Added the optional property 'order/item/items/industryCategory' to the response
Added the optional property 'order/statementDescriptor' to the response

February 2016

Version 35

Operations

Update Checkout wallet configuration i.e enable or disable the wallet

, Check if the checkout wallet is enabled or disabled

Non-Breaking changes

Endpoint added

Operations

Retrieve Order

Breaking changes

Removed the optional property 'sourceOfFunds/provided/card/securityCodePresence' from the response
Removed the optional property 'transaction/items/sourceOfFunds/provided/card/securityCodePresence' from the response

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/card/tags' to the response
Added the optional property 'transaction/items/authorizationResponse/cardSecurityCodePresenceIndicator' to the response
Added the optional property 'transaction/items/risk/paymentRecipient' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/tags' to the response
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Removed the optional property 'sourceOfFunds/provided/card/securityCodePresence' from the response
Removed the optional property 'sourceOfFunds/provided/card/securityCodePresence' from the response

Non-Breaking changes

Added the optional property 'authorizationResponse/cardSecurityCodePresenceIndicator' to the response
Added the optional property 'risk/paymentRecipient' to the response
Added the optional property 'sourceOfFunds/provided/card/tags' to the response
Added the new optional request property ' Authorize /risk/paymentRecipient'
Added the new optional request property ' Capture /authorizationResponse/cardSecurityCodePresenceIndicator'
Added the new optional request property ' Pay /risk/paymentRecipient'
Added the optional property 'authorizationResponse/cardSecurityCodePresenceIndicator' to the response
Added the optional property 'risk/paymentRecipient' to the response
Added the optional property 'sourceOfFunds/provided/card/tags' to the response

Operations

Payment Options Inquiry

Non-Breaking changes

Added the optional property 'paymentTypes/card/tags' to the response

Operations

Create Checkout Session

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /interaction/displayControl/confirmAchAccountNumber'

Operations

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

Non-Breaking changes

Added the optional property 'authorizationResponse/cardSecurityCodePresenceIndicator' to the response
Added the optional property 'risk/paymentRecipient' to the response
Added the optional property 'authorizationResponse/cardSecurityCodePresenceIndicator' to the response
Added the optional property 'risk/paymentRecipient' to the response
Added the new optional request property 'authorizationResponse/cardSecurityCodePresenceIndicator'
Added the new optional request property 'risk/paymentRecipient'
Added the optional property 'authorizationResponse/cardSecurityCodePresenceIndicator' to the response
Added the optional property 'risk/paymentRecipient' to the response

Operations

Update Wallet Configuration , Retrieve Wallet Configuration

Non-Breaking changes

Endpoint added

December 2015

Version 34

Operations

Retrieve Order

Breaking changes

Removed the optional property 'transaction/items/browserPayment/paypal/operation' from the response
Added the new 'UNION_PAY' enum value to the 'sourceOfFunds/type' response property
Added the new 'UNION_PAY' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'transaction/items/browserPayment/operation' to the response
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Added the new required request property ' Initiate /browserPayment/operation'
Removed the optional property 'browserPayment/paypal/operation' from the response
Added the new 'UNION_PAY' enum value to the 'sourceOfFunds/type' response property
Removed the request property ' Initiate /browserPayment/paypal/operation'
Removed the optional property 'browserPayment/paypal/operation' from the response
Added the new 'UNION_PAY' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'browserPayment/operation' to the response
Added the new 'UNION_PAY' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the optional property 'browserPayment/operation' to the response

October 2015

Version 33

Operations

Update Amex Express Checkout Configuration , Retrieve Amex Express Checkout Configuration

Non-Breaking changes

Endpoint added

Operations

Delete Amex Express Checkout Configuration

Non-Breaking changes

Endpoint added

Operations

Update AMEX Express Checkout wallet configuration i.e enable or disable the wallet

, Check if the Amex express checkout wallet is enabled or disabled

Non-Breaking changes

Endpoint added

Operations

Retrieve Order

Breaking changes

Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the 'transaction/items/order/walletProvider' response property
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the 'walletProvider' response property
Added the new 'CRATE_AND_BARREL' enum value to the 'sourceOfFunds/provided/card/localBrand' response property
Added the new 'CRATE_AND_BARREL' enum value to the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property

Non-Breaking changes

Removed the 'BUSINESS_CARD' enum value from the 'transaction/items/authorizationResponse/commercialCardIndicator' response property
Removed the 'COMMERCIAL_AND_CONSUMER' enum value from the 'transaction/items/authorizationResponse/commercialCardIndicator' response property
Removed the 'COMMERCIAL_CARD' enum value from the 'transaction/items/authorizationResponse/commercialCard' response property
Removed the 'COMMERCIAL_CARD' enum value from the 'transaction/items/authorizationResponse/commercialCardIndicator' response property
Removed the 'CONSUMER_CARD' enum value from the 'transaction/items/authorizationResponse/commercialCardIndicator' response property
Removed the 'CORPORATE_CARD' enum value from the 'transaction/items/authorizationResponse/commercialCardIndicator' response property
Removed the 'DECLINE_OR_NOT_COMMERCIAL_CARD' enum value from the 'transaction/items/authorizationResponse/commercialCardIndicator' response property
Removed the 'NOT_A_COMMERCIAL_CARD' enum value from the 'transaction/items/authorizationResponse/commercialCard' response property
Removed the 'OTHER' enum value from the 'transaction/items/authorizationResponse/commercialCardIndicator' response property
Removed the 'PURCHASING_CARD' enum value from the 'transaction/items/authorizationResponse/commercialCardIndicator' response property
Removed the 'UNDETERMINED' enum value from the 'transaction/items/authorizationResponse/commercialCard' response property

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Removed the enum value 'BUSINESS_CARD' of the request property ' Capture /authorizationResponse/commercialCardIndicator'
Removed the enum value 'COMMERCIAL_AND_CONSUMER' of the request property ' Capture /authorizationResponse/commercialCardIndicator'
Removed the enum value 'COMMERCIAL_CARD' of the request property ' Capture /authorizationResponse/commercialCard'
Removed the enum value 'COMMERCIAL_CARD' of the request property ' Capture /authorizationResponse/commercialCardIndicator'
Removed the enum value 'CONSUMER_CARD' of the request property ' Capture /authorizationResponse/commercialCardIndicator'
Removed the enum value 'CORPORATE_CARD' of the request property ' Capture /authorizationResponse/commercialCardIndicator'
Removed the enum value 'DECLINE_OR_NOT_COMMERCIAL_CARD' of the request property ' Capture /authorizationResponse/commercialCardIndicator'
Removed the enum value 'NOT_A_COMMERCIAL_CARD' of the request property ' Capture /authorizationResponse/commercialCard'
Removed the enum value 'OTHER' of the request property ' Capture /authorizationResponse/commercialCardIndicator'
Removed the enum value 'PURCHASING_CARD' of the request property ' Capture /authorizationResponse/commercialCardIndicator'
Removed the enum value 'UNDETERMINED' of the request property ' Capture /authorizationResponse/commercialCard'
The ' Capture /authorizationResponse/commercialCard' request property's minLength was increased from '0' to '1'
The ' Capture /authorizationResponse/commercialCardIndicator' request property's minLength was increased from '0' to '1'
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the 'order/walletProvider' response property
Added the new 'CRATE_AND_BARREL' enum value to the 'sourceOfFunds/provided/card/localBrand' response property
The ' Capture /authorizationResponse/commercialCard' request property's maxLength was set to '3'
The ' Capture /authorizationResponse/commercialCardIndicator' request property's maxLength was set to '1'
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the 'order/walletProvider' response property
Added the new 'CRATE_AND_BARREL' enum value to the 'sourceOfFunds/provided/card/localBrand' response property

Non-Breaking changes

Removed the 'BUSINESS_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'COMMERCIAL_AND_CONSUMER' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCard' response property
Removed the 'COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'CONSUMER_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'CORPORATE_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'DECLINE_OR_NOT_COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'NOT_A_COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCard' response property
Removed the 'OTHER' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'PURCHASING_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'UNDETERMINED' enum value from the 'authorizationResponse/commercialCard' response property
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the request property ' Authorize /order/walletProvider'
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the request property ' Capture /order/walletProvider'
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the request property ' Pay /order/walletProvider'
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the request property ' Refund /order/walletProvider'
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the request property ' Verify /order/walletProvider'
Removed the 'BUSINESS_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'COMMERCIAL_AND_CONSUMER' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCard' response property
Removed the 'COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'CONSUMER_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'CORPORATE_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'DECLINE_OR_NOT_COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'NOT_A_COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCard' response property
Removed the 'OTHER' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'PURCHASING_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'UNDETERMINED' enum value from the 'authorizationResponse/commercialCard' response property

Operations

Payment Options Inquiry

Breaking changes

Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the 'paymentTypes/card/walletProviders/items/walletProvider' response property

Operations

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

Breaking changes

Removed the enum value 'BUSINESS_CARD' of the request property 'authorizationResponse/commercialCardIndicator'
Removed the enum value 'COMMERCIAL_AND_CONSUMER' of the request property 'authorizationResponse/commercialCardIndicator'
Removed the enum value 'COMMERCIAL_CARD' of the request property 'authorizationResponse/commercialCard'
Removed the enum value 'COMMERCIAL_CARD' of the request property 'authorizationResponse/commercialCardIndicator'
Removed the enum value 'CONSUMER_CARD' of the request property 'authorizationResponse/commercialCardIndicator'
Removed the enum value 'CORPORATE_CARD' of the request property 'authorizationResponse/commercialCardIndicator'
Removed the enum value 'DECLINE_OR_NOT_COMMERCIAL_CARD' of the request property 'authorizationResponse/commercialCardIndicator'
Removed the enum value 'NOT_A_COMMERCIAL_CARD' of the request property 'authorizationResponse/commercialCard'
Removed the enum value 'OTHER' of the request property 'authorizationResponse/commercialCardIndicator'
Removed the enum value 'PURCHASING_CARD' of the request property 'authorizationResponse/commercialCardIndicator'
Removed the enum value 'UNDETERMINED' of the request property 'authorizationResponse/commercialCard'
The 'authorizationResponse/commercialCard' request property's minLength was increased from '0' to '1'
The 'authorizationResponse/commercialCardIndicator' request property's minLength was increased from '0' to '1'
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the 'order/walletProvider' response property
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the 'order/walletProvider' response property
The 'authorizationResponse/commercialCard' request property's maxLength was set to '3'
The 'authorizationResponse/commercialCardIndicator' request property's maxLength was set to '1'
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the 'order/walletProvider' response property

Non-Breaking changes

Added the optional property 'wallet/amexExpressCheckout' to the response
Removed the 'BUSINESS_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'COMMERCIAL_AND_CONSUMER' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCard' response property
Removed the 'COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'CONSUMER_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'CORPORATE_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'DECLINE_OR_NOT_COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'NOT_A_COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCard' response property
Removed the 'OTHER' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'PURCHASING_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'UNDETERMINED' enum value from the 'authorizationResponse/commercialCard' response property
Added the new optional request property ' Update Session From Wallet /wallet/amexExpressCheckout'
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the request property ' Open Wallet /order/walletProvider'
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the request property ' Update Session From Wallet /order/walletProvider'
Added the optional property 'wallet/amexExpressCheckout' to the response
Removed the 'BUSINESS_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'COMMERCIAL_AND_CONSUMER' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCard' response property
Removed the 'COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'CONSUMER_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'CORPORATE_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'DECLINE_OR_NOT_COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'NOT_A_COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCard' response property
Removed the 'OTHER' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'PURCHASING_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'UNDETERMINED' enum value from the 'authorizationResponse/commercialCard' response property
Added the new optional request property 'wallet/amexExpressCheckout'
Added the new 'AMEX_EXPRESS_CHECKOUT' enum value to the request property 'order/walletProvider'
Added the optional property 'wallet/amexExpressCheckout' to the response
Removed the 'BUSINESS_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'COMMERCIAL_AND_CONSUMER' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCard' response property
Removed the 'COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'CONSUMER_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'CORPORATE_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'DECLINE_OR_NOT_COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'NOT_A_COMMERCIAL_CARD' enum value from the 'authorizationResponse/commercialCard' response property
Removed the 'OTHER' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'PURCHASING_CARD' enum value from the 'authorizationResponse/commercialCardIndicator' response property
Removed the 'UNDETERMINED' enum value from the 'authorizationResponse/commercialCard' response property

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

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

Operations

Search Tokens

Breaking changes

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

August 2015

Version 32

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'subMerchant' to the response
Added the optional property 'transaction/items/order/subMerchant' to the response
The 'transaction/items/airline/passenger/items/frequentFlyerNumber' response's property pattern '^[0-9]*$' was removed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Non-Breaking changes

Added the optional property 'order/subMerchant' to the response
The 'airline/passenger/items/frequentFlyerNumber' response's property pattern '^[0-9]*$' was removed
Added the new optional request property ' Authorize /order/subMerchant'
Added the new optional request property ' Capture /order/subMerchant'
Added the new optional request property ' Pay /order/subMerchant'
Added the new optional request property ' Refund /order/subMerchant'
Added the new optional request property ' Verify /order/subMerchant'
Removed the pattern '^[0-9]*$' from the request property ' Authorize /airline/passenger/items/frequentFlyerNumber'
Removed the pattern '^[0-9]*$' from the request property ' Capture /airline/passenger/items/frequentFlyerNumber'
Removed the pattern '^[0-9]*$' from the request property ' Pay /airline/passenger/items/frequentFlyerNumber'
Removed the pattern '^[0-9]*$' from the request property ' Refund /airline/passenger/items/frequentFlyerNumber'
Added the optional property 'order/subMerchant' to the response
The 'airline/passenger/items/frequentFlyerNumber' response's property pattern '^[0-9]*$' was removed

Operations

Create Checkout Session

Breaking changes

Removed the request property ' Create Checkout Session /airline/ticket/customerReference'

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /airline/itinerary/leg/items/destinationArrivalDate'
Added the new optional request property ' Create Checkout Session /airline/passenger/items/frequentFlyerNumber'
Added the new optional request property ' Create Checkout Session /order/subMerchant'
Added the new optional request property ' Create Checkout Session /order/tax'
Added the new 'NONE' enum value to the request property ' Create Checkout Session /interaction/operation'

Operations

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

Non-Breaking changes

Added the optional property 'order/subMerchant' to the response
The 'airline/passenger/items/frequentFlyerNumber' response's property pattern '^[0-9]*$' was removed
Added the optional property 'order/subMerchant' to the response
The 'airline/passenger/items/frequentFlyerNumber' response's property pattern '^[0-9]*$' was removed
Added the new optional request property 'order/subMerchant'
Removed the pattern '^[0-9]*$' from the request property 'airline/passenger/items/frequentFlyerNumber'
Added the optional property 'order/subMerchant' to the response
The 'airline/passenger/items/frequentFlyerNumber' response's property pattern '^[0-9]*$' was removed

July 2015

Version 31

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'transaction/items/authorizationResponse/avsCode' to the response
Added the optional property 'transaction/items/authorizationResponse/financialNetworkDate' to the response
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Non-Breaking changes

Added the optional property 'authorizationResponse/avsCode' to the response
Added the optional property 'authorizationResponse/financialNetworkDate' to the response
Added the new optional request property ' Void /sourceOfFunds'
Added the new optional request property ' Capture /authorizationResponse'
Added the optional property 'authorizationResponse/avsCode' to the response
Added the optional property 'authorizationResponse/financialNetworkDate' to the response

Operations

Pair With Wallet , Retrieve Wallet Pairing Result

Non-Breaking changes

Endpoint added

Operations

Payment Options Inquiry

Breaking changes

Removed the enum value 'CREDIT' from the 'query' request parameter 'paymentType'

Non-Breaking changes

Added the new enum value 'CARD' to the 'query' request parameter 'paymentType'

Operations

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

Breaking changes

Removed the enum value 'CREDIT' of the request property 'paymentType'
Removed the optional property 'wallet/cancelURL' from the response
Removed the optional property 'wallet/returnURL' from the response
Added the new 'CARD' enum value to the 'paymentType' response property
Removed the request property 'correlationId'
Removed the request property 'order'
Removed the request property 'session'
Removed the request property 'wallet'
Removed the optional property 'wallet/cancelURL' from the response
Removed the optional property 'wallet/returnURL' from the response
Added the new 'CARD' enum value to the 'paymentType' response property
Removed the request property 'wallet/cancelURL'
Removed the request property 'wallet/returnURL'
Removed the optional property 'wallet/cancelURL' from the response
Removed the optional property 'wallet/returnURL' from the response
Added the new 'CARD' enum value to the 'paymentType' response property

Non-Breaking changes

Added the optional property 'authorizationResponse' to the response
Added the optional property 'wallet/masterpass' to the response
Added the optional property 'wallet/masterpassExpressCheckout' to the response
Removed the 'CREDIT' enum value from the 'paymentType' response property
Api operation id 'Session: Open Wallet' removed and replaced with 'Wallet: Open Wallet OR Wallet: Update Session From Wallet'
Api tag 'Wallet' added
Api tag 'Session' removed
Added ' open_wallet_request, update_session_from_wallet_request' to the request body 'oneOf' list
Added the optional property 'authorizationResponse' to the response
Added the optional property 'wallet/masterpass' to the response
Added the optional property 'wallet/masterpassExpressCheckout' to the response
Removed the 'CREDIT' enum value from the 'paymentType' response property
Added the new optional request property 'authorizationResponse'
Added the new optional request property 'wallet/masterpass'
Added the new optional request property 'wallet/masterpassExpressCheckout'
Added the new 'CARD' enum value to the request property 'paymentType'
Added the optional property 'authorizationResponse' to the response
Added the optional property 'wallet/masterpass' to the response
Added the optional property 'wallet/masterpassExpressCheckout' to the response
Removed the 'CREDIT' enum value from the 'paymentType' response property

Operations

Create or Update Token (with system-generated token)

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/card/issuer' to the response
Removed the 'ACH' enum value from the 'sourceOfFunds/type' response property

Operations

Delete Token , Retrieve Token , Create or Update Token

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/card/issuer' to the response
Removed the 'ACH' enum value from the 'sourceOfFunds/type' response property
Added the optional property 'sourceOfFunds/provided/card/issuer' to the response
Removed the 'ACH' enum value from the 'sourceOfFunds/type' response property

Operations

Search Tokens

Breaking changes

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

Non-Breaking changes

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

Operations

Retrieve Wallet Options

Non-Breaking changes

Endpoint added

June 2015

Version 30

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Non-Breaking changes

Added the optional property 'currencyConversion/exchangeRateTime' to the response
Added the optional property 'currencyConversion/marginPercentage' to the response
Added the optional property 'currencyConversion/payerExchangeRate' to the response
Added the optional property 'currencyConversion/exchangeRateTime' to the response
Added the optional property 'currencyConversion/marginPercentage' to the response
Added the optional property 'currencyConversion/payerExchangeRate' to the response
Added the new optional request property 'currencyConversion/exchangeRateTime'
Added the new optional request property 'currencyConversion/marginPercentage'
Added the new optional request property 'currencyConversion/payerAmount'
Added the new optional request property 'currencyConversion/payerCurrency'
Added the new optional request property 'currencyConversion/payerExchangeRate'
Added the new optional request property 'currencyConversion/provider'
Added the new optional request property 'currencyConversion/providerReceipt'
Added the optional property 'currencyConversion/exchangeRateTime' to the response
Added the optional property 'currencyConversion/marginPercentage' to the response
Added the optional property 'currencyConversion/payerExchangeRate' to the response

Operations

Close Batch

Non-Breaking changes

Added the new 'COSTCO' enum value to the request property 'acquirer/cardType'
Added the new 'COSTCO_CASH_CARD' enum value to the request property 'acquirer/cardType'
Added the new 'VITAMIN_SHOPPE_GIFT_CARD' enum value to the request property 'acquirer/cardType'

Operations

Retrieve Order

Breaking changes

Removed the optional property 'transaction/items/airline/ticket/customerReference' from the response
Added the new 'BED_BATH_AND_BEYOND' enum value to the 'sourceOfFunds/provided/card/localBrand' response property
Added the new 'BED_BATH_AND_BEYOND' enum value to the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property
Added the new 'COSTCO' enum value to the 'sourceOfFunds/provided/card/localBrand' response property
Added the new 'COSTCO' enum value to the 'transaction/items/sourceOfFunds/provided/card/localBrand' response property

Non-Breaking changes

Added the optional property 'currencyConversion/exchangeRateTime' to the response
Added the optional property 'currencyConversion/marginPercentage' to the response
Added the optional property 'currencyConversion/payerExchangeRate' to the response
Added the optional property 'currencyConversion/payerReceiptText' to the response
Added the optional property 'sourceOfFunds/provided/card/issuer' to the response
Added the optional property 'tax' to the response
Added the optional property 'transaction/items/airline/itinerary/leg/items/destinationArrivalDate' to the response
Added the optional property 'transaction/items/airline/passenger/items/frequentFlyerNumber' to the response
Added the optional property 'transaction/items/currencyConversion/exchangeRateTime' to the response
Added the optional property 'transaction/items/currencyConversion/marginPercentage' to the response
Added the optional property 'transaction/items/currencyConversion/payerExchangeRate' to the response
Added the optional property 'transaction/items/currencyConversion/payerReceiptText' to the response
Added the optional property 'transaction/items/order/tax' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/issuer' to the response
Added the optional property 'transaction/items/transaction/tax' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Removed the optional property 'airline/ticket/customerReference' from the response
Added the new 'BED_BATH_AND_BEYOND' enum value to the 'sourceOfFunds/provided/card/localBrand' response property
Added the new 'COSTCO' enum value to the 'sourceOfFunds/provided/card/localBrand' response property
Removed the request property ' Authorize /airline/ticket/customerReference'
Removed the request property ' Capture /airline/ticket/customerReference'
Removed the request property ' Pay /airline/ticket/customerReference'
Removed the request property ' Refund /airline/ticket/customerReference'
Removed the optional property 'airline/ticket/customerReference' from the response
Added the new 'BED_BATH_AND_BEYOND' enum value to the 'sourceOfFunds/provided/card/localBrand' response property
Added the new 'COSTCO' enum value to the 'sourceOfFunds/provided/card/localBrand' response property

Non-Breaking changes

Added the optional property 'airline/itinerary/leg/items/destinationArrivalDate' to the response
Added the optional property 'airline/passenger/items/frequentFlyerNumber' to the response
Added the optional property 'currencyConversion/exchangeRateTime' to the response
Added the optional property 'currencyConversion/marginPercentage' to the response
Added the optional property 'currencyConversion/payerExchangeRate' to the response
Added the optional property 'currencyConversion/payerReceiptText' to the response
Added the optional property 'order/tax' to the response
Added the optional property 'sourceOfFunds/provided/card/issuer' to the response
Added the optional property 'transaction/tax' to the response
Added the new optional request property ' Confirm /order/tax'
Added the new optional request property ' Initiate /order/tax'
Added the new optional request property ' Authorize /airline/itinerary/leg/items/destinationArrivalDate'
Added the new optional request property ' Authorize /airline/passenger/items/frequentFlyerNumber'
Added the new optional request property ' Authorize /currencyConversion/exchangeRateTime'
Added the new optional request property ' Authorize /currencyConversion/marginPercentage'
Added the new optional request property ' Authorize /currencyConversion/payerAmount'
Added the new optional request property ' Authorize /currencyConversion/payerCurrency'
Added the new optional request property ' Authorize /currencyConversion/payerExchangeRate'
Added the new optional request property ' Authorize /currencyConversion/provider'
Added the new optional request property ' Authorize /currencyConversion/providerReceipt'
Added the new optional request property ' Authorize /order/tax'
Added the new optional request property ' Capture /airline/itinerary/leg/items/destinationArrivalDate'
Added the new optional request property ' Capture /airline/passenger/items/frequentFlyerNumber'
Added the new optional request property ' Capture /currencyConversion/exchangeRateTime'
Added the new optional request property ' Capture /currencyConversion/marginPercentage'
Added the new optional request property ' Capture /currencyConversion/payerAmount'
Added the new optional request property ' Capture /currencyConversion/payerCurrency'
Added the new optional request property ' Capture /currencyConversion/payerExchangeRate'
Added the new optional request property ' Capture /currencyConversion/provider'
Added the new optional request property ' Capture /currencyConversion/providerReceipt'
Added the new optional request property ' Capture /transaction/tax'
Added the new optional request property ' Pay /airline/itinerary/leg/items/destinationArrivalDate'
Added the new optional request property ' Pay /airline/passenger/items/frequentFlyerNumber'
Added the new optional request property ' Pay /currencyConversion/exchangeRateTime'
Added the new optional request property ' Pay /currencyConversion/marginPercentage'
Added the new optional request property ' Pay /currencyConversion/payerAmount'
Added the new optional request property ' Pay /currencyConversion/payerCurrency'
Added the new optional request property ' Pay /currencyConversion/payerExchangeRate'
Added the new optional request property ' Pay /currencyConversion/provider'
Added the new optional request property ' Pay /currencyConversion/providerReceipt'
Added the new optional request property ' Pay /order/tax'
Added the new optional request property ' Refund /airline/itinerary/leg/items/destinationArrivalDate'
Added the new optional request property ' Refund /airline/passenger/items/frequentFlyerNumber'
Added the new optional request property ' Refund /currencyConversion/exchangeRateTime'
Added the new optional request property ' Refund /currencyConversion/marginPercentage'
Added the new optional request property ' Refund /currencyConversion/payerAmount'
Added the new optional request property ' Refund /currencyConversion/payerCurrency'
Added the new optional request property ' Refund /currencyConversion/payerExchangeRate'
Added the new optional request property ' Refund /currencyConversion/provider'
Added the new optional request property ' Refund /currencyConversion/providerReceipt'
Added the new optional request property ' Refund /sourceOfFunds/provided/giftCard'
Added the new optional request property ' Refund /transaction/tax'
Added the new optional request property ' Verify /order/tax'
Added the new optional request property ' Verify /sourceOfFunds/provided/ach'
Added the new optional request property ' Verify /sourceOfFunds/provided/giftCard'
Added the new optional request property ' Verify /sourceOfFunds/type'
Added the new 'GIFT_CARD' enum value to the request property ' Refund /sourceOfFunds/type'
Added the optional property 'airline/itinerary/leg/items/destinationArrivalDate' to the response
Added the optional property 'airline/passenger/items/frequentFlyerNumber' to the response
Added the optional property 'currencyConversion/exchangeRateTime' to the response
Added the optional property 'currencyConversion/marginPercentage' to the response
Added the optional property 'currencyConversion/payerExchangeRate' to the response
Added the optional property 'currencyConversion/payerReceiptText' to the response
Added the optional property 'order/tax' to the response
Added the optional property 'sourceOfFunds/provided/card/issuer' to the response
Added the optional property 'transaction/tax' to the response

Operations

Payment Options Inquiry

Breaking changes

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

Non-Breaking changes

Added the new optional 'query' request parameter 'locale'
Added the new enum value 'GIFT_CARD' to the 'query' request parameter 'paymentType'
Added the optional property 'paymentTypes/card/currencyConversion/offerText' to the response
Removed the 'SECURE_C0DE' enum value from the 'paymentTypes/card/3DSecureSchemes/items/3DSecureScheme' response property

Operations

Open Wallet , Retrieve Session , Update Session

Breaking changes

Removed the optional property 'airline/ticket/customerReference' from the response
Removed the optional property 'cardVerificationStrategy' from the response
Added the new 'GIFT_CARD' enum value to the 'paymentType' response property
Added the new 'REFUND' enum value to the 'airline/transactionType' response property
Added the new 'REVERSAL' enum value to the 'airline/transactionType' response property
Removed the optional property 'airline/ticket/customerReference' from the response
Removed the optional property 'cardVerificationStrategy' from the response
Added the new 'GIFT_CARD' enum value to the 'paymentType' response property
Added the new 'REFUND' enum value to the 'airline/transactionType' response property
Added the new 'REVERSAL' enum value to the 'airline/transactionType' response property
Removed the request property 'airline/ticket/customerReference'
Removed the request property 'cardVerificationStrategy'
Removed the optional property 'airline/ticket/customerReference' from the response
Removed the optional property 'cardVerificationStrategy' from the response
Added the new 'GIFT_CARD' enum value to the 'paymentType' response property
Added the new 'REFUND' enum value to the 'airline/transactionType' response property
Added the new 'REVERSAL' enum value to the 'airline/transactionType' response property

Non-Breaking changes

Added the optional property 'airline/itinerary/leg/items/destinationArrivalDate' to the response
Added the optional property 'airline/passenger/items/frequentFlyerNumber' to the response
Added the optional property 'currencyConversion/exchangeRateTime' to the response
Added the optional property 'currencyConversion/marginPercentage' to the response
Added the optional property 'currencyConversion/payerAmount' to the response
Added the optional property 'currencyConversion/payerCurrency' to the response
Added the optional property 'currencyConversion/payerExchangeRate' to the response
Added the optional property 'currencyConversion/provider' to the response
Added the optional property 'currencyConversion/providerReceipt' to the response
Added the optional property 'locale' to the response
Added the optional property 'order/tax' to the response
Added the optional property 'transaction/tax' to the response
Added the optional property 'verificationStrategy' to the response
Added the optional property 'wallet/visaCheckout/cardArts' to the response
Added the optional property 'wallet/visaCheckout/cardBrand' to the response
Added the new optional request property 'order/tax'
Added the optional property 'airline/itinerary/leg/items/destinationArrivalDate' to the response
Added the optional property 'airline/passenger/items/frequentFlyerNumber' to the response
Added the optional property 'currencyConversion/exchangeRateTime' to the response
Added the optional property 'currencyConversion/marginPercentage' to the response
Added the optional property 'currencyConversion/payerAmount' to the response
Added the optional property 'currencyConversion/payerCurrency' to the response
Added the optional property 'currencyConversion/payerExchangeRate' to the response
Added the optional property 'currencyConversion/provider' to the response
Added the optional property 'currencyConversion/providerReceipt' to the response
Added the optional property 'locale' to the response
Added the optional property 'order/tax' to the response
Added the optional property 'transaction/tax' to the response
Added the optional property 'verificationStrategy' to the response
Added the optional property 'wallet/visaCheckout/cardArts' to the response
Added the optional property 'wallet/visaCheckout/cardBrand' to the response
Added the new optional request property 'airline/itinerary/leg/items/destinationArrivalDate'
Added the new optional request property 'airline/passenger/items/frequentFlyerNumber'
Added the new optional request property 'currencyConversion/exchangeRateTime'
Added the new optional request property 'currencyConversion/marginPercentage'
Added the new optional request property 'currencyConversion/payerAmount'
Added the new optional request property 'currencyConversion/payerCurrency'
Added the new optional request property 'currencyConversion/payerExchangeRate'
Added the new optional request property 'currencyConversion/provider'
Added the new optional request property 'currencyConversion/providerReceipt'
Added the new optional request property 'locale'
Added the new optional request property 'order/tax'
Added the new optional request property 'transaction/tax'
Added the new optional request property 'verificationStrategy'
Added the new 'GIFT_CARD' enum value to the request property 'paymentType'
Added the new 'REFUND' enum value to the request property 'airline/transactionType'
Added the new 'REVERSAL' enum value to the request property 'airline/transactionType'
Added the optional property 'airline/itinerary/leg/items/destinationArrivalDate' to the response
Added the optional property 'airline/passenger/items/frequentFlyerNumber' to the response
Added the optional property 'currencyConversion/exchangeRateTime' to the response
Added the optional property 'currencyConversion/marginPercentage' to the response
Added the optional property 'currencyConversion/payerAmount' to the response
Added the optional property 'currencyConversion/payerCurrency' to the response
Added the optional property 'currencyConversion/payerExchangeRate' to the response
Added the optional property 'currencyConversion/provider' to the response
Added the optional property 'currencyConversion/providerReceipt' to the response
Added the optional property 'locale' to the response
Added the optional property 'order/tax' to the response
Added the optional property 'transaction/tax' to the response
Added the optional property 'verificationStrategy' to the response
Added the optional property 'wallet/visaCheckout/cardArts' to the response
Added the optional property 'wallet/visaCheckout/cardBrand' to the response

Operations

Create or Update Token (with system-generated token)

Breaking changes

Removed the required property 'sourceOfFunds/provided/giftCard/fundingMethod' from the response
Removed the request property 'cardVerificationStrategy'
Added the new 'ACH' enum value to the 'sourceOfFunds/type' response property
Added the new 'COSTCO' enum value to the 'sourceOfFunds/provided/card/localBrand' response property

Non-Breaking changes

Api operation id 'Tokenization: Save Card (with system-generated token)' removed and replaced with 'Tokenization: Create or Update Token (with system-generated token)'
Added the new optional request property 'sourceOfFunds/provided/ach'
Added the new optional request property 'verificationStrategy'
Added the new 'ACH' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'sourceOfFunds/provided/ach' to the response

Operations

Delete Token , Retrieve Token , Create or Update Token

Breaking changes

Removed the required property 'sourceOfFunds/provided/giftCard/fundingMethod' from the response
Removed the required property 'sourceOfFunds/provided/giftCard/fundingMethod' from the response
Added the new 'ACH' enum value to the 'sourceOfFunds/type' response property
Added the new 'COSTCO' enum value to the 'sourceOfFunds/provided/card/localBrand' response property
Removed the request property 'cardVerificationStrategy'
Added the new 'ACH' enum value to the 'sourceOfFunds/type' response property
Added the new 'COSTCO' enum value to the 'sourceOfFunds/provided/card/localBrand' response property

Non-Breaking changes

Api operation id 'Tokenization: Retrieve Card' removed and replaced with 'Tokenization: Retrieve Token'
Added the optional property 'sourceOfFunds/provided/ach' to the response
Api operation id 'Tokenization: Save Card' removed and replaced with 'Tokenization: Create or Update Token'
Added the new optional request property 'sourceOfFunds/provided/ach'
Added the new optional request property 'verificationStrategy'
Added the new 'ACH' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'sourceOfFunds/provided/ach' to the response

Operations

Search Tokens

Breaking changes

Removed the optional property 'page/token/items/sourceOfFunds/provided/type' from the response
Added the new 'COSTCO' enum value to the 'page/token/items/sourceOfFunds/provided/card/localBrand' response property
Added the new 'GIFT_CARD' enum value to the 'page/token/items/sourceOfFunds/type' response property

Non-Breaking changes

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

May 2015

Version 29

Operations

Balance Inquiry

Breaking changes

The 'availableBalance' response's property type/format changed from 'number'/'' to 'object'/''

Non-Breaking changes

Added the optional property 'availableBalance/amount' to the response
Added the optional property 'availableBalance/currency' to the response

Operations

Retrieve Order

Breaking changes

The 'transaction/items/giftCard/availableBalance' response's property type/format changed from 'number'/'' to 'object'/''

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/card/accountType' to the response
Added the optional property 'transaction/items/giftCard/availableBalance/amount' to the response
Added the optional property 'transaction/items/giftCard/availableBalance/currency' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/accountType' to the response
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

The 'giftCard/availableBalance' response's property type/format changed from 'number'/'' to 'object'/''
The 'giftCard/availableBalance' response's property type/format changed from 'number'/'' to 'object'/''

Non-Breaking changes

Added the optional property 'giftCard/availableBalance/amount' to the response
Added the optional property 'giftCard/availableBalance/currency' to the response
Added the optional property 'sourceOfFunds/provided/card/accountType' to the response
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/accountType'
Added the new optional request property ' Capture /sourceOfFunds/provided/card/accountType'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/accountType'
Added the new optional request property ' Refund /sourceOfFunds/provided/card/accountType'
The request property ' Authorize /sourceOfFunds/type' became optional
The request property ' Capture /sourceOfFunds/type' became optional
The request property ' Pay /sourceOfFunds/type' became optional
The request property ' Refund /sourceOfFunds/type' became optional
Added the optional property 'giftCard/availableBalance/amount' to the response
Added the optional property 'giftCard/availableBalance/currency' to the response
Added the optional property 'sourceOfFunds/provided/card/accountType' to the response

Operations

Create Checkout Session

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /interaction/operation'
The request property ' Create Checkout Session /order/amount' became optional

Operations

Open Wallet , Retrieve Session , Update Session

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/card/accountType' to the response
Added the optional property 'sourceOfFunds/provided/card/accountType' to the response
Added the new optional request property 'sourceOfFunds/provided/card/accountType'
Added the optional property 'sourceOfFunds/provided/card/accountType' to the response

March 2015

Version 28

Operations

Check Gateway

Non-Breaking changes

Added the required property 'gatewayVersion' to the response

Operations

Balance Inquiry

Breaking changes

The response property 'sourceOfFunds/provided/giftCard' became optional

Non-Breaking changes

Added the new optional request property 'sourceOfFunds/provided/giftCard/expectedLocalBrand'
Removed the 'COSTCO_CASH_CARD' enum value from the 'sourceOfFunds/provided/giftCard/localBrand' response property

Operations

Retrieve Order

Breaking changes

Added the new 'PARTIALLY_APPROVED' enum value to the 'transaction/items/response/gatewayCode' response property
Added the new 'REFUND_REQUEST' enum value to the 'transaction/items/transaction/type' response property
Added the new 'REFUND_REQUESTED' enum value to the 'status' response property
Added the new 'REFUND_REQUESTED' enum value to the 'transaction/items/order/status' response property

Non-Breaking changes

Added the optional property 'acceptPartialAmount' to the response
Added the optional property 'transaction/items/order/acceptPartialAmount' to the response
Added the optional property 'transaction/items/response/recurringPaymentAdvice' to the response
Added the optional property 'transaction/items/transaction/requestedAmount' to the response
Removed the 'COSTCO_CASH_CARD' enum value from the 'sourceOfFunds/provided/giftCard/localBrand' response property
Removed the 'COSTCO_CASH_CARD' enum value from the 'transaction/items/sourceOfFunds/provided/giftCard/localBrand' response property

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Added the new 'PARTIALLY_APPROVED' enum value to the 'response/gatewayCode' response property
Added the new 'REFUND_REQUEST' enum value to the 'transaction/type' response property
Added the new 'REFUND_REQUESTED' enum value to the 'order/status' response property
Added the new 'PARTIALLY_APPROVED' enum value to the 'response/gatewayCode' response property
Added the new 'REFUND_REQUEST' enum value to the 'transaction/type' response property
Added the new 'REFUND_REQUESTED' enum value to the 'order/status' response property

Non-Breaking changes

Added the optional property 'order/acceptPartialAmount' to the response
Added the optional property 'response/recurringPaymentAdvice' to the response
Added the optional property 'transaction/requestedAmount' to the response
Removed the 'COSTCO_CASH_CARD' enum value from the 'sourceOfFunds/provided/giftCard/localBrand' response property
Added the new optional request property ' Authorize /order/acceptPartialAmount'
Added the new optional request property ' Authorize /sourceOfFunds/provided/giftCard'
Added the new optional request property ' Capture /order/acceptPartialAmount'
Added the new optional request property ' Capture /sourceOfFunds/provided/giftCard/expectedLocalBrand'
Added the new optional request property ' Pay /order/acceptPartialAmount'
Added the new optional request property ' Pay /sourceOfFunds/provided/giftCard/expectedLocalBrand'
Added the new optional request property ' Refund /order/acceptPartialAmount'
Added the new optional request property ' Refund /transaction/priorApproval'
Added the new 'GIFT_CARD' enum value to the request property ' Authorize /sourceOfFunds/type'
Added the optional property 'order/acceptPartialAmount' to the response
Added the optional property 'response/recurringPaymentAdvice' to the response
Added the optional property 'transaction/requestedAmount' to the response
Removed the 'COSTCO_CASH_CARD' enum value from the 'sourceOfFunds/provided/giftCard/localBrand' response property

Operations

Payment Options Inquiry

Breaking changes

The 'paymentTypes' response's property type/format changed from 'array'/'' to 'object'/''
Removed the required property 'addressVerificationService' from the response
Removed the required property 'cardSecurityCode' from the response
Removed the required property 'noCardSecurityCodePrintedOnCard' from the response
Removed the optional property '3DSecureSchemes' from the response
Removed the optional property 'cardTypes' from the response
Removed the optional property 'currencies' from the response
Removed the optional property 'currencyConversion' from the response
Removed the optional property 'enforceCardSecurityCodeEntry' from the response
Removed the optional property 'paymentPlans' from the response
Removed the optional property 'transactionSources' from the response
Removed the optional property 'walletProviders' from the response

Non-Breaking changes

Added the optional property 'paymentTypes/ach' to the response
Added the optional property 'paymentTypes/bancanet' to the response
Added the optional property 'paymentTypes/card' to the response
Added the optional property 'paymentTypes/giftCard' to the response
Added the optional property 'paymentTypes/giropay' to the response
Added the optional property 'paymentTypes/paypal' to the response
Added the optional property 'paymentTypes/sofort' to the response

Operations

Create Checkout Session

Non-Breaking changes

Added the new optional request property ' Create Checkout Session /interaction/displayControl/shipping'
Added the new optional request property ' Create Checkout Session /order/acceptPartialAmount'

Operations

Open Wallet , Retrieve Session , Update Session

Non-Breaking changes

Added the optional property 'order/acceptPartialAmount' to the response
Added the optional property 'sourceOfFunds/provided/giftCard/expectedLocalBrand' to the response
Added the optional property 'transaction/priorApproval' to the response
Added the optional property 'order/acceptPartialAmount' to the response
Added the optional property 'sourceOfFunds/provided/giftCard/expectedLocalBrand' to the response
Added the optional property 'transaction/priorApproval' to the response
Added the new optional request property 'order/acceptPartialAmount'
Added the new optional request property 'sourceOfFunds/provided/giftCard/expectedLocalBrand'
Added the new optional request property 'transaction/priorApproval'
Added the optional property 'order/acceptPartialAmount' to the response
Added the optional property 'sourceOfFunds/provided/giftCard/expectedLocalBrand' to the response
Added the optional property 'transaction/priorApproval' to the response

Operations

Save Card (with system-generated token)

Breaking changes

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

Non-Breaking changes

Added the new optional request property 'action'
Added the new optional request property 'posTerminal'
Added the new optional request property 'sourceOfFunds/provided/card/p2pe'
Added the new optional request property 'sourceOfFunds/provided/card/payload'
Added the new optional request property 'sourceOfFunds/provided/giftCard'
Added the new 'GIFT_CARD' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'sourceOfFunds/provided/giftCard' to the response

Operations

Delete Token , Retrieve Card , Save Card

Breaking changes

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

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/giftCard' to the response
Added the new optional request property 'action'
Added the new optional request property 'posTerminal'
Added the new optional request property 'sourceOfFunds/provided/card/p2pe'
Added the new optional request property 'sourceOfFunds/provided/card/payload'
Added the new optional request property 'sourceOfFunds/provided/giftCard'
Added the new 'GIFT_CARD' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'sourceOfFunds/provided/giftCard' to the response

January 2015

Version 27

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Breaking changes

Removed the required property 'currencyConversion/payerAcceptance' from the response
Removed the required property 'currencyConversion/payerAcceptance' from the response
Removed the required property 'currencyConversion/payerAcceptance' from the response
Removed the request property 'currencyConversion/payerAcceptance'
Removed the request property 'currencyConversion/payerAmount'
Removed the request property 'currencyConversion/payerCurrency'

Non-Breaking changes

Added the optional property 'currencyConversion/provider' to the response
Added the optional property 'currencyConversion/providerReceipt' to the response
Added the required property 'currencyConversion/uptake' to the response
Added the optional property 'currencyConversion/provider' to the response
Added the optional property 'currencyConversion/providerReceipt' to the response
Added the required property 'currencyConversion/uptake' to the response
Added the new optional request property 'currencyConversion/requestId'
Added the new optional request property 'currencyConversion/uptake'
Added the optional property 'currencyConversion/provider' to the response
Added the optional property 'currencyConversion/providerReceipt' to the response
Added the required property 'currencyConversion/uptake' to the response

Operations

Balance Inquiry

Non-Breaking changes

Endpoint added

Operations

Retrieve Order

Breaking changes

Removed the required property 'currencyConversion/payerAcceptance' from the response
Removed the required property 'transaction/items/currencyConversion/payerAcceptance' from the response
Added the new 'CHECKOUT' enum value to the 'transaction/items/gatewayEntryPoint' response property
Added the new 'GIFT_CARD' enum value to the 'sourceOfFunds/type' response property
Added the new 'GIFT_CARD' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'currencyConversion/provider' to the response
Added the optional property 'currencyConversion/providerReceipt' to the response
Added the optional property 'sourceOfFunds/provided/giftCard' to the response
Added the optional property 'transaction/items/currencyConversion/provider' to the response
Added the optional property 'transaction/items/currencyConversion/providerReceipt' to the response
Added the optional property 'transaction/items/giftCard' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/giftCard' to the response
Added the optional property 'transaction/items/transaction/targetTransactionId' to the response
Removed the 'HOSTED_FORM' enum value from the 'transaction/items/gatewayEntryPoint' response property
Removed the 'HOSTED_PAGE' enum value from the 'transaction/items/gatewayEntryPoint' response property
Added the required property 'currencyConversion/uptake' to the response
Added the required property 'transaction/items/currencyConversion/uptake' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Removed the required property 'currencyConversion/payerAcceptance' from the response
Removed the required property 'currencyConversion/payerAcceptance' from the response
Added the new 'CHECKOUT' enum value to the 'gatewayEntryPoint' response property
Added the new 'GIFT_CARD' enum value to the 'sourceOfFunds/type' response property
Removed the request property ' Authorize /currencyConversion/payerAcceptance'
Removed the request property ' Authorize /currencyConversion/payerAmount'
Removed the request property ' Authorize /currencyConversion/payerCurrency'
Removed the request property ' Capture /currencyConversion/payerAcceptance'
Removed the request property ' Capture /currencyConversion/payerAmount'
Removed the request property ' Capture /currencyConversion/payerCurrency'
Removed the request property ' Pay /currencyConversion/payerAcceptance'
Removed the request property ' Pay /currencyConversion/payerAmount'
Removed the request property ' Pay /currencyConversion/payerCurrency'
Added the new 'CHECKOUT' enum value to the 'gatewayEntryPoint' response property
Added the new 'GIFT_CARD' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'currencyConversion/provider' to the response
Added the optional property 'currencyConversion/providerReceipt' to the response
Added the optional property 'giftCard' to the response
Added the optional property 'sourceOfFunds/provided/giftCard' to the response
Added the optional property 'transaction/targetTransactionId' to the response
Removed the 'HOSTED_FORM' enum value from the 'gatewayEntryPoint' response property
Removed the 'HOSTED_PAGE' enum value from the 'gatewayEntryPoint' response property
Added the required property 'currencyConversion/uptake' to the response
Added the new optional request property ' Authorize /currencyConversion/requestId'
Added the new optional request property ' Authorize /currencyConversion/uptake'
Added the new optional request property ' Capture /currencyConversion/requestId'
Added the new optional request property ' Capture /currencyConversion/uptake'
Added the new optional request property ' Capture /sourceOfFunds/provided/giftCard'
Added the new optional request property ' Pay /currencyConversion/requestId'
Added the new optional request property ' Pay /currencyConversion/uptake'
Added the new optional request property ' Pay /sourceOfFunds/provided/giftCard'
Added the new optional request property ' Refund /currencyConversion'
Added the new 'GIFT_CARD' enum value to the request property ' Capture /sourceOfFunds/type'
Added the new 'GIFT_CARD' enum value to the request property ' Pay /sourceOfFunds/type'
Added the optional property 'currencyConversion/provider' to the response
Added the optional property 'currencyConversion/providerReceipt' to the response
Added the optional property 'giftCard' to the response
Added the optional property 'sourceOfFunds/provided/giftCard' to the response
Added the optional property 'transaction/targetTransactionId' to the response
Removed the 'HOSTED_FORM' enum value from the 'gatewayEntryPoint' response property
Removed the 'HOSTED_PAGE' enum value from the 'gatewayEntryPoint' response property
Added the required property 'currencyConversion/uptake' to the response

Operations

Payment Options Inquiry

Breaking changes

Added the new 'GIFT_CARD' enum value to the 'paymentTypes/items/paymentType' response property

Non-Breaking changes

Added the new optional 'query' request parameter 'posTerminal'
Added the new optional 'query' request parameter 'posTerminal.eposId'
Added the new optional 'query' request parameter 'posTerminal.serialNumber'
Added the optional property 'currencyConversion/provider' to the response
Added the optional property 'currencyConversion/providerReceipt' to the response
Added the optional property 'currencyConversion/requestId' to the response

Operations

Create Checkout Session , Create Session

Breaking changes

Removed ' create_payment_page_session_request' from the request body 'oneOf' list
Added ' create_checkout_session_response' to the response body 'oneOf' list

Non-Breaking changes

Api operation id 'Session: Create Payment Page Session OR Session: Create Session' removed and replaced with 'Session: Create Checkout Session OR Session: Create Session'
Added ' create_checkout_session_request' to the request body 'oneOf' list
Removed ' create_payment_page_session_response' from the response body 'oneOf' list

Operations

Open Wallet , Retrieve Session , Update Session

Breaking changes

Removed the optional property 'currencyConversion/payerAcceptance' from the response
Removed the optional property 'currencyConversion/payerAmount' from the response
Removed the optional property 'currencyConversion/payerCurrency' from the response
Added the new 'GIFT_CARD' enum value to the 'sourceOfFunds/type' response property
Removed the optional property 'currencyConversion/payerAcceptance' from the response
Removed the optional property 'currencyConversion/payerAmount' from the response
Removed the optional property 'currencyConversion/payerCurrency' from the response
Added the new 'GIFT_CARD' enum value to the 'sourceOfFunds/type' response property
Removed the request property 'currencyConversion/payerAcceptance'
Removed the request property 'currencyConversion/payerAmount'
Removed the request property 'currencyConversion/payerCurrency'
Removed the optional property 'currencyConversion/payerAcceptance' from the response
Removed the optional property 'currencyConversion/payerAmount' from the response
Removed the optional property 'currencyConversion/payerCurrency' from the response
Added the new 'GIFT_CARD' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'currencyConversion/requestId' to the response
Added the optional property 'currencyConversion/uptake' to the response
Added the optional property 'sourceOfFunds/provided/giftCard' to the response
Added the optional property 'currencyConversion/requestId' to the response
Added the optional property 'currencyConversion/uptake' to the response
Added the optional property 'sourceOfFunds/provided/giftCard' to the response
Added the new optional request property 'currencyConversion/requestId'
Added the new optional request property 'currencyConversion/uptake'
Added the new optional request property 'sourceOfFunds/provided/giftCard'
Added the new 'GIFT_CARD' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'currencyConversion/requestId' to the response
Added the optional property 'currencyConversion/uptake' to the response
Added the optional property 'sourceOfFunds/provided/giftCard' to the response

Operations

Save Card (with system-generated token)

Breaking changes

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

Operations

Delete Token , Retrieve Card , Save Card

Breaking changes

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

Operations

Search Tokens

Breaking changes

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

December 2014

Version 26

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Non-Breaking changes

Added the new optional request property 'session/version'

Operations

Close Batch

Non-Breaking changes

The 'acquirer/id' response's property pattern '^[ -~]*$' was added

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'transaction/items/transaction/acquirer/transactionId' to the response
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Non-Breaking changes

Added the optional property 'transaction/acquirer/transactionId' to the response
Added the new optional request property ' Authorize /session/version'
Added the new optional request property ' Capture /session/version'
Added the new optional request property ' Pay /session/version'
Added the new optional request property ' Refund /session/version'
Added the new optional request property ' Refund /sourceOfFunds/provided/ach'
Added the new optional request property ' Verify /session/version'
Added the new 'ACH' enum value to the request property ' Refund /sourceOfFunds/type'
Added the optional property 'transaction/acquirer/transactionId' to the response

Operations

Payment Options Inquiry

Breaking changes

Added the new 'ACH' enum value to the 'paymentTypes/items/paymentType' response property

Non-Breaking changes

Added the new optional 'query' request parameter 'session.version'
Added the new enum value 'ACH' to the 'query' request parameter 'paymentType'

Operations

Plan Offers Inquiry

Non-Breaking changes

Added the new optional request property 'session/version'

Operations

Create Payment Page Session , Create Session

Non-Breaking changes

Added the required property ' Create Payment Page Session /session/updateStatus' to the response
Added the required property ' Create Payment Page Session /session/version' to the response
Added the required property ' Create Session /session/updateStatus' to the response
Added the required property ' Create Session /session/version' to the response

Operations

Open Wallet , Retrieve Session , Update Session

Breaking changes

Removed the required property 'session/status' from the response
Removed the required property 'session/status' from the response
Removed the required property 'session/status' from the response
Added the new 'ACH' enum value to the 'paymentType' response property
Added the new 'ACH' enum value to the 'paymentType' response property
Added the new 'ACH' enum value to the 'paymentType' response property

Non-Breaking changes

Added the required property 'session/updateStatus' to the response
Added the required property 'session/version' to the response
Added the new optional request property 'session'
Added the required property 'session/updateStatus' to the response
Added the required property 'session/version' to the response
Added the new optional request property 'session'
Added the new 'ACH' enum value to the request property 'paymentType'
Added the required property 'session/updateStatus' to the response
Added the required property 'session/version' to the response

Operations

Save Card (with system-generated token)

Non-Breaking changes

Added the new optional request property 'session/version'

Operations

Delete Token , Retrieve Card , Save Card

Non-Breaking changes

Added the new optional request property 'session/version'

October 2014

Version 25

Operations

Close Batch

Non-Breaking changes

Added the new optional request property 'acquirer/id'
The request property 'acquirer/cardType' became optional
The request property 'acquirer/currency' became optional

Operations

Retrieve Order

Breaking changes

Removed the optional property 'billing/phone' from the response
Removed the optional property 'customer/ani' from the response
Removed the optional property 'customer/aniCallType' from the response
Removed the optional property 'customer/browser' from the response
Removed the optional property 'customer/hostname' from the response
Removed the optional property 'customer/ipAddress' from the response
Removed the optional property 'risk/gatewayCode' from the response
Removed the optional property 'risk/reversalResult' from the response
Removed the optional property 'risk/review' from the response
Removed the optional property 'risk/rule' from the response
Removed the optional property 'risk/totalScore' from the response
Removed the optional property 'shipping/firstName' from the response
Removed the optional property 'shipping/lastName' from the response
Removed the optional property 'shipping/phone' from the response
Removed the optional property 'sourceOfFunds/provided/card/holder' from the response
Removed the optional property 'transaction/items/billing/phone' from the response
Removed the optional property 'transaction/items/customer/ani' from the response
Removed the optional property 'transaction/items/customer/aniCallType' from the response
Removed the optional property 'transaction/items/customer/browser' from the response
Removed the optional property 'transaction/items/customer/hostname' from the response
Removed the optional property 'transaction/items/customer/ipAddress' from the response
Removed the optional property 'transaction/items/response/risk' from the response
Removed the optional property 'transaction/items/shipping/firstName' from the response
Removed the optional property 'transaction/items/shipping/lastName' from the response
Removed the optional property 'transaction/items/shipping/phone' from the response
Removed the optional property 'transaction/items/sourceOfFunds/provided/card/holder' from the response
Added the new 'ACH' enum value to the 'sourceOfFunds/type' response property
Added the new 'ACH' enum value to the 'transaction/items/sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'billing/address/company' to the response
Added the optional property 'customer/firstName' to the response
Added the optional property 'customer/lastName' to the response
Added the optional property 'customer/mobilePhone' to the response
Added the optional property 'customer/phone' to the response
Added the optional property 'device' to the response
Added the optional property 'discount' to the response
Added the optional property 'item/items/brand' to the response
Added the optional property 'item/items/category' to the response
Added the optional property 'risk/custom' to the response
Added the optional property 'risk/response' to the response
Added the optional property 'shipping/address/company' to the response
Added the optional property 'shipping/contact' to the response
Added the optional property 'sourceOfFunds/provided/ach' to the response
Added the optional property 'sourceOfFunds/provided/card/nameOnCard' to the response
Added the optional property 'transaction/items/billing/address/company' to the response
Added the optional property 'transaction/items/customer/firstName' to the response
Added the optional property 'transaction/items/customer/lastName' to the response
Added the optional property 'transaction/items/customer/mobilePhone' to the response
Added the optional property 'transaction/items/customer/phone' to the response
Added the optional property 'transaction/items/device' to the response
Added the optional property 'transaction/items/order/discount' to the response
Added the optional property 'transaction/items/order/item/items/brand' to the response
Added the optional property 'transaction/items/order/item/items/category' to the response
Added the optional property 'transaction/items/posTerminal/eposId' to the response
Added the optional property 'transaction/items/posTerminal/serialNumber' to the response
Added the optional property 'transaction/items/risk' to the response
Added the optional property 'transaction/items/shipping/address/company' to the response
Added the optional property 'transaction/items/shipping/contact' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/ach' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/nameOnCard' to the response
Added the optional property 'transaction/items/transaction/item/items/brand' to the response
Added the optional property 'transaction/items/transaction/item/items/category' to the response
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Removed the optional property 'billing/phone' from the response
Removed the optional property 'customer/ani' from the response
Removed the optional property 'customer/aniCallType' from the response
Removed the optional property 'customer/browser' from the response
Removed the optional property 'customer/hostname' from the response
Removed the optional property 'customer/ipAddress' from the response
Removed the optional property 'response/risk' from the response
Removed the optional property 'shipping/firstName' from the response
Removed the optional property 'shipping/lastName' from the response
Removed the optional property 'shipping/phone' from the response
Removed the optional property 'sourceOfFunds/provided/card/holder' from the response
Added the new 'ACH' enum value to the 'sourceOfFunds/type' response property
Changed the pattern of the request property ' Confirm /order/itemAmount'
Changed the pattern of the request property ' Confirm /order/shippingAndHandlingAmount'
Changed the pattern of the request property ' Confirm /order/taxAmount'
Changed the pattern of the request property ' Initiate /order/itemAmount'
Changed the pattern of the request property ' Initiate /order/shippingAndHandlingAmount'
Changed the pattern of the request property ' Initiate /order/taxAmount'
Changed the pattern of the request property ' Verify /order/itemAmount'
Changed the pattern of the request property ' Verify /order/shippingAndHandlingAmount'
Changed the pattern of the request property ' Verify /order/taxAmount'
Removed the request property ' Initiate /shipping/firstName'
Removed the request property ' Initiate /shipping/lastName'
Removed the request property ' Initiate /shipping/phone'
Removed the request property ' Authorize /action/bypassMerchantRiskRules'
Removed the request property ' Authorize /billing/phone'
Removed the request property ' Authorize /customer/ani'
Removed the request property ' Authorize /customer/aniCallType'
Removed the request property ' Authorize /customer/browser'
Removed the request property ' Authorize /customer/hostname'
Removed the request property ' Authorize /customer/ipAddress'
Removed the request property ' Authorize /shipping/firstName'
Removed the request property ' Authorize /shipping/lastName'
Removed the request property ' Authorize /shipping/phone'
Removed the request property ' Authorize /sourceOfFunds/provided/card/holder'
Removed the request property ' Capture /billing/phone'
Removed the request property ' Capture /customer/ani'
Removed the request property ' Capture /customer/aniCallType'
Removed the request property ' Capture /customer/browser'
Removed the request property ' Capture /customer/hostname'
Removed the request property ' Capture /customer/ipAddress'
Removed the request property ' Capture /shipping/firstName'
Removed the request property ' Capture /shipping/lastName'
Removed the request property ' Capture /shipping/phone'
Removed the request property ' Capture /sourceOfFunds/provided/card/holder'
Removed the request property ' Pay /action/bypassMerchantRiskRules'
Removed the request property ' Pay /billing/phone'
Removed the request property ' Pay /customer/ani'
Removed the request property ' Pay /customer/aniCallType'
Removed the request property ' Pay /customer/browser'
Removed the request property ' Pay /customer/hostname'
Removed the request property ' Pay /customer/ipAddress'
Removed the request property ' Pay /shipping/firstName'
Removed the request property ' Pay /shipping/lastName'
Removed the request property ' Pay /shipping/phone'
Removed the request property ' Pay /sourceOfFunds/provided/card/holder'
Removed the request property ' Refund /billing/phone'
Removed the request property ' Refund /customer/ani'
Removed the request property ' Refund /customer/aniCallType'
Removed the request property ' Refund /customer/browser'
Removed the request property ' Refund /customer/hostname'
Removed the request property ' Refund /customer/ipAddress'
Removed the request property ' Refund /shipping/firstName'
Removed the request property ' Refund /shipping/lastName'
Removed the request property ' Refund /shipping/phone'
Removed the request property ' Refund /sourceOfFunds/provided/card/holder'
Removed the request property ' Verify /action/bypassMerchantRiskRules'
Removed the request property ' Verify /billing/phone'
Removed the request property ' Verify /customer/ani'
Removed the request property ' Verify /customer/aniCallType'
Removed the request property ' Verify /customer/browser'
Removed the request property ' Verify /customer/hostname'
Removed the request property ' Verify /customer/ipAddress'
Removed the request property ' Verify /shipping/firstName'
Removed the request property ' Verify /shipping/lastName'
Removed the request property ' Verify /shipping/phone'
Removed the request property ' Verify /sourceOfFunds/provided/card/holder'
Removed the optional property 'billing/phone' from the response
Removed the optional property 'customer/ani' from the response
Removed the optional property 'customer/aniCallType' from the response
Removed the optional property 'customer/browser' from the response
Removed the optional property 'customer/hostname' from the response
Removed the optional property 'customer/ipAddress' from the response
Removed the optional property 'response/risk' from the response
Removed the optional property 'shipping/firstName' from the response
Removed the optional property 'shipping/lastName' from the response
Removed the optional property 'shipping/phone' from the response
Removed the optional property 'sourceOfFunds/provided/card/holder' from the response
Added the new 'ACH' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'billing/address/company' to the response
Added the optional property 'customer/firstName' to the response
Added the optional property 'customer/lastName' to the response
Added the optional property 'customer/mobilePhone' to the response
Added the optional property 'customer/phone' to the response
Added the optional property 'device' to the response
Added the optional property 'order/discount' to the response
Added the optional property 'order/item/items/brand' to the response
Added the optional property 'order/item/items/category' to the response
Added the optional property 'posTerminal/eposId' to the response
Added the optional property 'posTerminal/serialNumber' to the response
Added the optional property 'risk' to the response
Added the optional property 'shipping/address/company' to the response
Added the optional property 'shipping/contact' to the response
Added the optional property 'sourceOfFunds/provided/ach' to the response
Added the optional property 'sourceOfFunds/provided/card/nameOnCard' to the response
Added the optional property 'transaction/item/items/brand' to the response
Added the optional property 'transaction/item/items/category' to the response
Added the new optional request property ' Confirm /order/item/items/brand'
Added the new optional request property ' Confirm /order/item/items/category'
Added the new optional request property ' Initiate /order/item/items/brand'
Added the new optional request property ' Initiate /order/item/items/category'
Added the new optional request property ' Initiate /shipping/address/company'
Added the new optional request property ' Initiate /shipping/contact'
Added the new optional request property ' Authorize /action/tokenOperation'
Added the new optional request property ' Authorize /billing/address/company'
Added the new optional request property ' Authorize /customer/firstName'
Added the new optional request property ' Authorize /customer/lastName'
Added the new optional request property ' Authorize /customer/mobilePhone'
Added the new optional request property ' Authorize /customer/phone'
Added the new optional request property ' Authorize /device'
Added the new optional request property ' Authorize /order/discount'
Added the new optional request property ' Authorize /order/item/items/brand'
Added the new optional request property ' Authorize /order/item/items/category'
Added the new optional request property ' Authorize /posTerminal/eposId'
Added the new optional request property ' Authorize /posTerminal/serialNumber'
Added the new optional request property ' Authorize /risk'
Added the new optional request property ' Authorize /shipping/address/company'
Added the new optional request property ' Authorize /shipping/contact'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/nameOnCard'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/p2pe'
Added the new optional request property ' Authorize /sourceOfFunds/provided/card/payload'
Added the new optional request property ' Capture /action'
Added the new optional request property ' Capture /billing/address/company'
Added the new optional request property ' Capture /customer/firstName'
Added the new optional request property ' Capture /customer/lastName'
Added the new optional request property ' Capture /customer/mobilePhone'
Added the new optional request property ' Capture /customer/phone'
Added the new optional request property ' Capture /device'
Added the new optional request property ' Capture /posTerminal/eposId'
Added the new optional request property ' Capture /posTerminal/serialNumber'
Added the new optional request property ' Capture /risk'
Added the new optional request property ' Capture /shipping/address/company'
Added the new optional request property ' Capture /shipping/contact'
Added the new optional request property ' Capture /sourceOfFunds/provided/card/nameOnCard'
Added the new optional request property ' Capture /sourceOfFunds/provided/card/p2pe'
Added the new optional request property ' Capture /sourceOfFunds/provided/card/payload'
Added the new optional request property ' Capture /transaction/item/items/brand'
Added the new optional request property ' Capture /transaction/item/items/category'
Added the new optional request property ' Pay /action/tokenOperation'
Added the new optional request property ' Pay /billing/address/company'
Added the new optional request property ' Pay /customer/firstName'
Added the new optional request property ' Pay /customer/lastName'
Added the new optional request property ' Pay /customer/mobilePhone'
Added the new optional request property ' Pay /customer/phone'
Added the new optional request property ' Pay /device'
Added the new optional request property ' Pay /order/discount'
Added the new optional request property ' Pay /order/item/items/brand'
Added the new optional request property ' Pay /order/item/items/category'
Added the new optional request property ' Pay /posTerminal/eposId'
Added the new optional request property ' Pay /posTerminal/serialNumber'
Added the new optional request property ' Pay /risk'
Added the new optional request property ' Pay /shipping/address/company'
Added the new optional request property ' Pay /shipping/contact'
Added the new optional request property ' Pay /sourceOfFunds/provided/ach'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/nameOnCard'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/p2pe'
Added the new optional request property ' Pay /sourceOfFunds/provided/card/payload'
Added the new optional request property ' Refund /action'
Added the new optional request property ' Refund /billing/address/company'
Added the new optional request property ' Refund /customer/firstName'
Added the new optional request property ' Refund /customer/lastName'
Added the new optional request property ' Refund /customer/mobilePhone'
Added the new optional request property ' Refund /customer/phone'
Added the new optional request property ' Refund /device'
Added the new optional request property ' Refund /posTerminal/eposId'
Added the new optional request property ' Refund /posTerminal/serialNumber'
Added the new optional request property ' Refund /shipping/address/company'
Added the new optional request property ' Refund /shipping/contact'
Added the new optional request property ' Refund /sourceOfFunds/provided/card/nameOnCard'
Added the new optional request property ' Refund /sourceOfFunds/provided/card/p2pe'
Added the new optional request property ' Refund /sourceOfFunds/provided/card/payload'
Added the new optional request property ' Refund /transaction/item/items/brand'
Added the new optional request property ' Refund /transaction/item/items/category'
Added the new optional request property ' Verify /action/tokenOperation'
Added the new optional request property ' Verify /billing/address/company'
Added the new optional request property ' Verify /customer/firstName'
Added the new optional request property ' Verify /customer/lastName'
Added the new optional request property ' Verify /customer/mobilePhone'
Added the new optional request property ' Verify /customer/phone'
Added the new optional request property ' Verify /device'
Added the new optional request property ' Verify /order/discount'
Added the new optional request property ' Verify /order/item/items/brand'
Added the new optional request property ' Verify /order/item/items/category'
Added the new optional request property ' Verify /posTerminal/eposId'
Added the new optional request property ' Verify /posTerminal/serialNumber'
Added the new optional request property ' Verify /risk'
Added the new optional request property ' Verify /shipping/address/company'
Added the new optional request property ' Verify /shipping/contact'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/nameOnCard'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/p2pe'
Added the new optional request property ' Verify /sourceOfFunds/provided/card/payload'
Added the new 'ACH' enum value to the request property ' Pay /sourceOfFunds/type'
Added the optional property 'billing/address/company' to the response
Added the optional property 'customer/firstName' to the response
Added the optional property 'customer/lastName' to the response
Added the optional property 'customer/mobilePhone' to the response
Added the optional property 'customer/phone' to the response
Added the optional property 'device' to the response
Added the optional property 'order/discount' to the response
Added the optional property 'order/item/items/brand' to the response
Added the optional property 'order/item/items/category' to the response
Added the optional property 'posTerminal/eposId' to the response
Added the optional property 'posTerminal/serialNumber' to the response
Added the optional property 'risk' to the response
Added the optional property 'shipping/address/company' to the response
Added the optional property 'shipping/contact' to the response
Added the optional property 'sourceOfFunds/provided/ach' to the response
Added the optional property 'sourceOfFunds/provided/card/nameOnCard' to the response
Added the optional property 'transaction/item/items/brand' to the response
Added the optional property 'transaction/item/items/category' to the response

Operations

Create Payment Page Session

Breaking changes

The ' Create Payment Page Session /sourceOfFunds/provided/card' request property type/format changed from ''/'' to 'object'/''
Removed the request property ' Create Payment Page Session /action/bypassMerchantRiskRules'
Removed the request property ' Create Payment Page Session /billing/phone'
Removed the request property ' Create Payment Page Session /customer/ani'
Removed the request property ' Create Payment Page Session /customer/aniCallType'
Removed the request property ' Create Payment Page Session /shipping/firstName'
Removed the request property ' Create Payment Page Session /shipping/lastName'
Removed the request property ' Create Payment Page Session /shipping/phone'

Non-Breaking changes

Added the new optional request property ' Create Payment Page Session /action/tokenOperation'
Added the new optional request property ' Create Payment Page Session /billing/address/company'
Added the new optional request property ' Create Payment Page Session /customer/firstName'
Added the new optional request property ' Create Payment Page Session /customer/lastName'
Added the new optional request property ' Create Payment Page Session /customer/mobilePhone'
Added the new optional request property ' Create Payment Page Session /customer/phone'
Added the new optional request property ' Create Payment Page Session /device'
Added the new optional request property ' Create Payment Page Session /order/item/items/brand'
Added the new optional request property ' Create Payment Page Session /order/item/items/category'
Added the new optional request property ' Create Payment Page Session /risk'
Added the new optional request property ' Create Payment Page Session /shipping/address/company'
Added the new optional request property ' Create Payment Page Session /shipping/contact'

Operations

Open Wallet , Retrieve Session , Update Session

Breaking changes

Removed the optional property 'action/bypassMerchantRiskRules' from the response
Removed the optional property 'billing/phone' from the response
Removed the optional property 'customer/ani' from the response
Removed the optional property 'customer/aniCallType' from the response
Removed the optional property 'customer/browser' from the response
Removed the optional property 'customer/hostname' from the response
Removed the optional property 'customer/ipAddress' from the response
Removed the optional property 'shipping/firstName' from the response
Removed the optional property 'shipping/lastName' from the response
Removed the optional property 'shipping/phone' from the response
Removed the optional property 'sourceOfFunds/provided/card/holder' from the response
Added the new 'ACH' enum value to the 'sourceOfFunds/type' response property
Removed the optional property 'action/bypassMerchantRiskRules' from the response
Removed the optional property 'billing/phone' from the response
Removed the optional property 'customer/ani' from the response
Removed the optional property 'customer/aniCallType' from the response
Removed the optional property 'customer/browser' from the response
Removed the optional property 'customer/hostname' from the response
Removed the optional property 'customer/ipAddress' from the response
Removed the optional property 'shipping/firstName' from the response
Removed the optional property 'shipping/lastName' from the response
Removed the optional property 'shipping/phone' from the response
Removed the optional property 'sourceOfFunds/provided/card/holder' from the response
Added the new 'ACH' enum value to the 'sourceOfFunds/type' response property
Removed the request property 'action/bypassMerchantRiskRules'
Removed the request property 'billing/phone'
Removed the request property 'customer/ani'
Removed the request property 'customer/aniCallType'
Removed the request property 'customer/browser'
Removed the request property 'customer/hostname'
Removed the request property 'customer/ipAddress'
Removed the request property 'shipping/firstName'
Removed the request property 'shipping/lastName'
Removed the request property 'shipping/phone'
Removed the request property 'sourceOfFunds/provided/card/holder'
Removed the optional property 'action/bypassMerchantRiskRules' from the response
Removed the optional property 'billing/phone' from the response
Removed the optional property 'customer/ani' from the response
Removed the optional property 'customer/aniCallType' from the response
Removed the optional property 'customer/browser' from the response
Removed the optional property 'customer/hostname' from the response
Removed the optional property 'customer/ipAddress' from the response
Removed the optional property 'shipping/firstName' from the response
Removed the optional property 'shipping/lastName' from the response
Removed the optional property 'shipping/phone' from the response
Removed the optional property 'sourceOfFunds/provided/card/holder' from the response
Added the new 'ACH' enum value to the 'sourceOfFunds/type' response property

Non-Breaking changes

Added the optional property 'billing/address/company' to the response
Added the optional property 'customer/firstName' to the response
Added the optional property 'customer/lastName' to the response
Added the optional property 'customer/mobilePhone' to the response
Added the optional property 'customer/phone' to the response
Added the optional property 'device' to the response
Added the optional property 'order/discount' to the response
Added the optional property 'order/item/items/brand' to the response
Added the optional property 'order/item/items/category' to the response
Added the optional property 'posTerminal/eposId' to the response
Added the optional property 'posTerminal/serialNumber' to the response
Added the optional property 'risk' to the response
Added the optional property 'shipping/address/company' to the response
Added the optional property 'shipping/contact' to the response
Added the optional property 'sourceOfFunds/provided/ach' to the response
Added the optional property 'sourceOfFunds/provided/card/nameOnCard' to the response
Added the optional property 'transaction/item/items/brand' to the response
Added the optional property 'transaction/item/items/category' to the response
Added the new optional request property 'order/item/items/brand'
Added the new optional request property 'order/item/items/category'
Added the optional property 'billing/address/company' to the response
Added the optional property 'customer/firstName' to the response
Added the optional property 'customer/lastName' to the response
Added the optional property 'customer/mobilePhone' to the response
Added the optional property 'customer/phone' to the response
Added the optional property 'device' to the response
Added the optional property 'order/discount' to the response
Added the optional property 'order/item/items/brand' to the response
Added the optional property 'order/item/items/category' to the response
Added the optional property 'posTerminal/eposId' to the response
Added the optional property 'posTerminal/serialNumber' to the response
Added the optional property 'risk' to the response
Added the optional property 'shipping/address/company' to the response
Added the optional property 'shipping/contact' to the response
Added the optional property 'sourceOfFunds/provided/ach' to the response
Added the optional property 'sourceOfFunds/provided/card/nameOnCard' to the response
Added the optional property 'transaction/item/items/brand' to the response
Added the optional property 'transaction/item/items/category' to the response
Added the new optional request property 'billing/address/company'
Added the new optional request property 'customer/firstName'
Added the new optional request property 'customer/lastName'
Added the new optional request property 'customer/mobilePhone'
Added the new optional request property 'customer/phone'
Added the new optional request property 'device'
Added the new optional request property 'order/discount'
Added the new optional request property 'order/item/items/brand'
Added the new optional request property 'order/item/items/category'
Added the new optional request property 'posTerminal/eposId'
Added the new optional request property 'posTerminal/serialNumber'
Added the new optional request property 'risk'
Added the new optional request property 'shipping/address/company'
Added the new optional request property 'shipping/contact'
Added the new optional request property 'sourceOfFunds/provided/ach'
Added the new optional request property 'sourceOfFunds/provided/card/nameOnCard'
Added the new optional request property 'transaction/item/items/brand'
Added the new optional request property 'transaction/item/items/category'
Added the new 'ACH' enum value to the request property 'sourceOfFunds/type'
Added the optional property 'billing/address/company' to the response
Added the optional property 'customer/firstName' to the response
Added the optional property 'customer/lastName' to the response
Added the optional property 'customer/mobilePhone' to the response
Added the optional property 'customer/phone' to the response
Added the optional property 'device' to the response
Added the optional property 'order/discount' to the response
Added the optional property 'order/item/items/brand' to the response
Added the optional property 'order/item/items/category' to the response
Added the optional property 'posTerminal/eposId' to the response
Added the optional property 'posTerminal/serialNumber' to the response
Added the optional property 'risk' to the response
Added the optional property 'shipping/address/company' to the response
Added the optional property 'shipping/contact' to the response
Added the optional property 'sourceOfFunds/provided/ach' to the response
Added the optional property 'sourceOfFunds/provided/card/nameOnCard' to the response
Added the optional property 'transaction/item/items/brand' to the response
Added the optional property 'transaction/item/items/category' to the response

Operations

Save Card (with system-generated token)

Breaking changes

The 'sourceOfFunds/provided/card/expiry' response's property type/format changed from 'object'/'' to 'string'/''
Removed the required property 'sourceOfFunds/provided/card/expiry/month' from the response
Removed the required property 'sourceOfFunds/provided/card/expiry/year' from the response

Non-Breaking changes

The response property 'sourceOfFunds/provided/card/expiry' became required
The 'sourceOfFunds/provided/card/expiry' response's property pattern '^[0-9]*$' was added
Added the required property 'status' to the response

Operations

Delete Token , Retrieve Card , Save Card

Breaking changes

The 'sourceOfFunds/provided/card/expiry' response's property type/format changed from 'object'/'' to 'string'/''
Removed the required property 'sourceOfFunds/provided/card/expiry/month' from the response
Removed the required property 'sourceOfFunds/provided/card/expiry/year' from the response
The 'sourceOfFunds/provided/card/expiry' response's property type/format changed from 'object'/'' to 'string'/''
Removed the required property 'sourceOfFunds/provided/card/expiry/month' from the response
Removed the required property 'sourceOfFunds/provided/card/expiry/year' from the response

Non-Breaking changes

The response property 'sourceOfFunds/provided/card/expiry' became required
The 'sourceOfFunds/provided/card/expiry' response's property pattern '^[0-9]*$' was added
Added the required property 'status' to the response
The response property 'sourceOfFunds/provided/card/expiry' became required
The 'sourceOfFunds/provided/card/expiry' response's property pattern '^[0-9]*$' was added
Added the required property 'status' to the response

Operations

Search Tokens

Breaking changes

The 'page/token/items/sourceOfFunds/provided/card/expiry' response's property type/format changed from 'object'/'' to 'string'/''
Removed the required property 'page/token/items/sourceOfFunds/provided/card/expiry/month' from the response
Removed the required property 'page/token/items/sourceOfFunds/provided/card/expiry/year' from the response

Non-Breaking changes

The response property 'page/token/items/sourceOfFunds/provided/card/expiry' became required
The 'page/token/items/sourceOfFunds/provided/card/expiry' response's property pattern '^[0-9]*$' was added
The 'page/token/items/usage/lastUpdatedBy' response's property pattern was changed
Added the required property 'page/token/items/status' to the response

September 2014

Version 24

Operations

Update Test Merchant Test Host Type , Retrieve Test Merchant Test Host Type

Non-Breaking changes

Endpoint added

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'recurringPaymentAgreement' to the response
Added the optional property 'transaction/items/order/recurringPaymentAgreement' to the response
Added the optional property 'transaction/items/order/wallet' to the response
Added the optional property 'wallet' to the response
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Non-Breaking changes

Added the optional property 'order/recurringPaymentAgreement' to the response
Added the optional property 'order/wallet' to the response
Added the new optional request property ' Authorize /order/recurringPaymentAgreement'
Added the new optional request property ' Pay /order/recurringPaymentAgreement'
Added the new optional request property ' Verify /order/recurringPaymentAgreement'
Added the optional property 'order/recurringPaymentAgreement' to the response
Added the optional property 'order/wallet' to the response

Operations

Create Payment Page Session

Non-Breaking changes

Added the new optional request property ' Create Payment Page Session /order/recurringPaymentAgreement'

Operations

Open Wallet , Retrieve Session , Update Session

Non-Breaking changes

Added the optional property 'order/recurringPaymentAgreement' to the response
The request property 'order/amount' became optional
The request property 'order/currency' became optional
Added the optional property 'order/recurringPaymentAgreement' to the response
Added the new optional request property 'order/recurringPaymentAgreement'
Added the optional property 'order/recurringPaymentAgreement' to the response

Operations

Update Visa Checkout Details , Retrieve Visa Checkout Details

Non-Breaking changes

Endpoint added

July 2014

Version 23

Operations

Verify

Non-Breaking changes

Added the new optional request property ' Verify /order/description'
Added the new optional request property ' Verify /order/item'
Added the new optional request property ' Verify /order/itemAmount'
Added the new optional request property ' Verify /order/shippingAndHandlingAmount'
Added the new optional request property ' Verify /order/taxAmount'

Operations

Create Payment Page Session

Non-Breaking changes

Added the new optional request property ' Create Payment Page Session /order/custom'

June 2014

Version 22

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Breaking changes

Added the new required request property 'order'
Removed the request property 'transaction'

Operations

Authorize , Pay , Verify

Breaking changes

Added the new required request property ' Authorize /order/amount'
Added the new required request property ' Authorize /order/currency'
Added the new required request property ' Pay /order/amount'
Added the new required request property ' Pay /order/currency'
Added the new required request property ' Verify /order/currency'
The request property ' Authorize /order' became required
The request property ' Pay /order' became required
The request property ' Verify /order' became required
Removed the request property ' Authorize /transaction/amount'
Removed the request property ' Authorize /transaction/currency'
Removed the request property ' Pay /transaction/amount'
Removed the request property ' Pay /transaction/currency'
Removed the request property ' Verify /transaction/amount'
Removed the request property ' Verify /transaction/currency'

Non-Breaking changes

Added the new optional request property ' Verify /order/amount'
The request property ' Authorize /transaction' became optional
The request property ' Pay /transaction' became optional
The request property ' Verify /transaction' became optional
Added the new 'VISA_CHECKOUT' enum value to the request property ' Verify /order/walletProvider'

Operations

Payment Options Inquiry

Breaking changes

Added the new 'VISA_CHECKOUT' enum value to the 'walletProviders/items/walletProvider' response property

Operations

Plan Offers Inquiry

Breaking changes

Added the new required request property 'order'
Removed the required property 'transaction' from the response
Removed the request property 'transaction'

Non-Breaking changes

Added the required property 'order' to the response

Operations

Open Wallet , Retrieve Session , Update Session

Breaking changes

The 'order/amount' request property's minLength was increased from '0' to '1'
The 'order/amount' request property type/format changed from 'number'/'' to 'string'/''
The 'order/amount' request property's maxLength was set to '14'
Added the pattern to the request property 'order/amount'

Operations

Update Visa Checkout Configuration , Retrieve Visa Checkout Configuration

Non-Breaking changes

Endpoint added

May 2014

Version 21

Operations

Retrieve Order

Breaking changes

Added the new 'VISA_CHECKOUT' enum value to the 'transaction/items/order/walletProvider' response property
Added the new 'VISA_CHECKOUT' enum value to the 'walletProvider' response property

Non-Breaking changes

The response property 'transaction/items/posTerminal/name' became required
The 'merchant' response's property pattern was changed

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Added the new 'VISA_CHECKOUT' enum value to the 'order/walletProvider' response property
Added the new 'VISA_CHECKOUT' enum value to the 'order/walletProvider' response property

Non-Breaking changes

Added the new 'VISA_CHECKOUT' enum value to the request property ' Authorize /order/walletProvider'
Added the new 'VISA_CHECKOUT' enum value to the request property ' Capture /order/walletProvider'
Added the new 'VISA_CHECKOUT' enum value to the request property ' Pay /order/walletProvider'
Added the new 'VISA_CHECKOUT' enum value to the request property ' Refund /order/walletProvider'

Operations

Create Payment Page Session

Breaking changes

Added the new required request property ' Create Payment Page Session /sourceOfFunds'
Removed the request property ' Create Payment Page Session /transaction/source'

Non-Breaking changes

Added the new optional request property ' Create Payment Page Session /airline'
Added the new optional request property ' Create Payment Page Session /billing'
Added the new optional request property ' Create Payment Page Session /customer'
Added the new optional request property ' Create Payment Page Session /externalTokenProvider'
Added the new optional request property ' Create Payment Page Session /order/customerNote'
Added the new optional request property ' Create Payment Page Session /order/customerOrderDate'
Added the new optional request property ' Create Payment Page Session /order/customerReference'
Added the new optional request property ' Create Payment Page Session /order/description'
Added the new optional request property ' Create Payment Page Session /order/item'
Added the new optional request property ' Create Payment Page Session /order/itemAmount'
Added the new optional request property ' Create Payment Page Session /order/productSKU'
Added the new optional request property ' Create Payment Page Session /order/reference'
Added the new optional request property ' Create Payment Page Session /order/requestorName'
Added the new optional request property ' Create Payment Page Session /order/shippingAndHandlingAmount'
Added the new optional request property ' Create Payment Page Session /order/taxAmount'
Added the new optional request property ' Create Payment Page Session /order/taxRegistrationId'
Added the new optional request property ' Create Payment Page Session /partnerSolutionId'
Added the new optional request property ' Create Payment Page Session /paymentPage/billingAddress'
Added the new optional request property ' Create Payment Page Session /paymentPage/customer'
Added the new optional request property ' Create Payment Page Session /paymentPage/googleAnalytics'
Added the new optional request property ' Create Payment Page Session /paymentPage/locale'
Added the new optional request property ' Create Payment Page Session /paymentPage/merchant'
Added the new optional request property ' Create Payment Page Session /paymentPage/paymentTerms'
Added the new optional request property ' Create Payment Page Session /paymentPage/theme'
Added the new optional request property ' Create Payment Page Session /shipping'
Added the new optional request property ' Create Payment Page Session /transaction/acquirer'
Added the new optional request property ' Create Payment Page Session /transaction/cashAdvance'
Added the new optional request property ' Create Payment Page Session /transaction/frequency'
Added the new optional request property ' Create Payment Page Session /transaction/merchantNote'
Added the new optional request property ' Create Payment Page Session /transaction/reference'
Added the new optional request property ' Create Payment Page Session /userId'

Operations

Open Wallet , Retrieve Session , Update Session

Breaking changes

Added the new 'VISA_CHECKOUT' enum value to the 'order/walletProvider' response property
Added the new 'VISA_CHECKOUT' enum value to the 'order/walletProvider' response property
Added the new 'VISA_CHECKOUT' enum value to the 'order/walletProvider' response property

Non-Breaking changes

Added the optional property 'wallet/visaCheckout' to the response
Added the new optional request property 'order/description'
Added the new optional request property 'order/item'
Added the new optional request property 'order/itemAmount'
Added the new optional request property 'order/shippingAndHandlingAmount'
Added the new optional request property 'order/taxAmount'
Added the new optional request property 'wallet/visaCheckout'
The request property 'wallet/cancelURL' became optional
The request property 'wallet/returnURL' became optional
Added the new 'VISA_CHECKOUT' enum value to the request property 'order/walletProvider'
Added the optional property 'wallet/visaCheckout' to the response
Added the new optional request property 'wallet/visaCheckout'
Added the new 'VISA_CHECKOUT' enum value to the request property 'order/walletProvider'
Added the optional property 'wallet/visaCheckout' to the response

March 2014

Version 20

Operations

Check Gateway

Non-Breaking changes

Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Non-Breaking changes

Added the optional property 'currencyConversion' to the response
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Added the optional property 'currencyConversion' to the response
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Added the new optional request property 'currencyConversion'
Added the optional property 'currencyConversion' to the response
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property

Operations

Close Batch

Non-Breaking changes

Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property

Operations

Retrieve Order

Non-Breaking changes

Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

The request property ' Authorize /posTerminal/name' became required
The request property ' Capture /posTerminal/name' became required
The request property ' Pay /posTerminal/name' became required
The request property ' Refund /posTerminal/name' became required
The request property ' Verify /posTerminal/name' became required

Non-Breaking changes

The response property 'posTerminal/name' became required
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Added the new optional request property ' Capture /currencyConversion'
The response property 'posTerminal/name' became required
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property

Operations

Payment Options Inquiry

Non-Breaking changes

Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property

Operations

Plan Offers Inquiry

Non-Breaking changes

Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property

Operations

Create Payment Page Session , Create Session

Non-Breaking changes

Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property

Operations

Open Wallet , Retrieve Session , Update Session

Non-Breaking changes

Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property

Operations

Save Card (with system-generated token)

Non-Breaking changes

Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property

Operations

Delete Token , Retrieve Card , Save Card

Non-Breaking changes

Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property

Operations

Search Tokens

Non-Breaking changes

Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property
Removed the 'CONSTRAINT_VIOLATION' enum value from the 'error/cause' response property

February 2014

Version 19

Operations

Check Gateway

Breaking changes

Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Breaking changes

Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Removed the request property 'sourceOfFunds/session'
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property

Non-Breaking changes

Added the new optional request property 'session'
The request property 'sourceOfFunds' became optional

Operations

Close Batch

Breaking changes

Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property

Operations

Retrieve Order

Breaking changes

The 'transaction/items/paymentPlan/planId' response property's maxLength was increased from '16' to '40'
Removed the required property 'transaction/items/paymentPlan/type' from the response
Removed the optional property 'transaction/items/currencyConversion/baseAmount' from the response
Removed the optional property 'transaction/items/currencyConversion/baseCurrency' from the response
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property

Non-Breaking changes

Added the optional property 'currencyConversion' to the response
Added the optional property 'transaction/items/constraints' to the response
Added the optional property 'transaction/items/currencyConversion/payerAmount' to the response
Added the optional property 'transaction/items/currencyConversion/payerCurrency' to the response
Added the optional property 'transaction/items/posTerminal/name' to the response
Added the required property 'transaction/items/currencyConversion/payerAcceptance' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

The 'paymentPlan/planId' response property's maxLength was increased from '16' to '40'
Removed the required property 'paymentPlan/type' from the response
Added the new required request property ' Authorize /currencyConversion/payerAcceptance'
Added the new required request property ' Pay /currencyConversion/payerAcceptance'
The request property ' Authorize /paymentPlan/planId' became required
The request property ' Pay /paymentPlan/planId' became required
The 'paymentPlan/planId' response property's maxLength was increased from '16' to '40'
Removed the required property 'paymentPlan/type' from the response
Removed the optional property 'currencyConversion/baseAmount' from the response
Removed the optional property 'currencyConversion/baseCurrency' from the response
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Removed the request property ' Authorize /currencyConversion/baseAmount'
Removed the request property ' Authorize /currencyConversion/baseCurrency'
Removed the request property ' Authorize /paymentPlan/type'
Removed the request property ' Authorize /sourceOfFunds/session'
Removed the request property ' Capture /sourceOfFunds/session'
Removed the request property ' Pay /currencyConversion/baseAmount'
Removed the request property ' Pay /currencyConversion/baseCurrency'
Removed the request property ' Pay /paymentPlan/type'
Removed the request property ' Pay /sourceOfFunds/session'
Removed the request property ' Refund /sourceOfFunds/session'
Removed the request property ' Verify /sourceOfFunds/session'
Removed the optional property 'currencyConversion/baseAmount' from the response
Removed the optional property 'currencyConversion/baseCurrency' from the response
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property

Non-Breaking changes

Added the optional property 'constraints' to the response
Added the optional property 'currencyConversion/payerAmount' to the response
Added the optional property 'currencyConversion/payerCurrency' to the response
Added the optional property 'posTerminal/name' to the response
Added the required property 'currencyConversion/payerAcceptance' to the response
Added the new optional request property ' Authorize /constraints'
Added the new optional request property ' Authorize /currencyConversion/payerAmount'
Added the new optional request property ' Authorize /currencyConversion/payerCurrency'
Added the new optional request property ' Authorize /posTerminal/name'
Added the new optional request property ' Authorize /session'
Added the new optional request property ' Capture /posTerminal/attended'
Added the new optional request property ' Capture /posTerminal/cardholderActivated'
Added the new optional request property ' Capture /posTerminal/inputCapability'
Added the new optional request property ' Capture /posTerminal/location'
Added the new optional request property ' Capture /posTerminal/name'
Added the new optional request property ' Capture /session'
Added the new optional request property ' Pay /constraints'
Added the new optional request property ' Pay /currencyConversion/payerAmount'
Added the new optional request property ' Pay /currencyConversion/payerCurrency'
Added the new optional request property ' Pay /posTerminal/name'
Added the new optional request property ' Pay /session'
Added the new optional request property ' Refund /posTerminal/attended'
Added the new optional request property ' Refund /posTerminal/cardholderActivated'
Added the new optional request property ' Refund /posTerminal/inputCapability'
Added the new optional request property ' Refund /posTerminal/location'
Added the new optional request property ' Refund /posTerminal/name'
Added the new optional request property ' Refund /session'
Added the new optional request property ' Verify /posTerminal'
Added the new optional request property ' Verify /session'
The ' Authorize /paymentPlan/planId' request property's maxLength was increased from '16' to '40'
The ' Pay /paymentPlan/planId' request property's maxLength was increased from '16' to '40'
Added the optional property 'constraints' to the response
Added the optional property 'currencyConversion/payerAmount' to the response
Added the optional property 'currencyConversion/payerCurrency' to the response
Added the optional property 'posTerminal/name' to the response
Added the required property 'currencyConversion/payerAcceptance' to the response

Operations

Payment Options Inquiry

Breaking changes

The 'paymentPlans/items/planId' response property's maxLength was increased from '16' to '40'
The 'paymentPlans/items/numberOfDeferrals/items/' response's property type/format changed from 'object'/'' to 'integer'/''
The 'paymentPlans/items/numberOfPayments/items/' response's property type/format changed from 'object'/'' to 'integer'/''
Removed the optional property 'paymentPlans/items/numberOfDeferrals/items/numberOfDeferral' from the response
Removed the optional property 'paymentPlans/items/numberOfPayments/items/numberOfPayment' from the response
Removed the optional property 'paymentPlans/items/type' from the response
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property

Non-Breaking changes

Added the new optional 'query' request parameter 'action.tokenOperation'
Added the new optional 'query' request parameter 'externalTokenProvider'
Added the new optional 'query' request parameter 'externalTokenProvider.customData'
Added the new optional 'query' request parameter 'session.id'
Added the new optional 'query' request parameter 'sourceOfFunds'
Added the new optional 'query' request parameter 'sourceOfFunds.provided.card'
Added the new optional 'query' request parameter 'sourceOfFunds.provided.card.p2pe.cardBin'
Added the new optional 'query' request parameter 'sourceOfFunds.provided.card.p2pe.encryptionState'
Added the new optional 'query' request parameter 'sourceOfFunds.provided.card.p2pe.initializationVector'
Added the new optional 'query' request parameter 'sourceOfFunds.provided.card.p2pe.keySerialNumber'
Added the new optional 'query' request parameter 'sourceOfFunds.provided.card.payload'
Added the new optional 'query' request parameter 'sourceOfFunds.token'
Added the optional property 'currencyConversion' to the response
Added the optional property 'paymentPlans/items/payerInterest' to the response

Operations

Create Payment Page Session , Create Session

Breaking changes

The response property ' Create Payment Page Session /session' became optional
The response property ' Create Session /session' became optional
The ' Create Payment Page Session /session' response property's maxLength was unset from '35'
The ' Create Session /session' response property's maxLength was unset from '35'
The ' Create Payment Page Session /session' response property's minLength was decreased from '31' to '0'
The ' Create Session /session' response property's minLength was decreased from '31' to '0'
The ' Create Payment Page Session /session' response's property type/format changed from 'string'/'' to 'object'/''
The ' Create Session /session' response's property type/format changed from 'string'/'' to 'object'/''
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property

Non-Breaking changes

Added the new optional request property ' Create Payment Page Session /constraints'
Added the new optional request property ' Create Payment Page Session /paymentPage/action'
Added the new optional request property ' Create Payment Page Session /transaction'
The ' Create Payment Page Session /session' response's property pattern '^[ -~]*$' was removed
The ' Create Session /session' response's property pattern '^[ -~]*$' was removed
Added the required property ' Create Payment Page Session /session/id' to the response
Added the required property ' Create Session /session/id' to the response

Operations

Open Wallet , Retrieve Session , Update Session

Breaking changes

The 'paymentPlan/planId' response property's maxLength was increased from '16' to '40'
The 'session' response property's maxLength was unset from '35'
The 'session' response property's minLength was decreased from '31' to '0'
The 'order/amount' response's property type/format changed from 'number'/'' to 'string'/''
The 'session' response's property type/format changed from 'string'/'' to 'object'/''
The 'paymentPlan/planId' response property's maxLength was increased from '16' to '40'
The 'session' response property's maxLength was unset from '35'
The 'session' response property's minLength was decreased from '31' to '0'
The 'order/amount' response's property type/format changed from 'number'/'' to 'string'/''
The 'session' response's property type/format changed from 'string'/'' to 'object'/''
The 'order/amount' request property's minLength was increased from '0' to '1'
The 'order/amount' request property type/format changed from 'number'/'' to 'string'/''
The 'paymentPlan/planId' response property's maxLength was increased from '16' to '40'
The 'session' response property's maxLength was unset from '35'
The 'session' response property's minLength was decreased from '31' to '0'
The 'order/amount' response's property type/format changed from 'number'/'' to 'string'/''
The 'session' response's property type/format changed from 'string'/'' to 'object'/''
Removed the optional property 'cancelURL' from the response
Removed the optional property 'currencyConversion/baseAmount' from the response
Removed the optional property 'currencyConversion/baseCurrency' from the response
Removed the optional property 'paymentPlan/type' from the response
Removed the optional property 'returnURL' from the response
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Removed the request property 'cancelURL'
Removed the request property 'returnURL'
Removed the optional property 'cancelURL' from the response
Removed the optional property 'currencyConversion/baseAmount' from the response
Removed the optional property 'currencyConversion/baseCurrency' from the response
Removed the optional property 'paymentPlan/type' from the response
Removed the optional property 'returnURL' from the response
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
The 'order/amount' request property's maxLength was set to '14'
Added the pattern to the request property 'order/amount'
Removed the request property 'cancelURL'
Removed the request property 'currencyConversion/baseAmount'
Removed the request property 'currencyConversion/baseCurrency'
Removed the request property 'paymentPlan/type'
Removed the request property 'returnURL'
Removed the optional property 'cancelURL' from the response
Removed the optional property 'currencyConversion/baseAmount' from the response
Removed the optional property 'currencyConversion/baseCurrency' from the response
Removed the optional property 'paymentPlan/type' from the response
Removed the optional property 'returnURL' from the response
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property

Non-Breaking changes

Added the optional property 'action/tokenOperation' to the response
Added the optional property 'constraints' to the response
Added the optional property 'currencyConversion/payerAcceptance' to the response
Added the optional property 'currencyConversion/payerAmount' to the response
Added the optional property 'currencyConversion/payerCurrency' to the response
Added the optional property 'paymentType' to the response
Added the optional property 'posTerminal/name' to the response
Added the optional property 'sourceOfFunds/provided/card/p2pe' to the response
Added the optional property 'sourceOfFunds/provided/card/payload' to the response
Added the optional property 'sourceOfFunds/provided/card/prefix' to the response
Added the optional property 'transactionSource' to the response
Added the optional property 'wallet' to the response
The 'order/amount' response's property pattern was added
The 'session' response's property pattern '^[ -~]*$' was removed
Added the required property 'session/id' to the response
Added the required property 'session/status' to the response
Added the new optional request property 'wallet'
Added the optional property 'action/tokenOperation' to the response
Added the optional property 'constraints' to the response
Added the optional property 'currencyConversion/payerAcceptance' to the response
Added the optional property 'currencyConversion/payerAmount' to the response
Added the optional property 'currencyConversion/payerCurrency' to the response
Added the optional property 'paymentType' to the response
Added the optional property 'posTerminal/name' to the response
Added the optional property 'sourceOfFunds/provided/card/p2pe' to the response
Added the optional property 'sourceOfFunds/provided/card/payload' to the response
Added the optional property 'sourceOfFunds/provided/card/prefix' to the response
Added the optional property 'transactionSource' to the response
Added the optional property 'wallet' to the response
The 'order/amount' response's property pattern was added
The 'session' response's property pattern '^[ -~]*$' was removed
Added the required property 'session/id' to the response
Added the required property 'session/status' to the response
Added the new optional request property 'action/tokenOperation'
Added the new optional request property 'constraints'
Added the new optional request property 'currencyConversion/payerAcceptance'
Added the new optional request property 'currencyConversion/payerAmount'
Added the new optional request property 'currencyConversion/payerCurrency'
Added the new optional request property 'paymentType'
Added the new optional request property 'posTerminal/name'
Added the new optional request property 'sourceOfFunds/provided/card/p2pe'
Added the new optional request property 'sourceOfFunds/provided/card/payload'
Added the new optional request property 'sourceOfFunds/provided/card/prefix'
Added the new optional request property 'transactionSource'
Added the new optional request property 'wallet'
The 'paymentPlan/planId' request property's maxLength was increased from '16' to '40'
Added the optional property 'action/tokenOperation' to the response
Added the optional property 'constraints' to the response
Added the optional property 'currencyConversion/payerAcceptance' to the response
Added the optional property 'currencyConversion/payerAmount' to the response
Added the optional property 'currencyConversion/payerCurrency' to the response
Added the optional property 'paymentType' to the response
Added the optional property 'posTerminal/name' to the response
Added the optional property 'sourceOfFunds/provided/card/p2pe' to the response
Added the optional property 'sourceOfFunds/provided/card/payload' to the response
Added the optional property 'sourceOfFunds/provided/card/prefix' to the response
Added the optional property 'transactionSource' to the response
Added the optional property 'wallet' to the response
The 'order/amount' response's property pattern was added
The 'session' response's property pattern '^[ -~]*$' was removed
Added the required property 'session/id' to the response
Added the required property 'session/status' to the response

Operations

Save Card (with system-generated token)

Breaking changes

Removed the request property 'sourceOfFunds/session'
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property

Non-Breaking changes

Added the new optional request property 'session'

Operations

Delete Token , Retrieve Card , Save Card

Breaking changes

Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Removed the request property 'sourceOfFunds/session'
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property

Non-Breaking changes

Added the new optional request property 'session'

Operations

Search Tokens

Breaking changes

Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property
Added the new 'CONSTRAINT_VIOLATION' enum value to the 'error/cause' response property

December 2013

Version 18

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'transaction/items/order/walletIndicator' to the response
Added the optional property 'transaction/items/order/walletProvider' to the response
Added the optional property 'walletIndicator' to the response
Added the optional property 'walletProvider' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Non-Breaking changes

Added the optional property 'order/walletIndicator' to the response
Added the optional property 'order/walletProvider' to the response
Added the new optional request property ' Authorize /order/walletIndicator'
Added the new optional request property ' Authorize /order/walletProvider'
Added the new optional request property ' Capture /order/walletIndicator'
Added the new optional request property ' Capture /order/walletProvider'
Added the new optional request property ' Pay /order/walletIndicator'
Added the new optional request property ' Pay /order/walletProvider'
Added the new optional request property ' Refund /order/walletIndicator'
Added the new optional request property ' Refund /order/walletProvider'
Added the new optional request property ' Verify /order/walletIndicator'
Added the new optional request property ' Verify /order/walletProvider'
Added the optional property 'order/walletIndicator' to the response
Added the optional property 'order/walletProvider' to the response

Operations

Payment Options Inquiry

Breaking changes

Deleted the 'query' request parameter 'cardType'
Deleted the 'query' request parameter 'currency'

Non-Breaking changes

Added the new optional 'query' request parameter 'order'
Added the new optional 'query' request parameter 'order.amount'
Added the new optional 'query' request parameter 'order.currency'
Added the new optional 'query' request parameter 'sourceOfFunds.provided.card.prefix'
Added the optional property 'walletProviders' to the response

Operations

Open Wallet , Retrieve Session , Update Session

Non-Breaking changes

Endpoint added

October 2013

Version 17

Operations

Retrieve Order

Breaking changes

Removed the optional property 'transaction/items/item' from the response

Non-Breaking changes

Added the new optional 'query' request parameter 'responseControls'
Added the new optional 'query' request parameter 'responseControls.sensitiveData'
Added the optional property 'notificationUrl' to the response
Added the optional property 'transaction/items/order/item' to the response
Added the optional property 'transaction/items/order/notificationUrl' to the response
Added the optional property 'transaction/items/transaction/item' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Removed the optional property 'item' from the response
Removed the request property ' Confirm /item'
Removed the request property ' Initiate /item'
Removed the optional property 'item' from the response

Non-Breaking changes

Added the new optional 'query' request parameter 'responseControls'
Added the new optional 'query' request parameter 'responseControls.sensitiveData'
Added the optional property 'order/item' to the response
Added the optional property 'order/notificationUrl' to the response
Added the optional property 'transaction/item' to the response
Added the new optional request property ' Void /responseControls'
Added the new optional request property ' Confirm /order/item'
Added the new optional request property ' Confirm /order/notificationUrl'
Added the new optional request property ' Confirm /responseControls'
Added the new optional request property ' Initiate /order/item'
Added the new optional request property ' Initiate /order/notificationUrl'
Added the new optional request property ' Initiate /responseControls'
Added the new optional request property ' Authorize /order/item'
Added the new optional request property ' Authorize /order/notificationUrl'
Added the new optional request property ' Authorize /responseControls'
Added the new optional request property ' Capture /order/notificationUrl'
Added the new optional request property ' Capture /responseControls'
Added the new optional request property ' Capture /transaction/item'
Added the new optional request property ' Pay /order/item'
Added the new optional request property ' Pay /order/notificationUrl'
Added the new optional request property ' Pay /responseControls'
Added the new optional request property ' Referral /responseControls'
Added the new optional request property ' Refund /order/notificationUrl'
Added the new optional request property ' Refund /responseControls'
Added the new optional request property ' Refund /transaction/item'
Added the new optional request property ' Update Authorization /responseControls'
Added the new optional request property ' Verify /order/notificationUrl'
Added the new optional request property ' Verify /responseControls'
Added the optional property 'order/item' to the response
Added the optional property 'order/notificationUrl' to the response
Added the optional property 'transaction/item' to the response

Operations

Plan Offers Inquiry

Non-Breaking changes

Added the new optional request property 'responseControls'

Operations

Create Payment Page Session , Create Session

Breaking changes

Added ' create_payment_page_session_response, create_session_response' to the response body 'oneOf' list
Removed the required property 'merchant' from the response
Removed the required property 'result' from the response
Removed the required property 'session' from the response
Removed the request property 'correlationId'
Removed the optional property 'correlationId' from the response

Non-Breaking changes

Api operation id 'Session: Create Session' removed and replaced with 'Session: Create Payment Page Session OR Session: Create Session'
Added ' create_payment_page_session_request, create_session_request' to the request body 'oneOf' list

Operations

Save Card (with system-generated token)

Non-Breaking changes

Added the new optional request property 'responseControls'
Added the optional property 'repositoryId' to the response
Added the optional property 'usage' to the response
Added the optional property 'verificationStrategy' to the response

Operations

Delete Token , Retrieve Card , Save Card

Non-Breaking changes

Added the new optional 'query' request parameter 'responseControls'
Added the new optional 'query' request parameter 'responseControls.sensitiveData'
Added the optional property 'repositoryId' to the response
Added the optional property 'token' to the response
Added the optional property 'verificationStrategy' to the response
Added the required property 'usage' to the response
Added the new optional request property 'responseControls'
Added the optional property 'repositoryId' to the response
Added the optional property 'usage' to the response
Added the optional property 'verificationStrategy' to the response

Operations

Search Tokens

Non-Breaking changes

Endpoint added

August 2013

Version 16

Operations

Retrieve Order

Breaking changes

The 'transaction/items/paymentPlan/numberOfDeferrals' response property's min was decreased from '1.00' to '0.00'
Added the new 'BANORTE_FULL_PAYMENT_WITH_DEFERRAL' enum value to the 'transaction/items/paymentPlan/type' response property
Added the new 'BANORTE_WITHOUT_INTEREST' enum value to the 'transaction/items/paymentPlan/type' response property
Added the new 'BANORTE_WITH_INTEREST' enum value to the 'transaction/items/paymentPlan/type' response property

Non-Breaking changes

Added the required property 'transaction/items/order/creationTime' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

The 'paymentPlan/numberOfDeferrals' response property's min was decreased from '1.00' to '0.00'
The 'paymentPlan/numberOfDeferrals' response property's min was decreased from '1.00' to '0.00'
Added the new 'BANORTE_FULL_PAYMENT_WITH_DEFERRAL' enum value to the 'paymentPlan/type' response property
Added the new 'BANORTE_WITHOUT_INTEREST' enum value to the 'paymentPlan/type' response property
Added the new 'BANORTE_WITH_INTEREST' enum value to the 'paymentPlan/type' response property
Added the new 'BANORTE_FULL_PAYMENT_WITH_DEFERRAL' enum value to the 'paymentPlan/type' response property
Added the new 'BANORTE_WITHOUT_INTEREST' enum value to the 'paymentPlan/type' response property
Added the new 'BANORTE_WITH_INTEREST' enum value to the 'paymentPlan/type' response property

Non-Breaking changes

Added the required property 'order/creationTime' to the response
Added the new optional request property ' Confirm /customer'
Added the new optional request property ' Initiate /customer'
Added the new optional request property ' Capture /customer'
Added the new optional request property ' Refund /customer'
Added the new 'BANORTE_FULL_PAYMENT_WITH_DEFERRAL' enum value to the request property ' Authorize /paymentPlan/type'
Added the new 'BANORTE_FULL_PAYMENT_WITH_DEFERRAL' enum value to the request property ' Pay /paymentPlan/type'
Added the new 'BANORTE_WITHOUT_INTEREST' enum value to the request property ' Authorize /paymentPlan/type'
Added the new 'BANORTE_WITHOUT_INTEREST' enum value to the request property ' Pay /paymentPlan/type'
Added the new 'BANORTE_WITH_INTEREST' enum value to the request property ' Authorize /paymentPlan/type'
Added the new 'BANORTE_WITH_INTEREST' enum value to the request property ' Pay /paymentPlan/type'
The ' Authorize /paymentPlan/numberOfDeferrals' request property's min was decreased from '1.00' to '0.00'
The ' Pay /paymentPlan/numberOfDeferrals' request property's min was decreased from '1.00' to '0.00'
Added the required property 'order/creationTime' to the response

Operations

Payment Options Inquiry

Breaking changes

Added the new 'BANORTE_FULL_PAYMENT_WITH_DEFERRAL' enum value to the 'paymentPlans/items/type' response property
Added the new 'BANORTE_WITHOUT_INTEREST' enum value to the 'paymentPlans/items/type' response property
Added the new 'BANORTE_WITH_INTEREST' enum value to the 'paymentPlans/items/type' response property

May 2013

Version 15

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/card/localBrand' to the response
Added the optional property 'transaction/items/sourceOfFunds/provided/card/localBrand' to the response
Added the required property 'sourceOfFunds/provided/card/brand' to the response
Added the required property 'sourceOfFunds/provided/card/fundingMethod' to the response
Added the required property 'transaction/items/sourceOfFunds/provided/card/brand' to the response
Added the required property 'transaction/items/sourceOfFunds/provided/card/fundingMethod' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/card/localBrand' to the response
Added the required property 'sourceOfFunds/provided/card/brand' to the response
Added the required property 'sourceOfFunds/provided/card/fundingMethod' to the response
Added the new optional request property ' Authorize /order/description'
Added the new optional request property ' Authorize /order/itemAmount'
Added the new optional request property ' Authorize /order/shippingAndHandlingAmount'
Added the new optional request property ' Pay /order/description'
Added the new optional request property ' Pay /order/itemAmount'
Added the new optional request property ' Pay /order/shippingAndHandlingAmount'
Added the optional property 'sourceOfFunds/provided/card/localBrand' to the response
Added the required property 'sourceOfFunds/provided/card/brand' to the response
Added the required property 'sourceOfFunds/provided/card/fundingMethod' to the response

Operations

Save Card (with system-generated token)

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/card/localBrand' to the response
Added the required property 'sourceOfFunds/provided/card/brand' to the response
Added the required property 'sourceOfFunds/provided/card/fundingMethod' to the response

Operations

Delete Token , Retrieve Card , Save Card

Non-Breaking changes

Added the optional property 'sourceOfFunds/provided/card/localBrand' to the response
Added the required property 'sourceOfFunds/provided/card/brand' to the response
Added the required property 'sourceOfFunds/provided/card/fundingMethod' to the response
Added the optional property 'sourceOfFunds/provided/card/localBrand' to the response
Added the required property 'sourceOfFunds/provided/card/brand' to the response
Added the required property 'sourceOfFunds/provided/card/fundingMethod' to the response

April 2013

Version 14

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'status' to the response
Added the optional property 'transaction/items/order/status' to the response
Added the optional property 'transaction/items/transaction/acquirer/merchantId' to the response
Added the optional property 'transaction/items/version' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Non-Breaking changes

Added the optional property 'order/status' to the response
Added the optional property 'transaction/acquirer/merchantId' to the response
Added the optional property 'version' to the response
Added the optional property 'order/status' to the response
Added the optional property 'transaction/acquirer/merchantId' to the response
Added the optional property 'version' to the response

Operations

Payment Options Inquiry

Non-Breaking changes

Added the required property 'transactionMode' to the response

March 2013

Version 13

Operations

Retrieve Order

Non-Breaking changes

Added the optional property 'custom' to the response
Added the optional property 'customerNote' to the response
Added the optional property 'transaction/items/order/custom' to the response
Added the optional property 'transaction/items/order/customerNote' to the response
Added the optional property 'transaction/items/transaction/merchantNote' to the response

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Non-Breaking changes

Added the optional property 'order/custom' to the response
Added the optional property 'order/customerNote' to the response
Added the optional property 'transaction/merchantNote' to the response
Added the new optional request property ' Void /order'
Added the new optional request property ' Void /transaction/merchantNote'
Added the new optional request property ' Confirm /order/custom'
Added the new optional request property ' Confirm /order/customerNote'
Added the new optional request property ' Confirm /transaction/merchantNote'
Added the new optional request property ' Initiate /order/custom'
Added the new optional request property ' Initiate /order/customerNote'
Added the new optional request property ' Initiate /transaction/merchantNote'
Added the new optional request property ' Authorize /order/custom'
Added the new optional request property ' Authorize /order/customerNote'
Added the new optional request property ' Authorize /transaction/merchantNote'
Added the new optional request property ' Capture /order/custom'
Added the new optional request property ' Capture /order/customerNote'
Added the new optional request property ' Capture /transaction/merchantNote'
Added the new optional request property ' Pay /order/custom'
Added the new optional request property ' Pay /order/customerNote'
Added the new optional request property ' Pay /transaction/merchantNote'
Added the new optional request property ' Referral /order'
Added the new optional request property ' Referral /transaction/merchantNote'
Added the new optional request property ' Refund /order/custom'
Added the new optional request property ' Refund /order/customerNote'
Added the new optional request property ' Refund /transaction/merchantNote'
Added the new optional request property ' Update Authorization /order/custom'
Added the new optional request property ' Update Authorization /transaction/merchantNote'
Added the new optional request property ' Verify /order/custom'
Added the new optional request property ' Verify /order/customerNote'
Added the new optional request property ' Verify /transaction/merchantNote'
Added the optional property 'order/custom' to the response
Added the optional property 'order/customerNote' to the response
Added the optional property 'transaction/merchantNote' to the response

January 2013

Version 12

Operations

Retrieve Order

Breaking changes

Removed the optional property 'risk/reversalTransactionResult' from the response
Removed the optional property 'risk/reviewResult' from the response
Removed the optional property 'transaction/items/response/risk/reversalTransactionResult' from the response
Removed the optional property 'transaction/items/response/risk/reviewResult' from the response
Removed the optional property 'transaction/items/transaction/batch' from the response
Added the new 'ACCEPTED' enum value to the 'risk/gatewayCode' response property
Added the new 'ACCEPTED' enum value to the 'transaction/items/response/risk/gatewayCode' response property
Added the new 'REJECTED' enum value to the 'risk/gatewayCode' response property
Added the new 'REJECTED' enum value to the 'transaction/items/response/risk/gatewayCode' response property
Added the new 'REVIEW_REQUIRED' enum value to the 'risk/gatewayCode' response property
Added the new 'REVIEW_REQUIRED' enum value to the 'transaction/items/response/risk/gatewayCode' response property

Non-Breaking changes

Added the optional property 'customerOrderDate' to the response
Added the optional property 'customerReference' to the response
Added the optional property 'requestorName' to the response
Added the optional property 'risk/reversalResult' to the response
Added the optional property 'risk/review' to the response
Added the optional property 'risk/rule' to the response
Added the optional property 'risk/totalScore' to the response
Added the optional property 'sourceOfFunds/token' to the response
Added the optional property 'taxRegistrationId' to the response
Added the optional property 'transaction/items/gatewayEntryPoint' to the response
Added the optional property 'transaction/items/partnerSolutionId' to the response
Added the optional property 'transaction/items/response/risk/reversalResult' to the response
Added the optional property 'transaction/items/response/risk/review' to the response
Added the optional property 'transaction/items/response/risk/rule' to the response
Added the optional property 'transaction/items/response/risk/totalScore' to the response
Added the optional property 'transaction/items/sourceOfFunds/token' to the response
Added the optional property 'transaction/items/transaction/acquirer/batch' to the response
Added the optional property 'transaction/items/transaction/batchName' to the response
Added the optional property 'transaction/items/userId' to the response
Removed the 'ACCEPT' enum value from the 'risk/gatewayCode' response property
Removed the 'ACCEPT' enum value from the 'transaction/items/response/risk/gatewayCode' response property
Removed the 'REJECT' enum value from the 'risk/gatewayCode' response property
Removed the 'REJECT' enum value from the 'transaction/items/response/risk/gatewayCode' response property
Removed the 'REVIEW' enum value from the 'risk/gatewayCode' response property
Removed the 'REVIEW' enum value from the 'transaction/items/response/risk/gatewayCode' response property
Removed the 'SYSTEM_REJECT' enum value from the 'risk/gatewayCode' response property
Removed the 'SYSTEM_REJECT' enum value from the 'transaction/items/response/risk/gatewayCode' response property

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

Removed the optional property 'response/risk/reversalTransactionResult' from the response
Removed the optional property 'response/risk/reviewResult' from the response
Removed the optional property 'transaction/batch' from the response
Added the new 'ACCEPTED' enum value to the 'response/risk/gatewayCode' response property
Added the new 'REJECTED' enum value to the 'response/risk/gatewayCode' response property
Added the new 'REVIEW_REQUIRED' enum value to the 'response/risk/gatewayCode' response property
Removed the optional property 'response/risk/reversalTransactionResult' from the response
Removed the optional property 'response/risk/reviewResult' from the response
Removed the optional property 'transaction/batch' from the response
Added the new 'ACCEPTED' enum value to the 'response/risk/gatewayCode' response property
Added the new 'REJECTED' enum value to the 'response/risk/gatewayCode' response property
Added the new 'REVIEW_REQUIRED' enum value to the 'response/risk/gatewayCode' response property

Non-Breaking changes

Added the optional property 'gatewayEntryPoint' to the response
Added the optional property 'partnerSolutionId' to the response
Added the optional property 'response/risk/reversalResult' to the response
Added the optional property 'response/risk/review' to the response
Added the optional property 'response/risk/rule' to the response
Added the optional property 'response/risk/totalScore' to the response
Added the optional property 'sourceOfFunds/token' to the response
Added the optional property 'transaction/acquirer/batch' to the response
Added the optional property 'transaction/batchName' to the response
Added the optional property 'userId' to the response
Removed the 'ACCEPT' enum value from the 'response/risk/gatewayCode' response property
Removed the 'REJECT' enum value from the 'response/risk/gatewayCode' response property
Removed the 'REVIEW' enum value from the 'response/risk/gatewayCode' response property
Removed the 'SYSTEM_REJECT' enum value from the 'response/risk/gatewayCode' response property
Added the new optional request property ' Void /partnerSolutionId'
Added the new optional request property ' Void /userId'
Added the new optional request property ' Confirm /partnerSolutionId'
Added the new optional request property ' Initiate /partnerSolutionId'
Added the new optional request property ' Authorize /partnerSolutionId'
Added the new optional request property ' Authorize /userId'
Added the new optional request property ' Capture /partnerSolutionId'
Added the new optional request property ' Capture /userId'
Added the new optional request property ' Pay /partnerSolutionId'
Added the new optional request property ' Pay /userId'
Added the new optional request property ' Referral /partnerSolutionId'
Added the new optional request property ' Referral /userId'
Added the new optional request property ' Refund /partnerSolutionId'
Added the new optional request property ' Refund /userId'
Added the new optional request property ' Update Authorization /partnerSolutionId'
Added the new optional request property ' Update Authorization /userId'
Added the new optional request property ' Verify /partnerSolutionId'
Added the new optional request property ' Verify /userId'
Added the optional property 'gatewayEntryPoint' to the response
Added the optional property 'partnerSolutionId' to the response
Added the optional property 'response/risk/reversalResult' to the response
Added the optional property 'response/risk/review' to the response
Added the optional property 'response/risk/rule' to the response
Added the optional property 'response/risk/totalScore' to the response
Added the optional property 'sourceOfFunds/token' to the response
Added the optional property 'transaction/acquirer/batch' to the response
Added the optional property 'transaction/batchName' to the response
Added the optional property 'userId' to the response
Removed the 'ACCEPT' enum value from the 'response/risk/gatewayCode' response property
Removed the 'REJECT' enum value from the 'response/risk/gatewayCode' response property
Removed the 'REVIEW' enum value from the 'response/risk/gatewayCode' response property
Removed the 'SYSTEM_REJECT' enum value from the 'response/risk/gatewayCode' response property

November 2012

Version 11

Operations

Retrieve Order

Non-Breaking changes

Endpoint added

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Update Authorization , Verify , Void

Breaking changes

The 'timeOfRecord' response property's maxLength was unset from '29'
The 'timeOfRecord' response's property type/format changed from 'string'/'' to 'string'/'date-time'
Added the new required request property ' Initiate /order/amount'
Added the new required request property ' Initiate /order/currency'
The request property ' Initiate /order' became required
The 'timeOfRecord' response property's maxLength was unset from '29'
The 'timeOfRecord' response's property type/format changed from 'string'/'' to 'string'/'date-time'
Removed the optional property 'order/item' from the response
Removed the optional property 'shipping/fullName' from the response
Removed the optional property 'shipping/middleName' from the response
Removed the optional property 'shipping/title' from the response
Removed the optional property 'sourceOfFunds/provided/card/holder/fullName' from the response
Removed the optional property 'sourceOfFunds/provided/card/holder/middleName' from the response
Removed the optional property 'sourceOfFunds/provided/card/holder/title' from the response
Removed the optional property 'sourceOfFunds/provided/paypal/customerEmail' from the response
Removed the optional property 'transaction/customerReference' from the response
Removed the optional property 'transaction/tax' from the response
Added the new 'AUTHORIZATION_UPDATE' enum value to the 'transaction/type' response property
Added the new 'CIELO' enum value to the 'paymentPlan/type' response property
Added the new 'REDECARD' enum value to the 'paymentPlan/type' response property
Removed the request property ' Confirm /transaction/amount'
Removed the request property ' Confirm /transaction/currency'
Removed the request property ' Initiate /order/item'
Removed the request property ' Initiate /shipping/fullName'
Removed the request property ' Initiate /shipping/middleName'
Removed the request property ' Initiate /shipping/title'
Removed the request property ' Initiate /transaction/amount'
Removed the request property ' Initiate /transaction/currency'
Removed the request property ' Authorize /shipping/fullName'
Removed the request property ' Authorize /shipping/middleName'
Removed the request property ' Authorize /shipping/title'
Removed the request property ' Authorize /sourceOfFunds/provided/card/holder/fullName'
Removed the request property ' Authorize /sourceOfFunds/provided/card/holder/middleName'
Removed the request property ' Authorize /sourceOfFunds/provided/card/holder/title'
Removed the request property ' Authorize /transaction/customerReference'
Removed the request property ' Authorize /transaction/tax'
Removed the request property ' Capture /transaction/customerReference'
Removed the request property ' Capture /transaction/tax'
Removed the request property ' Pay /shipping/fullName'
Removed the request property ' Pay /shipping/middleName'
Removed the request property ' Pay /shipping/title'
Removed the request property ' Pay /sourceOfFunds/provided/card/holder/fullName'
Removed the request property ' Pay /sourceOfFunds/provided/card/holder/middleName'
Removed the request property ' Pay /sourceOfFunds/provided/card/holder/title'
Removed the request property ' Pay /transaction/customerReference'
Removed the request property ' Pay /transaction/tax'
Removed the request property ' Refund /transaction/customerReference'
Removed the request property ' Refund /transaction/tax'
Removed the request property ' Verify /shipping/fullName'
Removed the request property ' Verify /shipping/middleName'
Removed the request property ' Verify /shipping/title'
Removed the request property ' Verify /sourceOfFunds/provided/card/holder/fullName'
Removed the request property ' Verify /sourceOfFunds/provided/card/holder/middleName'
Removed the request property ' Verify /sourceOfFunds/provided/card/holder/title'
Removed the optional property 'order/item' from the response
Removed the optional property 'shipping/fullName' from the response
Removed the optional property 'shipping/middleName' from the response
Removed the optional property 'shipping/title' from the response
Removed the optional property 'sourceOfFunds/provided/card/holder/fullName' from the response
Removed the optional property 'sourceOfFunds/provided/card/holder/middleName' from the response
Removed the optional property 'sourceOfFunds/provided/card/holder/title' from the response
Removed the optional property 'sourceOfFunds/provided/paypal/customerEmail' from the response
Removed the optional property 'transaction/customerReference' from the response
Removed the optional property 'transaction/tax' from the response
Added the new 'AUTHORIZATION_UPDATE' enum value to the 'transaction/type' response property
Added the new 'CIELO' enum value to the 'paymentPlan/type' response property
Added the new 'REDECARD' enum value to the 'paymentPlan/type' response property

Non-Breaking changes

Added the optional property 'browserPayment/paypal/displayShippingAddress' to the response
Added the optional property 'browserPayment/paypal/overrideShippingAddress' to the response
Added the optional property 'item' to the response
Added the optional property 'order/customerOrderDate' to the response
Added the optional property 'order/customerReference' to the response
Added the optional property 'order/description' to the response
Added the optional property 'order/itemAmount' to the response
Added the optional property 'order/requestorName' to the response
Added the optional property 'order/shippingAndHandlingAmount' to the response
Added the optional property 'order/taxAmount' to the response
Added the optional property 'order/taxRegistrationId' to the response
Added the optional property 'sourceOfFunds/provided/paypal/accountEmail' to the response
Added the optional property 'sourceOfFunds/provided/paypal/accountHolder' to the response
Added the optional property 'transaction/taxAmount' to the response
The 'timeOfRecord' response's property pattern '^[ -~]*$' was removed
Added the required property 'order/amount' to the response
Added the required property 'order/currency' to the response
Api operation id 'Browser Payment: Confirm OR Browser Payment: Initiate OR Transaction: Authorize OR Transaction: Capture OR Transaction: Pay OR Transaction: Referral OR Transaction: Refund OR Transaction: Verify OR Transaction: Void' removed and replaced with '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'
Added the new optional request property ' Confirm /item'
Added the new optional request property ' Confirm /order/amount'
Added the new optional request property ' Confirm /order/currency'
Added the new optional request property ' Confirm /order/description'
Added the new optional request property ' Confirm /order/itemAmount'
Added the new optional request property ' Confirm /order/shippingAndHandlingAmount'
Added the new optional request property ' Confirm /order/taxAmount'
Added the new optional request property ' Initiate /item'
Added the new optional request property ' Initiate /order/description'
Added the new optional request property ' Initiate /order/itemAmount'
Added the new optional request property ' Initiate /order/shippingAndHandlingAmount'
Added the new optional request property ' Initiate /order/taxAmount'
Added the new optional request property ' Authorize /order/customerOrderDate'
Added the new optional request property ' Authorize /order/customerReference'
Added the new optional request property ' Authorize /order/requestorName'
Added the new optional request property ' Authorize /order/taxAmount'
Added the new optional request property ' Authorize /order/taxRegistrationId'
Added the new optional request property ' Capture /billing'
Added the new optional request property ' Capture /order/customerOrderDate'
Added the new optional request property ' Capture /order/customerReference'
Added the new optional request property ' Capture /order/productSKU'
Added the new optional request property ' Capture /order/requestorName'
Added the new optional request property ' Capture /order/taxRegistrationId'
Added the new optional request property ' Capture /shipping'
Added the new optional request property ' Capture /sourceOfFunds/provided/card/holder'
Added the new optional request property ' Capture /transaction/taxAmount'
Added the new optional request property ' Pay /order/customerOrderDate'
Added the new optional request property ' Pay /order/customerReference'
Added the new optional request property ' Pay /order/requestorName'
Added the new optional request property ' Pay /order/taxAmount'
Added the new optional request property ' Pay /order/taxRegistrationId'
Added the new optional request property ' Refund /billing'
Added the new optional request property ' Refund /order/customerOrderDate'
Added the new optional request property ' Refund /order/customerReference'
Added the new optional request property ' Refund /order/productSKU'
Added the new optional request property ' Refund /order/requestorName'
Added the new optional request property ' Refund /order/taxRegistrationId'
Added the new optional request property ' Refund /shipping'
Added the new optional request property ' Refund /sourceOfFunds/provided/card/holder'
Added the new optional request property ' Refund /transaction/taxAmount'
Added ' update_authorization_request' to the request body 'oneOf' list
The request property ' Initiate /transaction' became optional
Added the new 'CIELO' enum value to the request property ' Authorize /paymentPlan/type'
Added the new 'CIELO' enum value to the request property ' Pay /paymentPlan/type'
Added the new 'REDECARD' enum value to the request property ' Authorize /paymentPlan/type'
Added the new 'REDECARD' enum value to the request property ' Pay /paymentPlan/type'
Added the optional property 'browserPayment/paypal/displayShippingAddress' to the response
Added the optional property 'browserPayment/paypal/overrideShippingAddress' to the response
Added the optional property 'item' to the response
Added the optional property 'order/customerOrderDate' to the response
Added the optional property 'order/customerReference' to the response
Added the optional property 'order/description' to the response
Added the optional property 'order/itemAmount' to the response
Added the optional property 'order/requestorName' to the response
Added the optional property 'order/shippingAndHandlingAmount' to the response
Added the optional property 'order/taxAmount' to the response
Added the optional property 'order/taxRegistrationId' to the response
Added the optional property 'sourceOfFunds/provided/paypal/accountEmail' to the response
Added the optional property 'sourceOfFunds/provided/paypal/accountHolder' to the response
Added the optional property 'transaction/taxAmount' to the response
The 'timeOfRecord' response's property pattern '^[ -~]*$' was removed
Added the required property 'order/amount' to the response
Added the required property 'order/currency' to the response

Operations

Payment Options Inquiry

Breaking changes

Added the new 'CIELO' enum value to the 'paymentPlans/items/type' response property
Added the new 'REDECARD' enum value to the 'paymentPlans/items/type' response property

August 2012

Version 10

Operations

Retrieve Transaction , Confirm , Initiate , Authorize , Capture , Pay , Referral , Refund , Verify , Void

Breaking changes

For the 'path' request parameter 'orderid', the minLength was increased from '0' to '1'
The 'order/id' response's property type/format changed from 'integer'/'' to 'string'/''
For the 'path' request parameter 'orderid', the minLength was increased from '0' to '1'
Removed the success response
For the 'path' request parameter 'orderid', the maxLength was set to '40'
Added the new 'BANCANET' enum value to the 'sourceOfFunds/type' response property
Added the new 'PAYPAL' enum value to the 'sourceOfFunds/type' response property
For the 'path' request parameter 'orderid', the maxLength was set to '40'

Non-Breaking changes

For the 'path' request parameter 'orderid', the type/format was generalized from 'integer'/'' to 'string'/''
Added the optional property 'billing/address/street2' to the response
Added the optional property 'browserPayment/interaction' to the response
Added the optional property 'browserPayment/paypal' to the response
Added the optional property 'order/item' to the response
Added the optional property 'shipping/address/street2' to the response
Added the optional property 'sourceOfFunds/provided/paypal' to the response
Added the optional property 'transaction/bancanet' to the response
Api operation id 'Browser Payment: Initiate OR Transaction: Authorize OR Transaction: Capture OR Transaction: Pay OR Transaction: Referral OR Transaction: Refund OR Transaction: Verify OR Transaction: Void' removed and replaced with 'Browser Payment: Confirm OR Browser Payment: Initiate OR Transaction: Authorize OR Transaction: Capture OR Transaction: Pay OR Transaction: Referral OR Transaction: Refund OR Transaction: Verify OR Transaction: Void'
Added the new optional request property ' Initiate /browserPayment/paypal'
Added the new optional request property ' Initiate /order/item'
Added the new optional request property ' Initiate /shipping'
Added the new optional request property ' Initiate /transaction/bancanet'
Added the new optional request property ' Authorize /billing/address/street2'
Added the new optional request property ' Authorize /shipping/address/street2'
Added the new optional request property ' Pay /billing/address/street2'
Added the new optional request property ' Pay /shipping/address/street2'
Added the new optional request property ' Refund /transaction/targetTransactionId'
Added the new optional request property ' Verify /billing/address/street2'
Added the new optional request property ' Verify /shipping/address/street2'
Added ' confirm_browser_payment_request' to the request body 'oneOf' list
For the 'path' request parameter 'orderid', the type/format was generalized from 'integer'/'' to 'string'/''
Added the new 'BANCANET' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the new 'PAYPAL' enum value to the request property ' Initiate /sourceOfFunds/type'
Added the success response

Operations

Payment Options Inquiry

Breaking changes

Added the new 'BANCANET' enum value to the 'paymentTypes/items/paymentType' response property
Added the new 'GIROPAY' enum value to the 'paymentTypes/items/paymentType' response property
Added the new 'SOFORT' enum value to the 'paymentTypes/items/paymentType' response property

Non-Breaking changes

Added the new enum value 'BANCANET' to the 'query' request parameter 'paymentType'
Added the new enum value 'GIROPAY' to the 'query' request parameter 'paymentType'
Added the new enum value 'SOFORT' to the 'query' request parameter 'paymentType'

March 2012

Version 9

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Breaking changes

Added the new required request property 'sourceOfFunds'
Removed the request property 'cardDetails'

Non-Breaking changes

Added the new optional request property 'externalTokenProvider'

Operations

Retrieve Transaction , Initiate , Authorize , Capture , Pay , Referral , Refund , Verify , Void

Breaking changes

Added the new required request property ' Authorize /sourceOfFunds'
Added the new required request property ' Pay /sourceOfFunds'
Added the new required request property ' Verify /sourceOfFunds'
Removed the optional property 'card' from the response
Removed the request property ' Authorize /cardDetails'
Removed the request property ' Capture /cardDetails'
Removed the request property ' Pay /cardDetails'
Removed the request property ' Refund /cardDetails'
Removed the request property ' Verify /cardDetails'
Removed the optional property 'card' from the response

Non-Breaking changes

Added the optional property 'browserPayment' to the response
Added the optional property 'sourceOfFunds' to the response
Added the optional property 'timeOfRecord' to the response
Api operation id 'Transaction: Authorize OR Transaction: Capture OR Transaction: Pay OR Transaction: Referral OR Transaction: Refund OR Transaction: Verify OR Transaction: Void' removed and replaced with 'Browser Payment: Initiate OR Transaction: Authorize OR Transaction: Capture OR Transaction: Pay OR Transaction: Referral OR Transaction: Refund OR Transaction: Verify OR Transaction: Void'
Api tag 'Browser Payment' added
Added the new optional request property ' Authorize /externalTokenProvider'
Added the new optional request property ' Capture /externalTokenProvider'
Added the new optional request property ' Capture /sourceOfFunds'
Added the new optional request property ' Pay /externalTokenProvider'
Added the new optional request property ' Refund /externalTokenProvider'
Added the new optional request property ' Refund /sourceOfFunds'
Added the new optional request property ' Verify /externalTokenProvider'
Added ' initiate_browser_payment_request' to the request body 'oneOf' list
Added the optional property 'browserPayment' to the response
Added the optional property 'sourceOfFunds' to the response
Added the optional property 'timeOfRecord' to the response

Operations

Plan Offers Inquiry

Breaking changes

Added the new required request property 'sourceOfFunds'
Removed the required property 'card' from the response
Removed the request property 'cardDetails'

Non-Breaking changes

Added the new optional request property 'externalTokenProvider'
Added the required property 'sourceOfFunds' to the response

Operations

Save Card (with system-generated token)

Breaking changes

Added the new required request property 'sourceOfFunds'
Removed the request property 'cardDetails'
Removed the optional property 'card' from the response
Removed the optional property 'cardToken' from the response
Added the new 'EXTERNAL_VERIFICATION_BLOCKED' enum value to the 'response/gatewayCode' response property
Added the new 'EXTERNAL_VERIFICATION_DECLINED' enum value to the 'response/gatewayCode' response property
Added the new 'EXTERNAL_VERIFICATION_DECLINED_AUTHENTICATION_REQUIRED' enum value to the 'response/gatewayCode' response property
Added the new 'EXTERNAL_VERIFICATION_DECLINED_EXPIRED_CARD' enum value to the 'response/gatewayCode' response property
Added the new 'EXTERNAL_VERIFICATION_DECLINED_INVALID_CSC' enum value to the 'response/gatewayCode' response property
Added the new 'EXTERNAL_VERIFICATION_PROCESSING_ERROR' enum value to the 'response/gatewayCode' response property
Added the new 'EXTERNAL_VERIFICATION_SUCCESSFUL' enum value to the 'response/gatewayCode' response property

Non-Breaking changes

Added the new optional request property 'externalTokenProvider'
Added the optional property 'externalTokenProvider' to the response
Added the optional property 'sourceOfFunds' to the response
Added the optional property 'token' to the response
Removed the 'ACQUIRER_VERIFICATION_BLOCKED' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_VERIFICATION_DECLINED' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_VERIFICATION_DECLINED_AUTHENTICATION_REQUIRED' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_VERIFICATION_DECLINED_EXPIRED_CARD' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_VERIFICATION_DECLINED_INVALID_CSC' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_VERIFICATION_PROCESSING_ERROR' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_VERIFICATION_SUCCESSFUL' enum value from the 'response/gatewayCode' response property

Operations

Delete Token , Retrieve Card , Save Card

Breaking changes

Added the new required request property 'sourceOfFunds'
Removed the optional property 'card' from the response
Removed the request property 'cardDetails'
Removed the optional property 'card' from the response
Removed the optional property 'cardToken' from the response
Added the new 'EXTERNAL_VERIFICATION_BLOCKED' enum value to the 'response/gatewayCode' response property
Added the new 'EXTERNAL_VERIFICATION_DECLINED' enum value to the 'response/gatewayCode' response property
Added the new 'EXTERNAL_VERIFICATION_DECLINED_AUTHENTICATION_REQUIRED' enum value to the 'response/gatewayCode' response property
Added the new 'EXTERNAL_VERIFICATION_DECLINED_EXPIRED_CARD' enum value to the 'response/gatewayCode' response property
Added the new 'EXTERNAL_VERIFICATION_DECLINED_INVALID_CSC' enum value to the 'response/gatewayCode' response property
Added the new 'EXTERNAL_VERIFICATION_PROCESSING_ERROR' enum value to the 'response/gatewayCode' response property
Added the new 'EXTERNAL_VERIFICATION_SUCCESSFUL' enum value to the 'response/gatewayCode' response property

Non-Breaking changes

Added the new optional 'query' request parameter 'externalTokenProvider'
Added the new optional 'query' request parameter 'externalTokenProvider.customData'
Added the new optional 'query' request parameter 'externalTokenProvider'
Added the new optional 'query' request parameter 'externalTokenProvider.customData'
Added the optional property 'externalTokenProvider' to the response
Added the optional property 'sourceOfFunds' to the response
Added the new optional request property 'externalTokenProvider'
Added the optional property 'externalTokenProvider' to the response
Added the optional property 'sourceOfFunds' to the response
Added the optional property 'token' to the response
Removed the 'ACQUIRER_VERIFICATION_BLOCKED' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_VERIFICATION_DECLINED' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_VERIFICATION_DECLINED_AUTHENTICATION_REQUIRED' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_VERIFICATION_DECLINED_EXPIRED_CARD' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_VERIFICATION_DECLINED_INVALID_CSC' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_VERIFICATION_PROCESSING_ERROR' enum value from the 'response/gatewayCode' response property
Removed the 'ACQUIRER_VERIFICATION_SUCCESSFUL' enum value from the 'response/gatewayCode' response property

December 2011

Version 8

Operations

Verify

Non-Breaking changes

Added the new optional request property ' Verify /cardDetails/card/holder/fullName'
Added the new optional request property ' Verify /cardDetails/card/holder/middleName'
Added the new optional request property ' Verify /cardDetails/card/holder/title'
Added the new optional request property ' Verify /customer/ani'
Added the new optional request property ' Verify /customer/aniCallType'
Added the new optional request property ' Verify /customer/browser'
Added the new optional request property ' Verify /customer/hostname'
Added the new optional request property ' Verify /customer/ipAddress'
Added the new optional request property ' Verify /order/productSKU'
Added the new optional request property ' Verify /shipping/fullName'
Added the new optional request property ' Verify /shipping/method'
Added the new optional request property ' Verify /shipping/middleName'
Added the new optional request property ' Verify /shipping/title'
Added the new optional request property ' Verify /transaction/amount'
Added the new optional request property ' Verify /transaction/frequency'

Operations

Payment Options Inquiry

Non-Breaking changes

Endpoint added

October 2011

Version 7

Operations

Retrieve Transaction , Authorize , Capture , Pay , Referral , Refund , Verify , Void

Breaking changes

Removed the enum value 'REFUND' of the request property ' Capture /airline/transactionType'
Removed the enum value 'REVERSAL' of the request property ' Capture /airline/transactionType'
Removed the optional property 'response/avs' from the response
Added the new 'VERIFICATION' enum value to the 'transaction/type' response property
Removed the optional property 'response/avs' from the response
Added the new 'VERIFICATION' enum value to the 'transaction/type' response property

Non-Breaking changes

Added the optional property 'response/cardholderVerification' to the response
Added the optional property 'transaction/customerReference' to the response
Api operation id 'Transaction: Authorize OR Transaction: Capture OR Transaction: Pay OR Transaction: Referral OR Transaction: Refund OR Transaction: Void' removed and replaced with 'Transaction: Authorize OR Transaction: Capture OR Transaction: Pay OR Transaction: Referral OR Transaction: Refund OR Transaction: Verify OR Transaction: Void'
Added the new optional request property ' Authorize /transaction/customerReference'
Added the new optional request property ' Capture /transaction/customerReference'
Added the new optional request property ' Pay /transaction/customerReference'
Added the new optional request property ' Refund /airline'
Added the new optional request property ' Refund /transaction/customerReference'
Added ' verify_request' to the request body 'oneOf' list
Added the optional property 'response/cardholderVerification' to the response
Added the optional property 'transaction/customerReference' to the response

June 2011

Version 6

Operations

Check Gateway

Non-Breaking changes

Added the optional property 'error/field' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/validationType' to the response

Operations

Process ACS Result , Retrieve ThreeDS Result , Check ThreeDS Enrollment

Non-Breaking changes

Added the optional property 'error/field' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/validationType' to the response

Operations

Close Batch

Non-Breaking changes

Added the optional property 'error/field' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/validationType' to the response

Operations

Retrieve Transaction , Authorize , Capture , Pay , Referral , Refund , Void

Non-Breaking changes

Added the optional property 'customer/ani' to the response
Added the optional property 'customer/aniCallType' to the response
Added the optional property 'customer/browser' to the response
Added the optional property 'customer/hostname' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'order/productSKU' to the response
Added the optional property 'paymentPlan' to the response
Added the optional property 'transaction/acquirer/customData' to the response
Added the new optional request property ' Authorize /customer/ani'
Added the new optional request property ' Authorize /customer/aniCallType'
Added the new optional request property ' Authorize /customer/browser'
Added the new optional request property ' Authorize /customer/hostname'
Added the new optional request property ' Authorize /order/productSKU'
Added the new optional request property ' Authorize /paymentPlan'
Added the new optional request property ' Authorize /transaction/acquirer'
Added the new optional request property ' Capture /transaction/acquirer'
Added the new optional request property ' Pay /customer/ani'
Added the new optional request property ' Pay /customer/aniCallType'
Added the new optional request property ' Pay /customer/browser'
Added the new optional request property ' Pay /customer/hostname'
Added the new optional request property ' Pay /order/productSKU'
Added the new optional request property ' Pay /paymentPlan'
Added the new optional request property ' Pay /transaction/acquirer'
Added the new optional request property ' Refund /transaction/acquirer'
Added the optional property 'customer/ani' to the response
Added the optional property 'customer/aniCallType' to the response
Added the optional property 'customer/browser' to the response
Added the optional property 'customer/hostname' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'order/productSKU' to the response
Added the optional property 'paymentPlan' to the response
Added the optional property 'transaction/acquirer/customData' to the response

Operations

Plan Offers Inquiry

Non-Breaking changes

Endpoint added

Operations

Create Session

Non-Breaking changes

Added the optional property 'error/field' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/validationType' to the response

Operations

Save Card (with system-generated token)

Non-Breaking changes

Added the optional property 'error/field' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/validationType' to the response

Operations

Delete Token , Retrieve Card , Save Card

Non-Breaking changes

Added the optional property 'error/field' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/field' to the response
Added the optional property 'error/validationType' to the response
Added the optional property 'error/validationType' to the response

January 2011

Version 5

Operations

Retrieve Transaction , Authorize , Capture , Pay , Referral , Refund , Void

Non-Breaking changes

Added the optional property 'airline' to the response
Added the optional property 'currencyConversion' to the response
Added the optional property 'customer' to the response
Added the new optional request property ' Authorize /airline'
Added the new optional request property ' Authorize /currencyConversion'
Added the new optional request property ' Authorize /customer/email'
Added the new optional request property ' Capture /airline'
Added the new optional request property ' Pay /airline'
Added the new optional request property ' Pay /currencyConversion'
Added the new optional request property ' Pay /customer/email'
Added the optional property 'airline' to the response
Added the optional property 'currencyConversion' to the response
Added the optional property 'customer' to the response

April 2011

Version 4

Operations

Retrieve Transaction , Authorize , Capture , Pay , Referral , Refund , Void

Breaking changes

Removed the required property 'card/type' from the response
Added the new required request property ' Authorize /cardDetails'
Added the new required request property ' Pay /cardDetails'
Removed ' authorize_with_a_session_request, pay_with_a_session_request' from the request body 'oneOf' list
Removed the required property 'card/type' from the response
Removed the optional property 'card/bankAccountType' from the response
Removed the optional property 'card/issueNumber' from the response
Removed the optional property 'card/start' from the response
Removed the optional property 'card/token' from the response
Removed the optional property 'response/3dsecure' from the response
Added the new 'APPROVED_PENDING_SETTLEMENT' enum value to the 'response/gatewayCode' response property

Operations

Save Card (with system-generated token)

Breaking changes

Added the new required request property 'cardDetails'
Removed ' save_card_with_systemgenerated_token_with_a_session_request, save_card_with_systemgenerated_token_request' from the request body 'oneOf' list

Operations

Delete Token , Retrieve Card , Save Card

Breaking changes

The response property 'card' became optional
The response property 'card/number' became optional
Removed the required property 'card/type' from the response
Removed the required property 'merchant' from the response
Added the new required request property 'cardDetails'
Removed ' save_card_with_a_session_request, save_card_request' from the request body 'oneOf' list

January 2011

Version 3

Operations

Retrieve Transaction , Authorize with Session , Pay with Session , Authorize , Capture , Pay , Refund

Breaking changes

Removed the optional property 'card/cardSequenceNumber' from the response
Removed the optional property 'card/cardSequenceNumber' from the response

Non-Breaking changes

Added the optional property 'card/holder' to the response
Added the optional property 'card/sequenceNumber' to the response
Added the optional property 'transaction/cashAdvance' to the response
Added the optional property 'transaction/frequency' to the response
Added the optional property 'transaction/source' to the response
Added the optional property 'transaction/tax' to the response
Added the new optional request property ' Authorize with Session /transaction/cashAdvance'
Added the new optional request property ' Authorize with Session /transaction/frequency'
Added the new optional request property ' Authorize with Session /transaction/source'
Added the new optional request property ' Authorize with Session /transaction/tax'
Added the new optional request property ' Pay with Session /transaction/cashAdvance'
Added the new optional request property ' Pay with Session /transaction/frequency'
Added the new optional request property ' Pay with Session /transaction/source'
Added the new optional request property ' Pay with Session /transaction/tax'
Added the new optional request property ' Authorize /card/bankAccountType'
Added the new optional request property ' Authorize /card/issueNumber'
Added the new optional request property ' Authorize /card/start'
Added the new optional request property ' Authorize /transaction/cashAdvance'
Added the new optional request property ' Authorize /transaction/frequency'
Added the new optional request property ' Authorize /transaction/source'
Added the new optional request property ' Authorize /transaction/tax'
Added the new optional request property ' Pay /card/bankAccountType'
Added the new optional request property ' Pay /card/issueNumber'
Added the new optional request property ' Pay /card/start'
Added the new optional request property ' Pay /transaction/cashAdvance'
Added the new optional request property ' Pay /transaction/frequency'
Added the new optional request property ' Pay /transaction/source'
Added the new optional request property ' Pay /transaction/tax'
Added the optional property 'card/holder' to the response
Added the optional property 'card/sequenceNumber' to the response
Added the optional property 'transaction/cashAdvance' to the response
Added the optional property 'transaction/frequency' to the response
Added the optional property 'transaction/source' to the response
Added the optional property 'transaction/tax' to the response

Operations

Save Card (with system-generated token)

Non-Breaking changes

Added the new optional request property ' Save Card (with system-generated token) /card/bankAccountType'
Added the new optional request property ' Save Card (with system-generated token) /card/issueNumber'
Added the new optional request property ' Save Card (with system-generated token) /card/start'

Operations

Save Card

Non-Breaking changes

Added the new optional request property ' Save Card /card/bankAccountType'
Added the new optional request property ' Save Card /card/issueNumber'
Added the new optional request property ' Save Card /card/start'

Operations

Retrieve Card and Transaction , Authorize with Token , Pay with Token

Breaking changes

Removed ' authorization_and_save_token_request, pay_and_save_token_request' from the request body 'oneOf' list
Removed the optional property 'card/cardSequenceNumber' from the response
Removed the optional property 'card/cardSequenceNumber' from the response

Non-Breaking changes

Added the optional property 'card/holder' to the response
Added the optional property 'card/sequenceNumber' to the response
Added the optional property 'transaction/cashAdvance' to the response
Added the optional property 'transaction/frequency' to the response
Added the optional property 'transaction/source' to the response
Added the optional property 'transaction/tax' to the response
Api operation id 'Tokenization: Authorize and Save Card OR Tokenization: Authorize with Token OR Tokenization: Pay And Save Card OR Tokenization: Pay with Token' removed and replaced with 'Tokenization: Authorize with Token OR Tokenization: Pay with Token'
Added the new optional request property ' Authorize with Token /transaction/cashAdvance'
Added the new optional request property ' Authorize with Token /transaction/frequency'
Added the new optional request property ' Authorize with Token /transaction/source'
Added the new optional request property ' Authorize with Token /transaction/tax'
Added the new optional request property ' Pay with Token /transaction/cashAdvance'
Added the new optional request property ' Pay with Token /transaction/frequency'
Added the new optional request property ' Pay with Token /transaction/source'
Added the new optional request property ' Pay with Token /transaction/tax'
Added the optional property 'card/holder' to the response
Added the optional property 'card/sequenceNumber' to the response
Added the optional property 'transaction/cashAdvance' to the response
Added the optional property 'transaction/frequency' to the response
Added the optional property 'transaction/source' to the response
Added the optional property 'transaction/tax' to the response

October 2010

Version 2

Operations

Retrieve Transaction , Authorize with Session , Pay with Session , Authorize , Capture , Pay , Refund

Non-Breaking changes

Api operation id 'Transaction: Authorize OR Transaction: Capture OR Transaction: Pay OR Transaction: Refund' removed and replaced with 'Session: Authorize with Session OR Session: Pay with Session OR Transaction: Authorize OR Transaction: Capture OR Transaction: Pay OR Transaction: Refund'
Api tag 'Session' added
Added ' authorize_with_a_session_request, pay_with_a_session_request' to the request body 'oneOf' list

Operations

Create Session

Non-Breaking changes

Endpoint added

Operations

Save Card (with system-generated token) with Session , Save Card (with system-generated token)

Breaking changes

Added ' save_card_with_systemgenerated_token_with_a_session_response, save_card_with_systemgenerated_token_response' to the response body 'oneOf' list
Removed the required property 'card' from the response
Removed the required property 'merchant' from the response
Removed the required property 'result' from the response
Removed the request property 'action'
Removed the request property 'card'
Removed the request property 'correlationId'
Removed the request property 'transaction'
Removed the optional property 'correlationId' from the response
Removed the optional property 'response' from the response

Non-Breaking changes

Api operation id 'Tokenization: Save Card (with system-generated token)' removed and replaced with 'Session: Save Card (with system-generated token) with Session OR Tokenization: Save Card (with system-generated token)'
Api tag 'Session' added
Added ' save_card_with_systemgenerated_token_with_a_session_request, save_card_with_systemgenerated_token_request' to the request body 'oneOf' list

Operations

Retrieve Card , Save Card with Session , Save Card

Breaking changes

Added ' save_card_with_a_session_response, save_card_response' to the response body 'oneOf' list
Removed the required property 'card' from the response
Removed the required property 'merchant' from the response
Removed the required property 'result' from the response
Removed the request property 'action'
Removed the request property 'card'
Removed the request property 'correlationId'
Removed the request property 'transaction'
Removed the optional property 'correlationId' from the response
Removed the optional property 'response' from the response

Non-Breaking changes

Api operation id 'Tokenization: Save Card' removed and replaced with 'Session: Save Card with Session OR Tokenization: Save Card'
Api tag 'Session' added
Added ' save_card_with_a_session_request, save_card_request' to the request body 'oneOf' list