Session Authentication Fields
In session-authenticated interactions with the gateway, the payer is restricted to a subset of fields within an API operation. These are referred to as payer input fields. If you provide fields other than payer input fields in a session-authenticated request, the request is rejected. For example, the payer cannot submit the order amount.
Similar to payer input fields, the gateway allows only certain fields to be returned in the response for a session-authenticated interactions with the gateway. These are referred to as payer output fields — only fields that are required to be displayed to a payer on a browser or an app to perform an operation are returned. For example, security-sensitive data, such as the session ID, is not returned.
The following sections list the fields supported in specific session-authenticated requests.
Fields in UPDATE SESSION
request
The following fields are supported as payer input fields in the request:
-
agreement.amountVariability
-
agreement.maximumAmountPerPayment
-
agreement.minimumAmountPerPayment
-
agreement.numberOfPayments
-
agreement.paymentFrequency
-
authentication.3ds2.sdk.appId
-
authentication.3ds2.sdk.encryptedData
-
authentication.3ds2.sdk.ephemeralPublicKey
-
authentication.3ds2.sdk.interface
-
authentication.3ds2.sdk.referenceNumber
-
authentication.3ds2.sdk.timeout
-
authentication.3ds2.sdk.transactionId
-
authentication.3ds2.sdk.uiType
-
authentication.methodNotificationUrl
-
billing.address.city
-
billing.address.company
-
billing.address.country
-
billing.address.postcodeZip
-
billing.address.stateProvince
-
billing.address.stateProvinceCode
-
billing.address.street
-
billing.address.street2
-
browserPayment.openBankingBankTransfer.refundConsent
-
browserPayment.preferredLanguage
-
browserPayment.type
-
correlationId
-
customer.dateOfBirth
-
customer.email
-
customer.firstName
-
customer.lastName
-
customer.mobilePhone
-
customer.nationalId
-
customer.phone
-
customer.taxRegistrationId
-
device.browser
-
device.browserDetails.3DSecureChallengeWindowSize
-
device.browserDetails.acceptHeaders
-
device.browserDetails.colorDepth
-
device.browserDetails.javaEnabled
-
device.browserDetails.javaScriptEnabled
-
device.browserDetails.language
-
device.browserDetails.screenHeight
-
device.browserDetails.screenWidth
-
device.browserDetails.timeZone
-
device.fingerprint
-
device.hostname
-
device.ipAddress
-
device.mobilePhoneModel
-
gatewayEntryPoint
-
interaction.operation
-
locale
-
order.statementDescriptor.address.city
-
order.statementDescriptor.address.company
-
order.statementDescriptor.address.country
-
order.statementDescriptor.address.postcodeZip
-
order.statementDescriptor.address.stateProvince
-
order.statementDescriptor.address.stateProvinceCode
-
order.statementDescriptor.address.street
-
order.statementDescriptor.address.street2
-
order.subMerchant.address.city
-
order.subMerchant.address.company
-
order.subMerchant.address.country
-
order.subMerchant.address.postcodeZip
-
order.subMerchant.address.stateProvince
-
order.subMerchant.address.stateProvinceCode
-
order.subMerchant.address.street
-
order.subMerchant.address.street2
-
order.walletProvider
-
paymentPlanOffer.id
-
paymentPlanOffer.payerAcceptance
-
paymentPlanOffer.termsAndConditionsDisplay
-
paymentPlanProduct.id
-
session.version
-
shipping.contact.email
-
shipping.contact.firstName
-
shipping.contact.lastName
-
shipping.contact.mobilePhone
-
shipping.contact.phone
-
sourceOfFunds.browserPayment.type
-
sourceOfFunds.provided.bancontact.bankAccountHolder
-
sourceOfFunds.provided.blik.bankAccountHolder
-
sourceOfFunds.provided.boletoBancario.bankAccountHolder
-
sourceOfFunds.provided.browserPayment.additionalPayerData.id
-
sourceOfFunds.provided.browserPayment.additionalPayerData.value
-
sourceOfFunds.provided.card.devicePayment.cryptogramFormat
-
sourceOfFunds.provided.card.devicePayment.eciIndicator
-
sourceOfFunds.provided.card.devicePayment.emv.emvData
-
sourceOfFunds.provided.card.devicePayment.onlinePaymentCryptogram
-
sourceOfFunds.provided.card.devicePayment.paymentToken
-
sourceOfFunds.provided.card.expiry.month
-
sourceOfFunds.provided.card.expiry.year
-
sourceOfFunds.provided.card.mobileWallet.emv.emvData
-
sourceOfFunds.provided.card.nameOnCard
-
sourceOfFunds.provided.card.number
-
sourceOfFunds.provided.card.prefix
-
sourceOfFunds.provided.card.securityCode
-
sourceOfFunds.provided.enets.bankAccountHolder
-
sourceOfFunds.provided.epsUeberweisung.bankAccountCountryCode
-
sourceOfFunds.provided.epsUeberweisung.bankAccountHolder
-
sourceOfFunds.provided.giropay.bankIdentifier
-
sourceOfFunds.provided.giropay.bic
-
sourceOfFunds.provided.grabPay.accountHolder
-
sourceOfFunds.provided.ideal.bic
-
sourceOfFunds.provided.klarnaPayLater.bankAccountCountryCode
-
sourceOfFunds.provided.klarnaPayNow.bankAccountCountryCode
-
sourceOfFunds.provided.openBankingBankTransfer.aspspId
-
sourceOfFunds.provided.oxxo.bankAccountHolder
-
sourceOfFunds.provided.payU.bankAccountCountryCode
-
sourceOfFunds.provided.payU.bankAccountHolder
-
sourceOfFunds.provided.payconiq.countryCode
-
sourceOfFunds.provided.paysafecard.countryCode
-
sourceOfFunds.provided.poli.bankAccountHolder
-
sourceOfFunds.provided.przelewy24.bankAccountHolder
-
sourceOfFunds.provided.sepa.bankAccountHolder
-
sourceOfFunds.provided.sepa.bic
-
sourceOfFunds.provided.sepa.iban
-
sourceOfFunds.provided.sofort.bankAccountCountryCode
-
sourceOfFunds.provided.trustly.bankAccountCountryCode
-
sourceOfFunds.provided.trustly.bankAccountHolder
-
sourceOfFunds.provided.weChatPay.accountHolder
-
sourceOfFunds.token
-
sourceOfFunds.type
-
transaction.acquirer.customData
-
transaction.acquirer.traceId
-
transactionSource
The following fields are supported as payer output fields in the response:
-
agreement.amountVariability
-
agreement.id
-
agreement.maximumAmountPerPayment
-
agreement.minimumAmountPerPayment
-
agreement.numberOfPayments
-
agreement.paymentFrequency
-
agreement.type
-
authentication.3ds2.authenticationScheme
-
authentication.3ds2.custom
-
authentication.methodNotificationUrl
-
correlationId
-
error.cause
-
error.field
-
error.supportCode
-
error.validationType
-
order.amount
-
order.currency
-
order.customerNote
-
order.customerReference
-
order.invoiceNumber
-
result
-
session.updateStatus
-
session.id
-
session.version
-
sourceOfFunds.provided.paypal.accountEmail
-
sourceOfFunds.provided.paypal.accountHolder
Fields in INITIATE AUTHENTICATION
request
The following fields are supported as payer input fields in the request:
-
apiOperation
-
authentication.methodNotificationUrl
-
correlationId
-
order.walletProvider
-
session.id
-
session.version
-
sourceOfFunds.provided.bancontact.bankAccountHolder
-
sourceOfFunds.provided.blik.bankAccountHolder
-
sourceOfFunds.provided.boletoBancario.bankAccountHolder
-
sourceOfFunds.provided.card.devicePayment.cryptogramFormat
-
sourceOfFunds.provided.card.devicePayment.eciIndicator
-
sourceOfFunds.provided.card.devicePayment.emv.emvData
-
sourceOfFunds.provided.card.devicePayment.onlinePaymentCryptogram
-
sourceOfFunds.provided.card.devicePayment.paymentToken
-
sourceOfFunds.provided.card.expiry.month
-
sourceOfFunds.provided.card.expiry.year
-
sourceOfFunds.provided.card.nameOnCard
-
sourceOfFunds.provided.card.number
-
sourceOfFunds.provided.enets.bankAccountHolder
-
sourceOfFunds.provided.epsUeberweisung.bankAccountCountryCode
-
sourceOfFunds.provided.epsUeberweisung.bankAccountHolder
-
sourceOfFunds.provided.giropay.bankIdentifier
-
sourceOfFunds.provided.giropay.bic
-
sourceOfFunds.provided.grabPay.accountHolder
-
sourceOfFunds.provided.ideal.bic
-
sourceOfFunds.provided.klarnaPayLater.bankAccountCountryCode
-
sourceOfFunds.provided.klarnaPayNow.bankAccountCountryCode
-
sourceOfFunds.provided.openBankingBankTransfer.aspspId
-
sourceOfFunds.provided.oxxo.bankAccountHolder
-
sourceOfFunds.provided.payU.bankAccountCountryCode
-
sourceOfFunds.provided.payU.bankAccountHolder
-
sourceOfFunds.provided.paysafecard.countryCode
-
sourceOfFunds.provided.poli.bankAccountHolder
-
sourceOfFunds.provided.przelewy24.bankAccountHolder
-
sourceOfFunds.provided.sepa.bankAccountHolder
-
sourceOfFunds.provided.sepa.iban
-
sourceOfFunds.provided.sofort.bankAccountCountryCode
-
sourceOfFunds.provided.trustly.bankAccountCountryCode
-
sourceOfFunds.provided.trustly.bankAccountHolder
-
sourceOfFunds.provided.weChatPay.accountHolder
-
sourceOfFunds.token
-
sourceOfFunds.type
The following fields are supported as payer output fields in the response:
-
authentication.3ds2.authenticationScheme
-
authentication.3ds2.directoryServerId
-
authentication.3ds2.methodCompleted
-
authentication.3ds2.methodSupported
-
authentication.3ds2.protocolVersion
-
authentication.redirect.html
-
authentication.version
-
encryptedData.ciphertext
-
encryptedData.nonce
-
encryptedData.tag
-
error.cause
-
error.field
-
error.supportCode
-
error.validationType
-
order.authenticationStatus
-
order.currency
-
order.status
-
response.gatewayCode
-
response.gatewayRecommendation
-
result
-
sourceOfFunds.provided.boletoBancario.slipUrl
-
sourceOfFunds.provided.ideal.bankAccountHolder
-
sourceOfFunds.provided.paypal.accountEmail
-
sourceOfFunds.provided.paypal.accountHolder
-
sourceOfFunds.provided.sepa.bic
-
sourceOfFunds.provided.sofort.bankAccountHolder
-
sourceOfFunds.provided.sofort.bankAccountNumber
-
sourceOfFunds.provided.sofort.bankIdentifier
-
transaction.authenticationStatus
-
version
Fields in AUTHENTICATE PAYER
request
The following fields are supported as payer input fields in the request:
-
agreement.amountVariability
-
agreement.maximumAmountPerPayment
-
agreement.minimumAmountPerPayment
-
agreement.numberOfPayments
-
agreement.paymentFrequency
-
apiOperation
-
authentication.3ds2.sdk.appId
-
authentication.3ds2.sdk.encryptedData
-
authentication.3ds2.sdk.ephemeralPublicKey
-
authentication.3ds2.sdk.interface
-
authentication.3ds2.sdk.referenceNumber
-
authentication.3ds2.sdk.timeout
-
authentication.3ds2.sdk.transactionId
-
authentication.3ds2.sdk.uiType
-
billing.address.city
-
billing.address.company
-
billing.address.country
-
billing.address.postcodeZip
-
billing.address.stateProvince
-
billing.address.stateProvinceCode
-
billing.address.street
-
billing.address.street2
-
correlationId
-
customer.taxRegistrationId
-
device.browser
-
device.browserDetails.3DSecureChallengeWindowSize
-
device.browserDetails.acceptHeaders
-
device.browserDetails.colorDepth
-
device.browserDetails.javaEnabled
-
device.browserDetails.javaScriptEnabled
-
device.browserDetails.language
-
device.browserDetails.screenHeight
-
device.browserDetails.screenWidth
-
device.browserDetails.timeZone
-
device.fingerprint
-
device.hostname
-
device.ipAddress
-
device.mobilePhoneModel
-
order.walletProvider
-
session.id
-
session.version
-
sourceOfFunds.provided.bancontact.bankAccountHolder
-
sourceOfFunds.provided.blik.bankAccountHolder
-
sourceOfFunds.provided.boletoBancario.bankAccountHolder
-
sourceOfFunds.provided.card.devicePayment.cryptogramFormat
-
sourceOfFunds.provided.card.devicePayment.eciIndicator
-
sourceOfFunds.provided.card.devicePayment.emv.emvData
-
sourceOfFunds.provided.card.devicePayment.onlinePaymentCryptogram
-
sourceOfFunds.provided.card.devicePayment.paymentToken
-
sourceOfFunds.provided.card.expiry.month
-
sourceOfFunds.provided.card.expiry.year
-
sourceOfFunds.provided.card.nameOnCard
-
sourceOfFunds.provided.card.number
-
sourceOfFunds.provided.card.securityCode
-
sourceOfFunds.provided.enets.bankAccountHolder
-
sourceOfFunds.provided.giropay.bankIdentifier
-
sourceOfFunds.provided.giropay.bic
-
sourceOfFunds.provided.grabPay.accountHolder
-
sourceOfFunds.provided.ideal.bic
-
sourceOfFunds.provided.openBankingBankTransfer.aspspId
-
sourceOfFunds.provided.oxxo.bankAccountHolder
-
sourceOfFunds.provided.poli.bankAccountHolder
-
sourceOfFunds.provided.przelewy24.bankAccountHolder
-
sourceOfFunds.provided.sepa.bankAccountHolder
-
sourceOfFunds.provided.sepa.iban
-
sourceOfFunds.provided.trustly.bankAccountHolder
-
sourceOfFunds.provided.weChatPay.accountHolder
-
sourceOfFunds.type
The following fields are supported as payer output fields in the response:
-
agreement.id
-
agreement.type
-
authentication.3ds.transactionId
-
authentication.3ds2.3dsServerTransactionId
-
authentication.3ds2.acsReference
-
authentication.3ds2.acsTransactionId
-
authentication.3ds2.authenticationScheme
-
authentication.3ds2.challenge.signedContent
-
authentication.3ds2.custom
-
authentication.3ds2.directoryServerId
-
authentication.3ds2.methodCompleted
-
authentication.3ds2.methodSupported
-
authentication.3ds2.protocolVersion
-
authentication.3ds2.sdk.challengeCompletionCallbackUrl
-
authentication.3ds2.sdk.OobAppSupportsRedirectUrl
-
authentication.payerInteraction
-
authentication.redirect.customizedHtml.3ds2.acsUrl
-
authentication.redirect.customizedHtml.3ds2.cReq
-
authentication.redirect.domainName
-
authentication.redirect.html
-
authentication.version
-
encryptedData.ciphertext
-
encryptedData.nonce
-
encryptedData.tag
-
error.cause
-
error.field
-
error.supportCode
-
error.validationType
-
order.amount
-
order.authenticationStatus
-
order.currency
-
order.customerNote
-
order.customerReference
-
order.invoiceNumber
-
order.status
-
response.gatewayCode
-
response.gatewayRecommendation
-
result
-
sourceOfFunds.provided.boletoBancario.slipUrl
-
sourceOfFunds.provided.ideal.bankAccountHolder
-
sourceOfFunds.provided.paypal.accountEmail
-
sourceOfFunds.provided.paypal.accountHolder
-
sourceOfFunds.provided.sepa.bic
-
sourceOfFunds.provided.sofort.bankAccountHolder
-
sourceOfFunds.provided.sofort.bankAccountNumber
-
sourceOfFunds.provided.sofort.bankIdentifier
-
transaction.authenticationStatus
-
version
Fields in Browser Payment: Confirm
request
The following fields are supported as payer input fields in the request:
agreement.amountVariability
agreement.maximumAmountPerPayment
agreement.minimumAmountPerPayment
agreement.numberOfPayments
agreement.paymentFrequency
correlationId
customer.email
session.version
shipping.contact.email
shipping.contact.firstName
shipping.contact.lastName
shipping.contact.mobilePhone
shipping.contact.phone
The following fields are supported as payer output fields in the response:
agreement.amountVariability
agreement.id
agreement.maximumAmountPerPayment
agreement.minimumAmountPerPayment
agreement.numberOfPayments
agreement.paymentFrequency
agreement.type
authentication.3ds2.3dsServerTransactionId
authentication.3ds2.acsTransactionId
authentication.3ds2.authenticationScheme
authentication.3ds2.custom
authentication.3ds2.directoryServerId
authentication.3ds2.methodCompleted
authentication.3ds2.methodSupported
authentication.3ds2.protocolVersion
authentication.3ds2.sdk.challengeCompletionCallbackUrl
authentication.3ds2.sdk.interface
authentication.3ds2.sdk.timeout
authentication.3ds2.sdk.uiType
authentication.payerInteraction
authentication.redirect.domainName
authentication.version
browserPayment.bankMessage
browserPayment.bankReferenceNumber
browserPayment.interaction.status
browserPayment.paypal.accountId
browserPayment.paypal.interactionId
browserPayment.redirectHtml
browserPayment.redirectUrl
correlationId
error.cause
error.field
error.supportCode
error.validationType
order.amount
order.authenticationStatus
order.currency
order.customerNote
order.customerReference
order.invoiceNumber
order.merchantAmount
order.merchantCurrency
order.status
response.acquirerCode
response.gatewayCode
response.gatewayRecommendation
result
session.version
sourceOfFunds.provided.boletoBancario.bankAccountHolder
sourceOfFunds.provided.boletoBancario.slipUrl
sourceOfFunds.provided.card.number
sourceOfFunds.provided.enets.bankAccountHolder
sourceOfFunds.provided.giropay.bankIdentifier
sourceOfFunds.provided.ideal.bankAccountHolder
sourceOfFunds.provided.klarnaPayLater.bankAccountCountryCode
sourceOfFunds.provided.multibanco.entityId
sourceOfFunds.provided.multibanco.paymentReference
sourceOfFunds.provided.oxxo.bankAccountHolder
sourceOfFunds.provided.paypal.accountEmail
sourceOfFunds.provided.paypal.accountHolder
sourceOfFunds.provided.poli.bankAccountHolder
sourceOfFunds.provided.sepa.bankAccountHolder
sourceOfFunds.provided.sepa.bic
sourceOfFunds.provided.sofort.bankAccountHolder
sourceOfFunds.provided.sofort.bankAccountNumber
sourceOfFunds.provided.sofort.bankIdentifier
sourceOfFunds.provided.weChatPay.accountHolder
sourceOfFunds.type
transaction.multiCurrencyPricing.merchantAmount
transaction.multiCurrencyPricing.merchantCurrency
version
Fields in Browser Payment: Initiate
request
The following fields are supported as payer input fields in the request:
agreement.amountVariability
agreement.maximumAmountPerPayment
agreement.minimumAmountPerPayment
agreement.numberOfPayments
agreement.paymentFrequency
billing.address.city
billing.address.company
billing.address.country
billing.address.postcodeZip
billing.address.stateProvince
billing.address.stateProvinceCode
billing.address.street
billing.address.street2
browserPayment.openBankingBankTransfer.refundConsent
correlationId
customer.dateOfBirth
customer.email
customer.firstName
customer.lastName
customer.mobilePhone
customer.nationalId
customer.phone
device.browser
device.fingerprint
device.hostname
device.ipAddress
device.mobilePhoneModel
session.version
shipping.contact.email
shipping.contact.firstName
shipping.contact.lastName
shipping.contact.mobilePhone
shipping.contact.phone
sourceOfFunds.browserPayment.type
sourceOfFunds.provided.bancontact.bankAccountHolder
sourceOfFunds.provided.blik.bankAccountHolder
sourceOfFunds.provided.boletoBancario.bankAccountHolder
sourceOfFunds.provided.browserPayment.additionalPayerData.id
sourceOfFunds.provided.browserPayment.additionalPayerData.value
sourceOfFunds.provided.card.devicePayment.cryptogramFormat
sourceOfFunds.provided.card.expiry.month
sourceOfFunds.provided.card.expiry.year
sourceOfFunds.provided.card.nameOnCard
sourceOfFunds.provided.enets.bankAccountHolder
sourceOfFunds.provided.epsUeberweisung.bankAccountCountryCode
sourceOfFunds.provided.epsUeberweisung.bankAccountHolder
sourceOfFunds.provided.giropay.bankIdentifier
sourceOfFunds.provided.giropay.bic
sourceOfFunds.provided.grabPay.accountHolder
sourceOfFunds.provided.ideal.bic
sourceOfFunds.provided.klarnaPayLater.bankAccountCountryCode
sourceOfFunds.provided.klarnaPayNow.bankAccountCountryCode
sourceOfFunds.provided.openBankingBankTransfer.aspspId
sourceOfFunds.provided.oxxo.bankAccountHolder
sourceOfFunds.provided.payU.bankAccountCountryCode
sourceOfFunds.provided.payU.bankAccountHolder
sourceOfFunds.provided.payconiq.countryCode
sourceOfFunds.provided.paysafecard.countryCode
sourceOfFunds.provided.poli.bankAccountHolder
sourceOfFunds.provided.przelewy24.bankAccountHolder
sourceOfFunds.provided.sepa.bankAccountHolder
sourceOfFunds.provided.sepa.iban
sourceOfFunds.provided.sofort.bankAccountCountryCode
sourceOfFunds.provided.trustly.bankAccountCountryCode
sourceOfFunds.provided.trustly.bankAccountHolder
sourceOfFunds.provided.weChatPay.accountHolder
sourceOfFunds.type
The following fields are supported as payer output fields in the response:
agreement.amountVariability
agreement.id
agreement.maximumAmountPerPayment
agreement.minimumAmountPerPayment
agreement.numberOfPayments
agreement.paymentFrequency
agreement.type
authentication.3ds2.3dsServerTransactionId
authentication.3ds2.acsTransactionId
authentication.3ds2.authenticationScheme
authentication.3ds2.custom
authentication.3ds2.directoryServerId
authentication.3ds2.methodCompleted
authentication.3ds2.methodSupported
authentication.3ds2.protocolVersion
authentication.3ds2.sdk.challengeCompletionCallbackUrl
authentication.3ds2.sdk.interface
authentication.3ds2.sdk.timeout
authentication.3ds2.sdk.uiType
authentication.payerInteraction
authentication.redirect.domainName
authentication.version
browserPayment.bankMessage
browserPayment.bankReferenceNumber
browserPayment.interaction.status
browserPayment.paypal.accountId
browserPayment.paypal.interactionId
browserPayment.redirectHtml
browserPayment.redirectUrl
correlationId
error.cause
error.field
error.supportCode
error.validationType
order.amount
order.authenticationStatus
order.currency
order.customerNote
order.customerReference
order.invoiceNumber
order.merchantAmount
order.merchantCurrency
order.status
response.acquirerCode
response.gatewayCode
response.gatewayRecommendation
result
session.version
sourceOfFunds.provided.boletoBancario.bankAccountHolder
sourceOfFunds.provided.boletoBancario.slipUrl
sourceOfFunds.provided.card.number
sourceOfFunds.provided.enets.bankAccountHolder
sourceOfFunds.provided.giropay.bankIdentifier
sourceOfFunds.provided.ideal.bankAccountHolder
sourceOfFunds.provided.klarnaPayLater.bankAccountCountryCode
sourceOfFunds.provided.multibanco.entityId
sourceOfFunds.provided.multibanco.paymentReference
sourceOfFunds.provided.oxxo.bankAccountHolder
sourceOfFunds.provided.paypal.accountEmail
sourceOfFunds.provided.paypal.accountHolder
sourceOfFunds.provided.poli.bankAccountHolder
sourceOfFunds.provided.sepa.bankAccountHolder
sourceOfFunds.provided.sepa.bic
sourceOfFunds.provided.sofort.bankAccountHolder
sourceOfFunds.provided.sofort.bankAccountNumber
sourceOfFunds.provided.sofort.bankIdentifier
sourceOfFunds.provided.weChatPay.accountHolder
sourceOfFunds.type
transaction.multiCurrencyPricing.merchantAmount
transaction.multiCurrencyPricing.merchantCurrency
version
Fields in Browser Payment: Update
request
The following fields are supported as payer input fields in the request:
correlationId
session.version
The following fields are supported as payer output fields in the response:
agreement.amountVariability
agreement.id
agreement.maximumAmountPerPayment
agreement.minimumAmountPerPayment
agreement.numberOfPayments
agreement.paymentFrequency
agreement.type
authentication.3ds2.3dsServerTransactionId
authentication.3ds2.acsTransactionId
authentication.3ds2.authenticationScheme
authentication.3ds2.custom
authentication.3ds2.directoryServerId
authentication.3ds2.methodCompleted
authentication.3ds2.methodSupported
authentication.3ds2.protocolVersion
authentication.3ds2.sdk.challengeCompletionCallbackUrl
authentication.3ds2.sdk.interface
authentication.3ds2.sdk.timeout
authentication.3ds2.sdk.uiType
authentication.payerInteraction
authentication.redirect.domainName
authentication.version
browserPayment.bankMessage
browserPayment.bankReferenceNumber
browserPayment.interaction.status
browserPayment.paypal.accountId
browserPayment.paypal.interactionId
browserPayment.redirectHtml
browserPayment.redirectUrl
correlationId
error.cause
error.field
error.supportCode
error.validationType
order.amount
order.authenticationStatus
order.currency
order.customerNote
order.customerReference
order.invoiceNumber
order.merchantAmount
order.merchantCurrency
order.status
response.acquirerCode
response.gatewayCode
response.gatewayRecommendation
result
session.version
sourceOfFunds.provided.boletoBancario.bankAccountHolder
sourceOfFunds.provided.boletoBancario.slipUrl
sourceOfFunds.provided.card.number
sourceOfFunds.provided.enets.bankAccountHolder
sourceOfFunds.provided.giropay.bankIdentifier
sourceOfFunds.provided.ideal.bankAccountHolder
sourceOfFunds.provided.klarnaPayLater.bankAccountCountryCode
sourceOfFunds.provided.multibanco.entityId
sourceOfFunds.provided.multibanco.paymentReference
sourceOfFunds.provided.oxxo.bankAccountHolder
sourceOfFunds.provided.paypal.accountEmail
sourceOfFunds.provided.paypal.accountHolder
sourceOfFunds.provided.poli.bankAccountHolder
sourceOfFunds.provided.sepa.bankAccountHolder
sourceOfFunds.provided.sepa.bic
sourceOfFunds.provided.sofort.bankAccountHolder
sourceOfFunds.provided.sofort.bankAccountNumber
sourceOfFunds.provided.sofort.bankIdentifier
sourceOfFunds.provided.weChatPay.accountHolder
sourceOfFunds.type
transaction.multiCurrencyPricing.merchantAmount
transaction.multiCurrencyPricing.merchantCurrency
version
Fields in Gateway: Payment Options Inquiry
request
The following fields are supported as payer input fields in the request:
correlationId
gatewayEntryPoint
interaction.operation
locale
session.version
sourceOfFunds.provided.card.prefix
sourceOfFunds.token
transactionSource
The following fields are supported as payer output fields in the response:
correlationId
custom
disclosureStatements.chargeType
disclosureStatements.locale
disclosureStatements.statement
error.cause
error.field
error.supportCode
error.validationType
gatewayEntryPoint
merchant
order.amount
order.currency
order.item.quantity
order.item.serialNumbers
order.item.sku
order.item.unitPrice
order.itemAmount
order.merchantCharge.amount
order.merchantCharge.cardBrand
order.merchantCharge.fixedAmount
order.merchantCharge.fundingMethod
order.merchantCharge.maximumFixedAmount
order.merchantCharge.maximumOrderAmount
order.merchantCharge.maximumPercentAmount
order.merchantCharge.minimumOrderAmount
order.merchantCharge.percent
order.merchantCharge.type
order.netAmount
order.surchargeAmount
payerLocale
paymentPlanProduct.logoUrl
paymentPlanProduct.name
paymentPlanProduct.paymentPlanProductId
paymentTypes.ach.currencies.currency
paymentTypes.ach.transactionSources.transactionSource
paymentTypes.alipay.currencies.currency
paymentTypes.alipay.transactionSources.transactionSource
paymentTypes.bancanet.currencies.currency
paymentTypes.bancanet.transactionSources.transactionSource
paymentTypes.bancontact.currencies.currency
paymentTypes.bancontact.transactionSources.transactionSource
paymentTypes.blik.currencies.currency
paymentTypes.blik.transactionSources.transactionSource
paymentTypes.boletobancario.acquirer
paymentTypes.boletobancario.currencies.currency
paymentTypes.boletobancario.transactionSources.transactionSource
paymentTypes.browserPayment.additionalPayerData.display.errorMessageText
paymentTypes.browserPayment.additionalPayerData.display.fieldLabel
paymentTypes.browserPayment.additionalPayerData.display.helpText
paymentTypes.browserPayment.additionalPayerData.display.locale
paymentTypes.browserPayment.additionalPayerData.id
paymentTypes.browserPayment.additionalPayerData.validation.allowedCharacterSet
paymentTypes.browserPayment.additionalPayerData.validation.maximumLength
paymentTypes.browserPayment.additionalPayerData.validation.minimumLength
paymentTypes.browserPayment.additionalPayerData.validation.presence
paymentTypes.browserPayment.additionalPayerData.validation.regularExpression
paymentTypes.browserPayment.currencies.currency
paymentTypes.browserPayment.description
paymentTypes.browserPayment.displayName
paymentTypes.browserPayment.logoUrl
paymentTypes.browserPayment.paymentPlanOffer.currency
paymentTypes.browserPayment.paymentPlanOffer.customerFee
paymentTypes.browserPayment.paymentPlanOffer.interestRate
paymentTypes.browserPayment.paymentPlanOffer.lateFee
paymentTypes.browserPayment.paymentPlanOffer.paymentAmount
paymentTypes.browserPayment.paymentPlanOffer.timeBetweenPayments.count
paymentTypes.browserPayment.paymentPlanOffer.timeBetweenPayments.unitOfMeasure
paymentTypes.browserPayment.standardPayerData.fieldName
paymentTypes.browserPayment.standardPayerData.presence
paymentTypes.browserPayment.supportedCountries.country
paymentTypes.browserPayment.transactionSources.transactionSource
paymentTypes.browserPayment.type
paymentTypes.card.3DSecureSchemes.3DSecureScheme
paymentTypes.card.brand
paymentTypes.card.capabilities.capability
paymentTypes.card.cardTypes.cardType
paymentTypes.card.cardTypes.schemeTokenTypes
paymentTypes.card.currencies.currency
paymentTypes.card.currencyConversion.exchangeRateSource
paymentTypes.card.currencyConversion.exchangeRateTime
paymentTypes.card.currencyConversion.gatewayCode
paymentTypes.card.currencyConversion.marginPercentage
paymentTypes.card.currencyConversion.offerText
paymentTypes.card.currencyConversion.payerAmount
paymentTypes.card.currencyConversion.payerCurrency
paymentTypes.card.currencyConversion.payerExchangeRate
paymentTypes.card.currencyConversion.provider
paymentTypes.card.currencyConversion.providerCode
paymentTypes.card.currencyConversion.providerReceipt
paymentTypes.card.currencyConversion.quoteExpiry
paymentTypes.card.currencyConversion.requestId
paymentTypes.card.defaultCardType
paymentTypes.card.fundingMethod
paymentTypes.card.interactionConstraints
paymentTypes.card.issuer
paymentTypes.card.localBrand
paymentTypes.card.paymentPlanOffer.cashAward.amount
paymentTypes.card.paymentPlanOffer.cashAward.payerInstructionText
paymentTypes.card.paymentPlanOffer.currency
paymentTypes.card.paymentPlanOffer.deferralPeriod
paymentTypes.card.paymentPlanOffer.endDate
paymentTypes.card.paymentPlanOffer.feeAmount
paymentTypes.card.paymentPlanOffer.firstPaymentAmount
paymentTypes.card.paymentPlanOffer.id
paymentTypes.card.paymentPlanOffer.interest.charged
paymentTypes.card.paymentPlanOffer.interest.discountAmount
paymentTypes.card.paymentPlanOffer.interest.rate
paymentTypes.card.paymentPlanOffer.minimumOrderAmount
paymentTypes.card.paymentPlanOffer.numberOfPayments
paymentTypes.card.paymentPlanOffer.paymentPlanProductId
paymentTypes.card.paymentPlanOffer.planTemplate
paymentTypes.card.paymentPlanOffer.qualifier.description
paymentTypes.card.paymentPlanOffer.qualifier.logoUrl
paymentTypes.card.paymentPlanOffer.startDate
paymentTypes.card.paymentPlanOffer.subsequentPaymentAmount
paymentTypes.card.paymentPlanOffer.termsAndConditions.acceptanceRequired
paymentTypes.card.paymentPlanOffer.termsAndConditions.acceptanceText
paymentTypes.card.paymentPlanOffer.termsAndConditions.text
paymentTypes.card.paymentPlanOffer.totalAmount
paymentTypes.card.scheme
paymentTypes.card.tags
paymentTypes.card.transactionSources.transactionSource
paymentTypes.card.walletProviders.secureRemoteCommerce.defaultPayerCountry
paymentTypes.card.walletProviders.secureRemoteCommerce.scheme.dpaId
paymentTypes.card.walletProviders.secureRemoteCommerce.scheme.name
paymentTypes.card.walletProviders.secureRemoteCommerce.shippingAddressCountries
paymentTypes.card.walletProviders.secureRemoteCommerce.srcVersion
paymentTypes.card.walletProviders.walletProvider
paymentTypes.directDebitCanada.currencies.currency
paymentTypes.directDebitCanada.transactionSources.transactionSource
paymentTypes.enets.currencies.currency
paymentTypes.enets.transactionSources.transactionSource
paymentTypes.epsUeberweisung.countries.countryCode
paymentTypes.epsUeberweisung.currencies.currency
paymentTypes.epsUeberweisung.transactionSources.transactionSource
paymentTypes.giftCard.cardTypes.cardType
paymentTypes.giftCard.currencies.currency
paymentTypes.giftCard.transactionSources.transactionSource
paymentTypes.giropay.currencies.currency
paymentTypes.giropay.transactionSources.transactionSource
paymentTypes.grabPay.currencies.currency
paymentTypes.grabPay.transactionSources.transactionSource
paymentTypes.ideal.currencies.currency
paymentTypes.ideal.transactionSources.transactionSource
paymentTypes.klarnaFinancing.currencies.currency
paymentTypes.klarnaFinancing.transactionSources.transactionSource
paymentTypes.klarnaPayLater.countries.countryCode
paymentTypes.klarnaPayLater.currencies.currency
paymentTypes.klarnaPayLater.transactionSources.transactionSource
paymentTypes.klarnaPayNow.countries.countryCode
paymentTypes.klarnaPayNow.currencies.currency
paymentTypes.klarnaPayNow.transactionSources.transactionSource
paymentTypes.mercadoPagoCheckout.currencies.currency
paymentTypes.moMoPay.currencies.currency
paymentTypes.moMoPay.transactionSources.transactionSource
paymentTypes.multibanco.currencies.currency
paymentTypes.multibanco.transactionSources.transactionSource
paymentTypes.openBankingBankTransfer.aspsp.other.id
paymentTypes.openBankingBankTransfer.aspsp.other.name
paymentTypes.openBankingBankTransfer.aspsp.preferred.id
paymentTypes.openBankingBankTransfer.aspsp.preferred.logoUrl
paymentTypes.openBankingBankTransfer.aspsp.preferred.name
paymentTypes.openBankingBankTransfer.capabilities.capability
paymentTypes.oxxo.currencies.currency
paymentTypes.oxxo.transactionSources.transactionSource
paymentTypes.payU.countries.countryCode
paymentTypes.payU.currencies.currency
paymentTypes.payU.transactionSources.transactionSource
paymentTypes.payconiq.countries.countryCode
paymentTypes.payconiq.currencies.currency
paymentTypes.payconiq.transactionSources.transactionSource
paymentTypes.paypal.accountId
paymentTypes.paypal.capabilities.capability
paymentTypes.paypal.clientId
paymentTypes.paypal.currencies.currency
paymentTypes.paypal.transactionSources.transactionSource
paymentTypes.paysafecard.countries.countryCode
paymentTypes.paysafecard.currencies.currency
paymentTypes.paysafecard.transactionSources.transactionSource
paymentTypes.pbba.currencies.currency
paymentTypes.pbba.transactionSources.transactionSource
paymentTypes.poli.currencies.currency
paymentTypes.poli.transactionSources.transactionSource
paymentTypes.przelewy24.currencies.currency
paymentTypes.przelewy24.transactionSources.transactionSource
paymentTypes.sepa.currencies.currency
paymentTypes.sepa.transactionSources.transactionSource
paymentTypes.sofort.countries.countryCode
paymentTypes.sofort.currencies.currency
paymentTypes.sofort.transactionSources.transactionSource
paymentTypes.trustly.countries.countryCode
paymentTypes.trustly.currencies.currency
paymentTypes.trustly.transactionSources.transactionSource
paymentTypes.unionpay.currencies.currency
paymentTypes.unionpay.transactionSources.transactionSource
paymentTypes.wechatpay.currencies.currency
paymentTypes.wechatpay.transactionSources.transactionSource
result
risk.fingerprintProvider
session.version
Fields in Gateway: Shopping Options Inquiry
request
The following fields are supported as payer input fields in the request:
correlationId
merchantCurrency
The following fields are supported as payer output fields in the response:
correlationId
error.cause
error.field
error.supportCode
error.validationType
merchant
multiCurrencyPricing.merchantCurrency
multiCurrencyPricing.providerReceipt
multiCurrencyPricing.providerResponseData
multiCurrencyPricing.quote.fxRate
multiCurrencyPricing.quote.payerCurrency
multiCurrencyPricing.quote.quoteId
multiCurrencyPricing.quote.tenor
multiCurrencyPricing.rateExpiry
Fields in Payment Plan: Item Payment Plan Offers
request
The following fields are supported as payer input fields in the request:
correlationId
currency
item.sku
item.unitPrice
The following fields are supported as payer output fields in the response:
correlationId
currency
error.cause
error.field
error.supportCode
error.validationType
item.paymentPlanOffer.cashAward.amount
item.paymentPlanOffer.cashAward.payerInstructionText
item.paymentPlanOffer.deferralPeriod
item.paymentPlanOffer.feeAmount
item.paymentPlanOffer.firstPaymentAmount
item.paymentPlanOffer.interest.discountAmount
item.paymentPlanOffer.interest.rate
item.paymentPlanOffer.numberOfPayments
item.paymentPlanOffer.paymentPlanProductId
item.paymentPlanOffer.qualifier.description
item.paymentPlanOffer.qualifier.logoUrl
item.paymentPlanOffer.subsequentPaymentAmount
item.paymentPlanOffer.totalAmount
paymentPlanProduct.logoUrl
paymentPlanProduct.name
result
Fields in Payment Plan: Update Payment Plan Offer
request
The following fields are supported as payer input fields in the request:
-
correlationId
-
paymentPlanOffer.id
-
paymentPlanOffer.payerAcceptance
-
paymentPlanOffer.termsAndConditionsDisplay
-
session.version
-
sourceOfFunds.provided.card.expiry.month
-
sourceOfFunds.provided.card.expiry.year
The following fields are supported as payer output fields in the response:
-
correlationId
-
error.cause
-
error.field
-
error.supportCode
-
error.validationType
-
order.amount
-
order.currency
-
order.item.quantity
-
order.item.sku
-
order.item.unitPrice
-
paymentPlanOffer.offerId
-
response.gatewayCode
-
result
-
serialNumbers.dueDate
-
serialNumbers.skus
-
session.version
-
sourceOfFunds.provided.card.number
Fields in Session: Retrieve Session
request
The following fields are supported as payer input fields in the request:
correlationId
The following fields are supported as payer output fields in the response:
-
agreement.amountVariability
-
agreement.id
-
agreement.maximumAmountPerPayment
-
agreement.minimumAmountPerPayment
-
agreement.numberOfPayments
-
agreement.paymentFrequency
-
agreement.type
-
authentication.3ds2.authenticationScheme
-
authentication.3ds2.custom
-
authentication.methodNotificationUrl
-
correlationId
-
error.cause
-
error.field
-
error.supportCode
-
error.validationType
-
order.amount
-
order.currency
-
order.customerNote
-
order.customerReference
-
order.invoiceNumber
-
result
-
session.updateStatus
-
session.version
-
sourceOfFunds.provided.klarnaPayLater.bankAccountCountryCode
-
sourceOfFunds.provided.paypal.accountEmail
-
sourceOfFunds.provided.paypal.accountHolder
Fields in Tokenization: Create or Update Browser Payment Token
request
The following fields are supported as payer input fields in the request:
-
correlationId
-
shipping.contact.firstName
-
shipping.contact.lastName
-
sourceOfFunds.browserPayment.type
-
sourceOfFunds.provided.bancontact.bankAccountHolder
-
sourceOfFunds.provided.blik.bankAccountHolder
-
sourceOfFunds.provided.browserPayment.additionalPayerData.id
-
sourceOfFunds.provided.browserPayment.additionalPayerData.value
-
sourceOfFunds.provided.epsUeberweisung.bankAccountCountryCode
-
sourceOfFunds.provided.epsUeberweisung.bankAccountHolder
-
sourceOfFunds.provided.grabPay.accountHolder
-
sourceOfFunds.provided.ideal.bic
-
sourceOfFunds.provided.klarnaPayLater.bankAccountCountryCode
-
sourceOfFunds.provided.klarnaPayNow.bankAccountCountryCode
-
sourceOfFunds.provided.openBankingBankTransfer.aspspId
-
sourceOfFunds.provided.payU.bankAccountCountryCode
-
sourceOfFunds.provided.payU.bankAccountHolder
-
sourceOfFunds.provided.payconiq.countryCode
-
sourceOfFunds.provided.paysafecard.countryCode
-
sourceOfFunds.provided.przelewy24.bankAccountHolder
-
sourceOfFunds.provided.sofort.bankAccountCountryCode
-
sourceOfFunds.provided.trustly.bankAccountCountryCode
-
sourceOfFunds.provided.trustly.bankAccountHolder
-
sourceOfFunds.type
The following fields are supported as payer output fields in the response:
-
browserPayment.redirectUrl
-
correlationId
-
error.cause
-
error.field
-
error.supportCode
-
error.validationType
-
sourceOfFunds.provided.klarnaPayLater.bankAccountCountryCode
Fields in Transaction: Retrieve Transaction
request
The following field is supported as payer input field in the request:
correlationId
The following fields are supported as payer output fields in the response:
-
agreement.amountVariability
-
agreement.id
-
agreement.maximumAmountPerPayment
-
agreement.minimumAmountPerPayment
-
agreement.numberOfPayments
-
agreement.paymentFrequency
-
agreement.type
-
authentication.3ds2.3dsServerTransactionId
-
authentication.3ds2.acsTransactionId
-
authentication.3ds2.authenticationScheme
-
authentication.3ds2.custom
-
authentication.3ds2.directoryServerId
-
authentication.3ds2.methodCompleted
-
authentication.3ds2.methodSupported
-
authentication.3ds2.protocolVersion
-
authentication.3ds2.sdk.challengeCompletionCallbackUrl
-
authentication.3ds2.sdk.OobAppSupportsRedirectUrl
-
authentication.3ds2.sdk.interface
-
authentication.3ds2.sdk.timeout
-
authentication.3ds2.sdk.uiType
-
authentication.payerInteraction
-
authentication.redirect.domainName
-
authentication.version
-
browserPayment.bankMessage
-
browserPayment.bankReferenceNumber
-
browserPayment.interaction.status
-
browserPayment.paypal.accountId
-
browserPayment.paypal.interactionId
-
browserPayment.redirectHtml
-
browserPayment.redirectUrl
-
correlationId
-
error.cause
-
error.field
-
error.supportCode
-
error.validationType
-
order.amount
-
order.authenticationStatus
-
order.currency
-
order.customerNote
-
order.customerReference
-
order.invoiceNumber
-
order.merchantAmount
-
order.merchantCurrency
-
order.status
-
response.acquirerCode
-
response.gatewayCode
-
response.gatewayRecommendation
-
result
-
sourceOfFunds.provided.boletoBancario.bankAccountHolder
-
sourceOfFunds.provided.boletoBancario.slipUrl
-
sourceOfFunds.provided.card.number
-
sourceOfFunds.provided.enets.bankAccountHolder
-
sourceOfFunds.provided.giropay.bankIdentifier
-
sourceOfFunds.provided.ideal.bankAccountHolder
-
sourceOfFunds.provided.klarnaPayLater.bankAccountCountryCode
-
sourceOfFunds.provided.multibanco.entityId
-
sourceOfFunds.provided.multibanco.paymentReference
-
sourceOfFunds.provided.oxxo.bankAccountHolder
-
sourceOfFunds.provided.paypal.accountEmail
-
sourceOfFunds.provided.paypal.accountHolder
-
sourceOfFunds.provided.poli.bankAccountHolder
-
sourceOfFunds.provided.sepa.bankAccountHolder
-
sourceOfFunds.provided.sepa.bic
-
sourceOfFunds.provided.sofort.bankAccountHolder
-
sourceOfFunds.provided.sofort.bankAccountNumber
-
sourceOfFunds.provided.sofort.bankIdentifier
-
sourceOfFunds.provided.weChatPay.accountHolder
-
sourceOfFunds.type
-
transaction.multiCurrencyPricing.merchantAmount
-
transaction.multiCurrencyPricing.merchantCurrency
-
version
Fields in Wallet: Create SRC Enrollment Card Object
request
The following fields are supported as payer input fields in the request:
correlationId
The following fields are supported as payer output fields in the response:
-
card.scheme
-
correlationId
-
encryptedCardObject
-
error.cause
-
error.field
-
error.supportCode
-
error.validationType
-
result
-
session.id