Payment Options Inquiry
Request to retrieve the payment options you can present to the payer, for example, the available payment methods and card types.
The returned options depend on your merchant profile configuration in the gateway and your input.For example, when you provide the order currency in the request, the response only contains payment options that are available for orders with this currency.
If you do not provide any input parameters, all values that could apply for all fields are returned: all of the possible card types, all of the possible currencies, and so on.
Depending on your configuration and the input parameters the response may also contain
- a rate quote for Dynamic Currency Conversion.
- the applicable Surcharge for the order.
- the applicable Payment Plan Offers for the cart or the order.
Usage Note
You may not need to use this operation if your merchant profile configuration rarely changes and therefore the available payment options can be hard-coded into your website.
However, the operation will allow you to build the presentation and input validation for your checkout process in a dynamic way. As you are collecting more details from the payer during the checkout process, the operation tells you what fields to collect and what validation to apply.
If you have a simple configuration (for example, only accept a list of card types for s single currency), you can use the unmodified data set returned if the request is called without any input parameters for building the website's presentation and input validation.
If you have a more complex configuration (for example, accept USD and EUR currencies on Mastercard and Visa, but only USD on American Express), call the operation with parameters to restrict the returned values. For example:
- If a sourceOfFunds.provided.card.prefix is passed in, only currencies applicable to the card brand identified based on this prefix are returned.
- If an order.currency is passed in, only payment options applicable for that currency are returned.
Warning This operation must not be called directly from the browser, as it would expose your API integration password.
URL | https://test-nbkpayment.mtf.gateway.mastercard.com/api/rest/version/81/merchant/{merchantId}/paymentOptionsInquiry |
HTTP Method | POST |
Authentication |
This operation requires authentication via one of the following methods:
|
Request Parameters
correlationId String = OPTIONAL
gatewayEntryPoint Enumeration = OPTIONAL
interaction = OPTIONAL
interaction.operation Enumeration = OPTIONAL
locale String = OPTIONAL
See Dynamic Currency Conversion for more detail.
order = OPTIONAL
order.amount Decimal = OPTIONAL
order.currency Upper case alphabetic text = OPTIONAL
order.merchantCharge.type Enumeration = OPTIONAL
order.netAmount Decimal = OPTIONAL
paymentType Enumeration = OPTIONAL
session.id ASCII Text = OPTIONAL
session.version ASCII Text = OPTIONAL
To use optimistic locking, record session.version when you make your decisions, and then pass that value in session.version when you submit your request operation to the gateway.
If session.version provided by you does not match that stored against the session, the gateway will reject the operation with error.cause=INVALID_REQUEST.
See Making Business Decisions Based on Session Content.
sourceOfFunds = OPTIONAL
For card payments the source of funds information may be represented by combining one or more of the following: explicitly provided card details, a session identifier which the gateway will use to look up the card details and/or a card token. Precedence rules will be applied in that explicitly provided card details will override session card details which will override card token details. Each of these may represent partial card details, however the combination must result in a full and complete set of card details. See Using Multiple Sources of Card Details for examples.
sourceOfFunds.provided.card.p2pe = OPTIONAL
sourceOfFunds.provided.card.p2pe.cardBin Digits = OPTIONAL
If you do not provided this, the gateway will not perform this check.
sourceOfFunds.provided.card.p2pe.encryptionState String = OPTIONAL
sourceOfFunds.provided.card.p2pe.initializationVector Hex = OPTIONAL
sourceOfFunds.provided.card.p2pe.keySerialNumber Hex = COMPULSORY
sourceOfFunds.provided.card.p2pe.payload Hex = COMPULSORY
sourceOfFunds.provided.card.prefix Digits = OPTIONAL
sourceOfFunds.token Alphanumeric = OPTIONAL
If account identifier details are also contained in the request, or the request contains a session with account identifier details, these take precedence over the details stored against the token.
transactionSource Enumeration = OPTIONAL
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
{merchantId} Alphanumeric + additional characters COMPULSORY
Response Parameters
merchant Alphanumeric + additional characters = Always Provided
result Enumeration = Always Provided
correlationId String = CONDITIONAL
custom JSON Text = CONDITIONAL
gatewayEntryPoint Enumeration = CONDITIONAL
merchant Alphanumeric + additional characters = Always Provided
order.amount Decimal = CONDITIONAL
order.currency Upper case alphabetic text = CONDITIONAL
order.merchantCharge = CONDITIONAL
order.merchantCharge.amount Decimal = Always Provided
order.merchantCharge.type Enumeration = Always Provided
order.netAmount Decimal = CONDITIONAL
order.surchargeAmount Decimal = CONDITIONAL
paymentPlanProduct = CONDITIONAL
paymentPlanProduct.{paymentPlanProductId}.logoUrl URI = CONDITIONAL
paymentPlanProduct.{paymentPlanProductId}.name String = CONDITIONAL
paymentPlanProduct.{paymentPlanProductId} Alphanumeric + additional characters = CONDITIONAL
See Payment Plans for the supported payment plans and their identifiers.
paymentTypes = CONDITIONAL
paymentTypes.ach = CONDITIONAL
paymentTypes.ach.currencies[n] = CONDITIONAL
paymentTypes.ach.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.ach.transactionSources[n] = CONDITIONAL
paymentTypes.ach.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.alipay = CONDITIONAL
paymentTypes.alipay.currencies[n] = CONDITIONAL
paymentTypes.alipay.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.alipay.transactionSources[n] = CONDITIONAL
paymentTypes.alipay.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.bancanet = CONDITIONAL
paymentTypes.bancanet.currencies[n] = CONDITIONAL
paymentTypes.bancanet.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.bancanet.transactionSources[n] = CONDITIONAL
paymentTypes.bancanet.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.bancontact = CONDITIONAL
paymentTypes.bancontact.currencies[n] = CONDITIONAL
paymentTypes.bancontact.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.bancontact.transactionSources[n] = CONDITIONAL
paymentTypes.bancontact.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.blik = CONDITIONAL
paymentTypes.blik.currencies[n] = CONDITIONAL
paymentTypes.blik.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.blik.transactionSources[n] = CONDITIONAL
paymentTypes.blik.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.boletobancario = CONDITIONAL
paymentTypes.boletobancario.currencies[n] = CONDITIONAL
paymentTypes.boletobancario.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.boletobancario.transactionSources[n] = CONDITIONAL
paymentTypes.boletobancario.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.card = CONDITIONAL
paymentTypes.card.3DSecureSchemes[n] = CONDITIONAL
paymentTypes.card.3DSecureSchemes[n].3DSecureScheme Enumeration = Always Provided
paymentTypes.card.brand Enumeration = CONDITIONAL
You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.
paymentTypes.card.capabilities[n] = CONDITIONAL
paymentTypes.card.capabilities[n].capability Enumeration = Always Provided
paymentTypes.card.cardTypes[n] = CONDITIONAL
paymentTypes.card.cardTypes[n].cardType String = Always Provided
paymentTypes.card.currencies[n] = CONDITIONAL
paymentTypes.card.currencyConversion = CONDITIONAL
paymentTypes.card.currencyConversion.exchangeRateSource String = CONDITIONAL
paymentTypes.card.currencyConversion.exchangeRateTime DateTime = CONDITIONAL
paymentTypes.card.currencyConversion.gatewayCode Enumeration = Always Provided
paymentTypes.card.currencyConversion.marginPercentage Decimal = CONDITIONAL
paymentTypes.card.currencyConversion.offerText String = CONDITIONAL
paymentTypes.card.currencyConversion.payerAmount Decimal = CONDITIONAL
paymentTypes.card.currencyConversion.payerCurrency Upper case alphabetic text = CONDITIONAL
paymentTypes.card.currencyConversion.payerExchangeRate Decimal = CONDITIONAL
paymentTypes.card.currencyConversion.provider Enumeration = CONDITIONAL
paymentTypes.card.currencyConversion.providerCode ASCII Text = CONDITIONAL
paymentTypes.card.currencyConversion.providerReceipt String = CONDITIONAL
paymentTypes.card.currencyConversion.quoteExpiry DateTime = CONDITIONAL
paymentTypes.card.currencyConversion.requestId String = CONDITIONAL
paymentTypes.card.defaultCardType String = CONDITIONAL
paymentTypes.card.fundingMethod Enumeration = CONDITIONAL
paymentTypes.card.interactionConstraints Comma separated enumeration = CONDITIONAL
paymentTypes.card.issuer String = CONDITIONAL
paymentTypes.card.localBrand String = CONDITIONAL
You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.
paymentTypes.card.scheme Enumeration = CONDITIONAL
paymentTypes.card.transactionSources[n] = CONDITIONAL
paymentTypes.card.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.card.walletProviders[n] = CONDITIONAL
paymentTypes.card.walletProviders[n].secureRemoteCommerce = CONDITIONAL
paymentTypes.card.walletProviders[n].secureRemoteCommerce.defaultPayerCountry Upper case alphabetic text = CONDITIONAL
paymentTypes.card.walletProviders[n].secureRemoteCommerce.scheme[n] = CONDITIONAL
paymentTypes.card.walletProviders[n].secureRemoteCommerce.scheme[n].dpaId String = Always Provided
paymentTypes.card.walletProviders[n].secureRemoteCommerce.scheme[n].name Enumeration = Always Provided
paymentTypes.card.walletProviders[n].secureRemoteCommerce.shippingAddressCountries Comma separated strings = CONDITIONAL
paymentTypes.card.walletProviders[n].walletProvider Enumeration = Always Provided
- Device payment methods such as Apple Pay, Android Pay, Samsung Pay, or Google Pay.
- Digital wallets such as Masterpass, Visa Checkout or Amex Express Checkout.
paymentTypes.directDebitCanada = CONDITIONAL
paymentTypes.directDebitCanada.currencies[n] = CONDITIONAL
paymentTypes.directDebitCanada.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.directDebitCanada.transactionSources[n] = CONDITIONAL
paymentTypes.directDebitCanada.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.enets = CONDITIONAL
paymentTypes.enets.currencies[n] = CONDITIONAL
paymentTypes.enets.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.enets.transactionSources[n] = CONDITIONAL
paymentTypes.enets.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.epsUeberweisung = CONDITIONAL
paymentTypes.epsUeberweisung.countries[n] = CONDITIONAL
paymentTypes.epsUeberweisung.countries[n].countryCode Upper case alphabetic text = CONDITIONAL
paymentTypes.epsUeberweisung.currencies[n] = CONDITIONAL
paymentTypes.epsUeberweisung.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.epsUeberweisung.transactionSources[n] = CONDITIONAL
paymentTypes.epsUeberweisung.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.giftCard = CONDITIONAL
paymentTypes.giftCard.cardTypes[n] = CONDITIONAL
paymentTypes.giftCard.cardTypes[n].cardType String = Always Provided
paymentTypes.giftCard.currencies[n] = CONDITIONAL
paymentTypes.giftCard.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.giftCard.transactionSources[n] = CONDITIONAL
paymentTypes.giftCard.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.giropay = CONDITIONAL
paymentTypes.giropay.currencies[n] = CONDITIONAL
paymentTypes.giropay.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.giropay.transactionSources[n] = CONDITIONAL
paymentTypes.giropay.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.grabPay = CONDITIONAL
paymentTypes.grabPay.currencies[n] = CONDITIONAL
paymentTypes.grabPay.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.grabPay.transactionSources[n] = CONDITIONAL
paymentTypes.grabPay.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.ideal = CONDITIONAL
paymentTypes.ideal.currencies[n] = CONDITIONAL
paymentTypes.ideal.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.ideal.transactionSources[n] = CONDITIONAL
paymentTypes.ideal.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.klarnaFinancing = CONDITIONAL
paymentTypes.klarnaFinancing.currencies[n] = CONDITIONAL
paymentTypes.klarnaFinancing.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.klarnaFinancing.transactionSources[n] = CONDITIONAL
paymentTypes.klarnaFinancing.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.klarnaPayLater = CONDITIONAL
paymentTypes.klarnaPayLater.countries[n] = CONDITIONAL
paymentTypes.klarnaPayLater.countries[n].countryCode Upper case alphabetic text = CONDITIONAL
paymentTypes.klarnaPayLater.currencies[n] = CONDITIONAL
paymentTypes.klarnaPayLater.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.klarnaPayLater.transactionSources[n] = CONDITIONAL
paymentTypes.klarnaPayLater.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.klarnaPayNow = CONDITIONAL
paymentTypes.klarnaPayNow.countries[n] = CONDITIONAL
paymentTypes.klarnaPayNow.countries[n].countryCode Upper case alphabetic text = CONDITIONAL
paymentTypes.klarnaPayNow.currencies[n] = CONDITIONAL
paymentTypes.klarnaPayNow.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.klarnaPayNow.transactionSources[n] = CONDITIONAL
paymentTypes.klarnaPayNow.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.mercadoPagoCheckout = CONDITIONAL
paymentTypes.mercadoPagoCheckout.currencies[n] = CONDITIONAL
paymentTypes.mercadoPagoCheckout.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.multibanco = CONDITIONAL
paymentTypes.multibanco.currencies[n] = CONDITIONAL
paymentTypes.multibanco.transactionSources[n] = CONDITIONAL
paymentTypes.openBankingBankTransfer = CONDITIONAL
paymentTypes.openBankingBankTransfer.capabilities[n] = CONDITIONAL
paymentTypes.openBankingBankTransfer.capabilities[n].capability Enumeration = Always Provided
paymentTypes.oxxo = CONDITIONAL
paymentTypes.oxxo.currencies[n] = CONDITIONAL
paymentTypes.oxxo.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.oxxo.transactionSources[n] = CONDITIONAL
paymentTypes.oxxo.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.payU = CONDITIONAL
paymentTypes.payU.countries[n] = CONDITIONAL
paymentTypes.payU.countries[n].countryCode Upper case alphabetic text = CONDITIONAL
paymentTypes.payU.currencies[n] = CONDITIONAL
paymentTypes.payU.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.payU.transactionSources[n] = CONDITIONAL
paymentTypes.payU.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.payconiq = Always Provided
paymentTypes.payconiq.countries[n] = CONDITIONAL
paymentTypes.payconiq.countries[n].countryCode Upper case alphabetic text = CONDITIONAL
paymentTypes.payconiq.currencies[n] = CONDITIONAL
paymentTypes.payconiq.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.payconiq.transactionSources[n] = CONDITIONAL
paymentTypes.payconiq.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.paypal = CONDITIONAL
paymentTypes.paypal.accountId String = Always Provided
paymentTypes.paypal.capabilities[n] = CONDITIONAL
paymentTypes.paypal.capabilities[n].capability Enumeration = Always Provided
paymentTypes.paypal.clientId String = Always Provided
paymentTypes.paypal.currencies[n] = CONDITIONAL
paymentTypes.paypal.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.paypal.transactionSources[n] = CONDITIONAL
paymentTypes.paypal.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.paysafecard = CONDITIONAL
paymentTypes.paysafecard.countries[n] = CONDITIONAL
paymentTypes.paysafecard.countries[n].countryCode Upper case alphabetic text = CONDITIONAL
paymentTypes.paysafecard.currencies[n] = CONDITIONAL
paymentTypes.paysafecard.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.paysafecard.transactionSources[n] = CONDITIONAL
paymentTypes.paysafecard.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.pbba = CONDITIONAL
paymentTypes.pbba.currencies[n] = CONDITIONAL
paymentTypes.pbba.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.pbba.transactionSources[n] = CONDITIONAL
paymentTypes.pbba.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.poli = CONDITIONAL
paymentTypes.poli.currencies[n] = CONDITIONAL
paymentTypes.poli.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.poli.transactionSources[n] = CONDITIONAL
paymentTypes.poli.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.przelewy24 = CONDITIONAL
paymentTypes.przelewy24.currencies[n] = CONDITIONAL
paymentTypes.przelewy24.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.przelewy24.transactionSources[n] = CONDITIONAL
paymentTypes.przelewy24.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.sepa = CONDITIONAL
paymentTypes.sepa.currencies[n] = CONDITIONAL
paymentTypes.sepa.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.sepa.transactionSources[n] = CONDITIONAL
paymentTypes.sepa.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.sofort = CONDITIONAL
paymentTypes.sofort.countries[n] = CONDITIONAL
paymentTypes.sofort.countries[n].countryCode Upper case alphabetic text = CONDITIONAL
paymentTypes.sofort.currencies[n] = CONDITIONAL
paymentTypes.sofort.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.sofort.transactionSources[n] = CONDITIONAL
paymentTypes.sofort.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.trustly = CONDITIONAL
paymentTypes.trustly.countries[n] = CONDITIONAL
paymentTypes.trustly.countries[n].countryCode Upper case alphabetic text = CONDITIONAL
paymentTypes.trustly.currencies[n] = CONDITIONAL
paymentTypes.trustly.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.trustly.transactionSources[n] = CONDITIONAL
paymentTypes.trustly.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.unionpay = CONDITIONAL
paymentTypes.unionpay.currencies[n] = CONDITIONAL
paymentTypes.unionpay.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.unionpay.transactionSources[n] = CONDITIONAL
paymentTypes.unionpay.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
paymentTypes.wechatpay = CONDITIONAL
paymentTypes.wechatpay.currencies[n] = CONDITIONAL
paymentTypes.wechatpay.currencies[n].currency Upper case alphabetic text = CONDITIONAL
paymentTypes.wechatpay.transactionSources[n] = CONDITIONAL
paymentTypes.wechatpay.transactionSources[n].transactionSource Enumeration = Always Provided
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT.You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by your payment service provider.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.