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.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.amountVariabilityagreement.maximumAmountPerPaymentagreement.minimumAmountPerPaymentagreement.numberOfPaymentsagreement.paymentFrequencycorrelationIdcustomer.emailsession.versionshipping.contact.emailshipping.contact.firstNameshipping.contact.lastNameshipping.contact.mobilePhoneshipping.contact.phone
The following fields are supported as payer output fields in the response:
agreement.amountVariabilityagreement.idagreement.maximumAmountPerPaymentagreement.minimumAmountPerPaymentagreement.numberOfPaymentsagreement.paymentFrequencyagreement.typeauthentication.3ds2.3dsServerTransactionIdauthentication.3ds2.acsTransactionIdauthentication.3ds2.authenticationSchemeauthentication.3ds2.customauthentication.3ds2.directoryServerIdauthentication.3ds2.methodCompletedauthentication.3ds2.methodSupportedauthentication.3ds2.protocolVersionauthentication.3ds2.sdk.challengeCompletionCallbackUrlauthentication.3ds2.sdk.interfaceauthentication.3ds2.sdk.timeoutauthentication.3ds2.sdk.uiTypeauthentication.payerInteractionauthentication.redirect.domainNameauthentication.versionbrowserPayment.bankMessagebrowserPayment.bankReferenceNumberbrowserPayment.interaction.statusbrowserPayment.paypal.accountIdbrowserPayment.paypal.interactionIdbrowserPayment.redirectHtmlbrowserPayment.redirectUrlcorrelationIderror.causeerror.fielderror.supportCodeerror.validationTypeorder.amountorder.authenticationStatusorder.currencyorder.customerNoteorder.customerReferenceorder.invoiceNumberorder.merchantAmountorder.merchantCurrencyorder.statusresponse.acquirerCoderesponse.gatewayCoderesponse.gatewayRecommendationresultsession.versionsourceOfFunds.provided.boletoBancario.bankAccountHoldersourceOfFunds.provided.boletoBancario.slipUrlsourceOfFunds.provided.card.numbersourceOfFunds.provided.enets.bankAccountHoldersourceOfFunds.provided.giropay.bankIdentifiersourceOfFunds.provided.ideal.bankAccountHoldersourceOfFunds.provided.klarnaPayLater.bankAccountCountryCodesourceOfFunds.provided.multibanco.entityIdsourceOfFunds.provided.multibanco.paymentReferencesourceOfFunds.provided.oxxo.bankAccountHoldersourceOfFunds.provided.paypal.accountEmailsourceOfFunds.provided.paypal.accountHoldersourceOfFunds.provided.poli.bankAccountHoldersourceOfFunds.provided.sepa.bankAccountHoldersourceOfFunds.provided.sepa.bicsourceOfFunds.provided.sofort.bankAccountHoldersourceOfFunds.provided.sofort.bankAccountNumbersourceOfFunds.provided.sofort.bankIdentifiersourceOfFunds.provided.weChatPay.accountHoldersourceOfFunds.typetransaction.multiCurrencyPricing.merchantAmounttransaction.multiCurrencyPricing.merchantCurrencyversion
Fields in Browser Payment: Initiate request
The following fields are supported as payer input fields in the request:
agreement.amountVariabilityagreement.maximumAmountPerPaymentagreement.minimumAmountPerPaymentagreement.numberOfPaymentsagreement.paymentFrequencybilling.address.citybilling.address.companybilling.address.countrybilling.address.postcodeZipbilling.address.stateProvincebilling.address.stateProvinceCodebilling.address.streetbilling.address.street2browserPayment.openBankingBankTransfer.refundConsentcorrelationIdcustomer.dateOfBirthcustomer.emailcustomer.firstNamecustomer.lastNamecustomer.mobilePhonecustomer.nationalIdcustomer.phonedevice.browserdevice.fingerprintdevice.hostnamedevice.ipAddressdevice.mobilePhoneModelsession.versionshipping.contact.emailshipping.contact.firstNameshipping.contact.lastNameshipping.contact.mobilePhoneshipping.contact.phonesourceOfFunds.browserPayment.typesourceOfFunds.provided.bancontact.bankAccountHoldersourceOfFunds.provided.blik.bankAccountHoldersourceOfFunds.provided.boletoBancario.bankAccountHoldersourceOfFunds.provided.browserPayment.additionalPayerData.idsourceOfFunds.provided.browserPayment.additionalPayerData.valuesourceOfFunds.provided.card.devicePayment.cryptogramFormatsourceOfFunds.provided.card.expiry.monthsourceOfFunds.provided.card.expiry.yearsourceOfFunds.provided.card.nameOnCardsourceOfFunds.provided.enets.bankAccountHoldersourceOfFunds.provided.epsUeberweisung.bankAccountCountryCodesourceOfFunds.provided.epsUeberweisung.bankAccountHoldersourceOfFunds.provided.giropay.bankIdentifiersourceOfFunds.provided.giropay.bicsourceOfFunds.provided.grabPay.accountHoldersourceOfFunds.provided.ideal.bicsourceOfFunds.provided.klarnaPayLater.bankAccountCountryCodesourceOfFunds.provided.klarnaPayNow.bankAccountCountryCodesourceOfFunds.provided.openBankingBankTransfer.aspspIdsourceOfFunds.provided.oxxo.bankAccountHoldersourceOfFunds.provided.payU.bankAccountCountryCodesourceOfFunds.provided.payU.bankAccountHoldersourceOfFunds.provided.payconiq.countryCodesourceOfFunds.provided.paysafecard.countryCodesourceOfFunds.provided.poli.bankAccountHoldersourceOfFunds.provided.przelewy24.bankAccountHoldersourceOfFunds.provided.sepa.bankAccountHoldersourceOfFunds.provided.sepa.ibansourceOfFunds.provided.sofort.bankAccountCountryCodesourceOfFunds.provided.trustly.bankAccountCountryCodesourceOfFunds.provided.trustly.bankAccountHoldersourceOfFunds.provided.weChatPay.accountHoldersourceOfFunds.type
The following fields are supported as payer output fields in the response:
agreement.amountVariabilityagreement.idagreement.maximumAmountPerPaymentagreement.minimumAmountPerPaymentagreement.numberOfPaymentsagreement.paymentFrequencyagreement.typeauthentication.3ds2.3dsServerTransactionIdauthentication.3ds2.acsTransactionIdauthentication.3ds2.authenticationSchemeauthentication.3ds2.customauthentication.3ds2.directoryServerIdauthentication.3ds2.methodCompletedauthentication.3ds2.methodSupportedauthentication.3ds2.protocolVersionauthentication.3ds2.sdk.challengeCompletionCallbackUrlauthentication.3ds2.sdk.interfaceauthentication.3ds2.sdk.timeoutauthentication.3ds2.sdk.uiTypeauthentication.payerInteractionauthentication.redirect.domainNameauthentication.versionbrowserPayment.bankMessagebrowserPayment.bankReferenceNumberbrowserPayment.interaction.statusbrowserPayment.paypal.accountIdbrowserPayment.paypal.interactionIdbrowserPayment.redirectHtmlbrowserPayment.redirectUrlcorrelationIderror.causeerror.fielderror.supportCodeerror.validationTypeorder.amountorder.authenticationStatusorder.currencyorder.customerNoteorder.customerReferenceorder.invoiceNumberorder.merchantAmountorder.merchantCurrencyorder.statusresponse.acquirerCoderesponse.gatewayCoderesponse.gatewayRecommendationresultsession.versionsourceOfFunds.provided.boletoBancario.bankAccountHoldersourceOfFunds.provided.boletoBancario.slipUrlsourceOfFunds.provided.card.numbersourceOfFunds.provided.enets.bankAccountHoldersourceOfFunds.provided.giropay.bankIdentifiersourceOfFunds.provided.ideal.bankAccountHoldersourceOfFunds.provided.klarnaPayLater.bankAccountCountryCodesourceOfFunds.provided.multibanco.entityIdsourceOfFunds.provided.multibanco.paymentReferencesourceOfFunds.provided.oxxo.bankAccountHoldersourceOfFunds.provided.paypal.accountEmailsourceOfFunds.provided.paypal.accountHoldersourceOfFunds.provided.poli.bankAccountHoldersourceOfFunds.provided.sepa.bankAccountHoldersourceOfFunds.provided.sepa.bicsourceOfFunds.provided.sofort.bankAccountHoldersourceOfFunds.provided.sofort.bankAccountNumbersourceOfFunds.provided.sofort.bankIdentifiersourceOfFunds.provided.weChatPay.accountHoldersourceOfFunds.typetransaction.multiCurrencyPricing.merchantAmounttransaction.multiCurrencyPricing.merchantCurrencyversion
Fields in Browser Payment: Update request
The following fields are supported as payer input fields in the request:
correlationIdsession.version
The following fields are supported as payer output fields in the response:
agreement.amountVariabilityagreement.idagreement.maximumAmountPerPaymentagreement.minimumAmountPerPaymentagreement.numberOfPaymentsagreement.paymentFrequencyagreement.typeauthentication.3ds2.3dsServerTransactionIdauthentication.3ds2.acsTransactionIdauthentication.3ds2.authenticationSchemeauthentication.3ds2.customauthentication.3ds2.directoryServerIdauthentication.3ds2.methodCompletedauthentication.3ds2.methodSupportedauthentication.3ds2.protocolVersionauthentication.3ds2.sdk.challengeCompletionCallbackUrlauthentication.3ds2.sdk.interfaceauthentication.3ds2.sdk.timeoutauthentication.3ds2.sdk.uiTypeauthentication.payerInteractionauthentication.redirect.domainNameauthentication.versionbrowserPayment.bankMessagebrowserPayment.bankReferenceNumberbrowserPayment.interaction.statusbrowserPayment.paypal.accountIdbrowserPayment.paypal.interactionIdbrowserPayment.redirectHtmlbrowserPayment.redirectUrlcorrelationIderror.causeerror.fielderror.supportCodeerror.validationTypeorder.amountorder.authenticationStatusorder.currencyorder.customerNoteorder.customerReferenceorder.invoiceNumberorder.merchantAmountorder.merchantCurrencyorder.statusresponse.acquirerCoderesponse.gatewayCoderesponse.gatewayRecommendationresultsession.versionsourceOfFunds.provided.boletoBancario.bankAccountHoldersourceOfFunds.provided.boletoBancario.slipUrlsourceOfFunds.provided.card.numbersourceOfFunds.provided.enets.bankAccountHoldersourceOfFunds.provided.giropay.bankIdentifiersourceOfFunds.provided.ideal.bankAccountHoldersourceOfFunds.provided.klarnaPayLater.bankAccountCountryCodesourceOfFunds.provided.multibanco.entityIdsourceOfFunds.provided.multibanco.paymentReferencesourceOfFunds.provided.oxxo.bankAccountHoldersourceOfFunds.provided.paypal.accountEmailsourceOfFunds.provided.paypal.accountHoldersourceOfFunds.provided.poli.bankAccountHoldersourceOfFunds.provided.sepa.bankAccountHoldersourceOfFunds.provided.sepa.bicsourceOfFunds.provided.sofort.bankAccountHoldersourceOfFunds.provided.sofort.bankAccountNumbersourceOfFunds.provided.sofort.bankIdentifiersourceOfFunds.provided.weChatPay.accountHoldersourceOfFunds.typetransaction.multiCurrencyPricing.merchantAmounttransaction.multiCurrencyPricing.merchantCurrencyversion
Fields in Gateway: Payment Options Inquiry request
The following fields are supported as payer input fields in the request:
correlationIdgatewayEntryPointinteraction.operationlocalesession.versionsourceOfFunds.provided.card.prefixsourceOfFunds.tokentransactionSource
The following fields are supported as payer output fields in the response:
correlationIdcustomdisclosureStatements.chargeTypedisclosureStatements.localedisclosureStatements.statementerror.causeerror.fielderror.supportCodeerror.validationTypegatewayEntryPointmerchantorder.amountorder.currencyorder.item.quantityorder.item.serialNumbersorder.item.skuorder.item.unitPriceorder.itemAmountorder.merchantCharge.amountorder.merchantCharge.cardBrandorder.merchantCharge.fixedAmountorder.merchantCharge.fundingMethodorder.merchantCharge.maximumFixedAmountorder.merchantCharge.maximumOrderAmountorder.merchantCharge.maximumPercentAmountorder.merchantCharge.minimumOrderAmountorder.merchantCharge.percentorder.merchantCharge.typeorder.netAmountorder.surchargeAmountpayerLocalepaymentPlanProduct.logoUrlpaymentPlanProduct.namepaymentPlanProduct.paymentPlanProductIdpaymentTypes.ach.currencies.currencypaymentTypes.ach.transactionSources.transactionSourcepaymentTypes.alipay.currencies.currencypaymentTypes.alipay.transactionSources.transactionSourcepaymentTypes.bancanet.currencies.currencypaymentTypes.bancanet.transactionSources.transactionSourcepaymentTypes.bancontact.currencies.currencypaymentTypes.bancontact.transactionSources.transactionSourcepaymentTypes.blik.currencies.currencypaymentTypes.blik.transactionSources.transactionSourcepaymentTypes.boletobancario.acquirerpaymentTypes.boletobancario.currencies.currencypaymentTypes.boletobancario.transactionSources.transactionSourcepaymentTypes.browserPayment.additionalPayerData.display.errorMessageTextpaymentTypes.browserPayment.additionalPayerData.display.fieldLabelpaymentTypes.browserPayment.additionalPayerData.display.helpTextpaymentTypes.browserPayment.additionalPayerData.display.localepaymentTypes.browserPayment.additionalPayerData.idpaymentTypes.browserPayment.additionalPayerData.validation.allowedCharacterSetpaymentTypes.browserPayment.additionalPayerData.validation.maximumLengthpaymentTypes.browserPayment.additionalPayerData.validation.minimumLengthpaymentTypes.browserPayment.additionalPayerData.validation.presencepaymentTypes.browserPayment.additionalPayerData.validation.regularExpressionpaymentTypes.browserPayment.currencies.currencypaymentTypes.browserPayment.descriptionpaymentTypes.browserPayment.displayNamepaymentTypes.browserPayment.logoUrlpaymentTypes.browserPayment.paymentPlanOffer.currencypaymentTypes.browserPayment.paymentPlanOffer.customerFeepaymentTypes.browserPayment.paymentPlanOffer.interestRatepaymentTypes.browserPayment.paymentPlanOffer.lateFeepaymentTypes.browserPayment.paymentPlanOffer.paymentAmountpaymentTypes.browserPayment.paymentPlanOffer.timeBetweenPayments.countpaymentTypes.browserPayment.paymentPlanOffer.timeBetweenPayments.unitOfMeasurepaymentTypes.browserPayment.standardPayerData.fieldNamepaymentTypes.browserPayment.standardPayerData.presencepaymentTypes.browserPayment.supportedCountries.countrypaymentTypes.browserPayment.transactionSources.transactionSourcepaymentTypes.browserPayment.typepaymentTypes.card.3DSecureSchemes.3DSecureSchemepaymentTypes.card.brandpaymentTypes.card.capabilities.capabilitypaymentTypes.card.cardTypes.cardTypepaymentTypes.card.cardTypes.schemeTokenTypespaymentTypes.card.currencies.currencypaymentTypes.card.currencyConversion.exchangeRateSourcepaymentTypes.card.currencyConversion.exchangeRateTimepaymentTypes.card.currencyConversion.gatewayCodepaymentTypes.card.currencyConversion.marginPercentagepaymentTypes.card.currencyConversion.offerTextpaymentTypes.card.currencyConversion.payerAmountpaymentTypes.card.currencyConversion.payerCurrencypaymentTypes.card.currencyConversion.payerExchangeRatepaymentTypes.card.currencyConversion.providerpaymentTypes.card.currencyConversion.providerCodepaymentTypes.card.currencyConversion.providerReceiptpaymentTypes.card.currencyConversion.quoteExpirypaymentTypes.card.currencyConversion.requestIdpaymentTypes.card.defaultCardTypepaymentTypes.card.fundingMethodpaymentTypes.card.interactionConstraintspaymentTypes.card.issuerpaymentTypes.card.localBrandpaymentTypes.card.paymentPlanOffer.cashAward.amountpaymentTypes.card.paymentPlanOffer.cashAward.payerInstructionTextpaymentTypes.card.paymentPlanOffer.currencypaymentTypes.card.paymentPlanOffer.deferralPeriodpaymentTypes.card.paymentPlanOffer.endDatepaymentTypes.card.paymentPlanOffer.feeAmountpaymentTypes.card.paymentPlanOffer.firstPaymentAmountpaymentTypes.card.paymentPlanOffer.idpaymentTypes.card.paymentPlanOffer.interest.chargedpaymentTypes.card.paymentPlanOffer.interest.discountAmountpaymentTypes.card.paymentPlanOffer.interest.ratepaymentTypes.card.paymentPlanOffer.minimumOrderAmountpaymentTypes.card.paymentPlanOffer.numberOfPaymentspaymentTypes.card.paymentPlanOffer.paymentPlanProductIdpaymentTypes.card.paymentPlanOffer.planTemplatepaymentTypes.card.paymentPlanOffer.qualifier.descriptionpaymentTypes.card.paymentPlanOffer.qualifier.logoUrlpaymentTypes.card.paymentPlanOffer.startDatepaymentTypes.card.paymentPlanOffer.subsequentPaymentAmountpaymentTypes.card.paymentPlanOffer.termsAndConditions.acceptanceRequiredpaymentTypes.card.paymentPlanOffer.termsAndConditions.acceptanceTextpaymentTypes.card.paymentPlanOffer.termsAndConditions.textpaymentTypes.card.paymentPlanOffer.totalAmountpaymentTypes.card.schemepaymentTypes.card.tagspaymentTypes.card.transactionSources.transactionSourcepaymentTypes.card.walletProviders.secureRemoteCommerce.defaultPayerCountrypaymentTypes.card.walletProviders.secureRemoteCommerce.scheme.dpaIdpaymentTypes.card.walletProviders.secureRemoteCommerce.scheme.namepaymentTypes.card.walletProviders.secureRemoteCommerce.shippingAddressCountriespaymentTypes.card.walletProviders.secureRemoteCommerce.srcVersionpaymentTypes.card.walletProviders.walletProviderpaymentTypes.directDebitCanada.currencies.currencypaymentTypes.directDebitCanada.transactionSources.transactionSourcepaymentTypes.enets.currencies.currencypaymentTypes.enets.transactionSources.transactionSourcepaymentTypes.epsUeberweisung.countries.countryCodepaymentTypes.epsUeberweisung.currencies.currencypaymentTypes.epsUeberweisung.transactionSources.transactionSourcepaymentTypes.giftCard.cardTypes.cardTypepaymentTypes.giftCard.currencies.currencypaymentTypes.giftCard.transactionSources.transactionSourcepaymentTypes.giropay.currencies.currencypaymentTypes.giropay.transactionSources.transactionSourcepaymentTypes.grabPay.currencies.currencypaymentTypes.grabPay.transactionSources.transactionSourcepaymentTypes.ideal.currencies.currencypaymentTypes.ideal.transactionSources.transactionSourcepaymentTypes.klarnaFinancing.currencies.currencypaymentTypes.klarnaFinancing.transactionSources.transactionSourcepaymentTypes.klarnaPayLater.countries.countryCodepaymentTypes.klarnaPayLater.currencies.currencypaymentTypes.klarnaPayLater.transactionSources.transactionSourcepaymentTypes.klarnaPayNow.countries.countryCodepaymentTypes.klarnaPayNow.currencies.currencypaymentTypes.klarnaPayNow.transactionSources.transactionSourcepaymentTypes.mercadoPagoCheckout.currencies.currencypaymentTypes.moMoPay.currencies.currencypaymentTypes.moMoPay.transactionSources.transactionSourcepaymentTypes.multibanco.currencies.currencypaymentTypes.multibanco.transactionSources.transactionSourcepaymentTypes.openBankingBankTransfer.aspsp.other.idpaymentTypes.openBankingBankTransfer.aspsp.other.namepaymentTypes.openBankingBankTransfer.aspsp.preferred.idpaymentTypes.openBankingBankTransfer.aspsp.preferred.logoUrlpaymentTypes.openBankingBankTransfer.aspsp.preferred.namepaymentTypes.openBankingBankTransfer.capabilities.capabilitypaymentTypes.oxxo.currencies.currencypaymentTypes.oxxo.transactionSources.transactionSourcepaymentTypes.payU.countries.countryCodepaymentTypes.payU.currencies.currencypaymentTypes.payU.transactionSources.transactionSourcepaymentTypes.payconiq.countries.countryCodepaymentTypes.payconiq.currencies.currencypaymentTypes.payconiq.transactionSources.transactionSourcepaymentTypes.paypal.accountIdpaymentTypes.paypal.capabilities.capabilitypaymentTypes.paypal.clientIdpaymentTypes.paypal.currencies.currencypaymentTypes.paypal.transactionSources.transactionSourcepaymentTypes.paysafecard.countries.countryCodepaymentTypes.paysafecard.currencies.currencypaymentTypes.paysafecard.transactionSources.transactionSourcepaymentTypes.pbba.currencies.currencypaymentTypes.pbba.transactionSources.transactionSourcepaymentTypes.poli.currencies.currencypaymentTypes.poli.transactionSources.transactionSourcepaymentTypes.przelewy24.currencies.currencypaymentTypes.przelewy24.transactionSources.transactionSourcepaymentTypes.sepa.currencies.currencypaymentTypes.sepa.transactionSources.transactionSourcepaymentTypes.sofort.countries.countryCodepaymentTypes.sofort.currencies.currencypaymentTypes.sofort.transactionSources.transactionSourcepaymentTypes.trustly.countries.countryCodepaymentTypes.trustly.currencies.currencypaymentTypes.trustly.transactionSources.transactionSourcepaymentTypes.unionpay.currencies.currencypaymentTypes.unionpay.transactionSources.transactionSourcepaymentTypes.wechatpay.currencies.currencypaymentTypes.wechatpay.transactionSources.transactionSourceresultrisk.fingerprintProvidersession.version
Fields in Gateway: Shopping Options Inquiry request
The following fields are supported as payer input fields in the request:
correlationIdmerchantCurrency
The following fields are supported as payer output fields in the response:
correlationIderror.causeerror.fielderror.supportCodeerror.validationTypemerchantmultiCurrencyPricing.merchantCurrencymultiCurrencyPricing.providerReceiptmultiCurrencyPricing.providerResponseDatamultiCurrencyPricing.quote.fxRatemultiCurrencyPricing.quote.payerCurrencymultiCurrencyPricing.quote.quoteIdmultiCurrencyPricing.quote.tenormultiCurrencyPricing.rateExpiry
Fields in Payment Plan: Item Payment Plan Offers request
The following fields are supported as payer input fields in the request:
correlationIdcurrencyitem.skuitem.unitPrice
The following fields are supported as payer output fields in the response:
correlationIdcurrencyerror.causeerror.fielderror.supportCodeerror.validationTypeitem.paymentPlanOffer.cashAward.amountitem.paymentPlanOffer.cashAward.payerInstructionTextitem.paymentPlanOffer.deferralPerioditem.paymentPlanOffer.feeAmountitem.paymentPlanOffer.firstPaymentAmountitem.paymentPlanOffer.interest.discountAmountitem.paymentPlanOffer.interest.rateitem.paymentPlanOffer.numberOfPaymentsitem.paymentPlanOffer.paymentPlanProductIditem.paymentPlanOffer.qualifier.descriptionitem.paymentPlanOffer.qualifier.logoUrlitem.paymentPlanOffer.subsequentPaymentAmountitem.paymentPlanOffer.totalAmountpaymentPlanProduct.logoUrlpaymentPlanProduct.nameresult
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 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.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 -
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