Mastercard Payment Gateway API Reference: Operations -
Version 76,
Protocol: NVP

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://na.gateway.mastercard.com/api/nvp/version/76
HTTP Method POST
Authentication This operation requires authentication via one of the following methods:
  • Certificate authentication.
  • To authenticate to the API two additional NVP parameters must be supplied in the request. Provide 'merchant.<your gateway merchant ID>' in the apiUsername field and your API password in the apiPassword field.

Request Parameters

apiOperation  String =PAYMENT_OPTIONS_INQUIRY FIXED

Existence
FIXED
Fixed value
PAYMENT_OPTIONS_INQUIRY
Validation Rules
Any sequence of zero or more unicode characters.
XSD type
string

merchant  Alphanumeric + additional characters = COMPULSORY

The unique identifier issued to you by your payment provider.
Existence
COMPULSORY
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
40

apiOperation  String =PAYMENT_OPTIONS_INQUIRY FIXED

Existence
FIXED
Fixed value
PAYMENT_OPTIONS_INQUIRY
Validation Rules
Any sequence of zero or more unicode characters.
XSD type
string

correlationId  String = OPTIONAL

A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Existence
OPTIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100

gatewayEntryPoint  Enumeration = OPTIONAL

The interface through which the transaction is submitted to the gateway.
Existence
OPTIONAL
Fixed value
Validation Rules
The interface through which the transaction is submitted to the gateway.
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AUTO
The transaction was automatically generated by the gateway. For example, a Capture transaction for Auto-Capture or an order reversal transaction for risk rejected orders.
BATCH
The transaction was submitted as part of a merchant batch. Batches can either be uploaded via Batch or via Merchant Administration.
CHECKOUT_VIA_WEBSITE
The transaction was created via checkout. The payer was redirected from your website to checkout.
MERCHANT_ADMINISTRATION
The transaction was initiated in Merchant Administration.
MERCHANT_MANAGER
The transaction was initiated in Merchant Manager.
SERVICE_PROVIDER_API
The transaction was reported by an acquirer or alternate payment provider.
WEB_SERVICES_API
The transaction was submitted via Web Services API.

interaction   = OPTIONAL

Information about the API operations that you will use to submit the financial transaction requests.
Fixed value

interaction.operation  Enumeration = OPTIONAL

Indicates operation that payer wish to perform to submit the financial transaction requests.
Existence
OPTIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AUTHORIZE
Request for the Payment Configuration interaction to check AUTHORIZE transaction for the payment is supported by the acquirer.
NONE
Payment Configuration interaction will collect the payment details from the payer and securely store them against the Payment Options Inquiry. No operation will be performed after the payer interaction.
PURCHASE
Request for the Payment Configuration interaction to check PURCHASE transaction for the payment is supported by the acquirer.
VERIFY
Request for the Payment Options Inquiry to verify the payer's account.Request for the Payment Options Inquiry interaction to check Verify transaction for the payment is supported by the acquirer.

locale  String = OPTIONAL

A language identifier or IETF language tag to control the language of the payment interaction with the payer (e.g. en_US, es, fr-CA).
By default, the language is determined from your configuration. Supply a value for this field only if you wish to override the default behavior. If the language you specify is not supported by the gateway, the payment is displayed in the best matching language.

See Dynamic Currency Conversion for more detail.
Existence
OPTIONAL
Fixed value
Validation Rules
Data must be a language identifier or IETF language tag
XSD type
string
minimum length
2
maximum length
5

merchant  Alphanumeric + additional characters = COMPULSORY

The unique identifier issued to you by your payment provider.
Existence
COMPULSORY
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
40

order   = OPTIONAL

Information about the order associated with this transaction.
Fixed value

order.amount  Decimal = OPTIONAL

The total amount for the order.  This is the net amount plus any merchant charge amounts.If you provide any sub-total amounts, then the sum of these amounts (order.itemAmount, order.taxAmount, order.shippingAndHandlingAmount, order.cashbackAmount, order.gratuityAmount, order.merchantCharge.amount and order.dutyAmount), minus the order.discountAmount must equal the net amount.
The value of this field in the response is zero if payer funds are not transferred.
Existence
OPTIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
14

order.currency  Upper case alphabetic text = OPTIONAL

The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Existence
OPTIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

order.merchantCharge.type  Enumeration = OPTIONAL

The type of the additional fee that you are charging the payer.
Existence
OPTIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
SURCHARGE
A fee that covers your cost of accepting accepting a payment method.

order.netAmount  Decimal = OPTIONAL

The amount payable for the order before surcharging is applied.
If you specify a net amount the gateway will calculate the surcharge for you. Alternatively, you can specify the surcharge amount (order.surchargeAmount) yourself.
Existence
OPTIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
14

paymentType  Enumeration = OPTIONAL

The payment method the payer wishes to use to pay for this order.
Existence
OPTIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ACH
ALIPAY
BANCANET
BANCONTACT
BLIK
BOLETO_BANCARIO
BROWSER_PAYMENT
CARD
DIRECT_DEBIT_CANADA
ENETS
EPS_UEBERWEISUNG
GIFT_CARD
GIROPAY
GRABPAY
IDEAL
KLARNA_FINANCING
KLARNA_PAY_LATER
KLARNA_PAY_NOW
MERCADO_PAGO_CHECKOUT
MULTIBANCO
OPEN_BANKING_BANK_TRANSFER
OXXO
PAYCONIQ
PAYPAL
PAYSAFECARD
PAYU
PBBA
POLI
PRZELEWY24
SEPA
SOFORT
TRUSTLY
UNION_PAY
WECHAT_PAY

session.id  ASCII Text = OPTIONAL

Identifier of the payment session containing values for any of the request fields to be used in this operation.
Values provided in the request will override values contained in the session.
Existence
OPTIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
31
maximum length
35

session.version  ASCII Text = OPTIONAL

Use this field to implement optimistic locking of the session content.
Do this if you make business decisions based on data from the session and wish to ensure that the same data is being used for the request operation.

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.
Existence
OPTIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
10
maximum length
10

sourceOfFunds   = OPTIONAL

Information about the payment type selected by the payer for this payment and the source of the funds.
Depending on the payment type the source of the funds can be a debit or credit card, bank account, or account with a browser payment provider (such as PayPal).

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.
Fixed value

sourceOfFunds.provided.card.p2pe   = OPTIONAL

This holds the PAN in the case where it is encrypted by the terminal using DUKPT key exchange.
Fixed value

sourceOfFunds.provided.card.p2pe.cardBin  Digits = OPTIONAL

The BIN of the card.
If you provide this, the gateway will check that the decrypted PAN has these leading six digits. If the check fails, the gateway will reject the transaction.

If you do not provided this, the gateway will not perform this check.
Existence
OPTIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
XSD type
string
minimum length
1
maximum length
6

sourceOfFunds.provided.card.p2pe.encryptionState  String = OPTIONAL

The P2PE encryption state as determined by the terminal.
INVALID means the terminal detected some form of error in the encryption process. The gateway will decline transactions with INVALID encryption state. This field may be omitted when the value is VALID.
Existence
OPTIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
5
maximum length
7

sourceOfFunds.provided.card.p2pe.initializationVector  Hex = OPTIONAL

The initialization vector supplied by the terminal to seed the encryption of this payload.
Omit this value if the terminal is not using an initialization vector to seed encryption.
Existence
OPTIONAL
Fixed value
Validation Rules
Data is hexadecimal encoded
XSD type
string
minimum length
16
maximum length
16

sourceOfFunds.provided.card.p2pe.keySerialNumber  Hex = COMPULSORY

The DUKPT key serial number supplied by the terminal.
Existence
COMPULSORY
Fixed value
Validation Rules
Data is hexadecimal encoded
XSD type
string
minimum length
20
maximum length
20

sourceOfFunds.provided.card.p2pe.payload  Hex = COMPULSORY

The DUKPT encrypted payload supplied by the terminal.
Existence
COMPULSORY
Fixed value
Validation Rules
Data is hexadecimal encoded
XSD type
string
minimum length
32
maximum length
1024

sourceOfFunds.provided.card.prefix  Digits = OPTIONAL

The first 10 digits of the card number, as printed on the card.
Existence
OPTIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
XSD type
string
minimum length
10
maximum length
10

sourceOfFunds.token  Alphanumeric = OPTIONAL

A gateway token that contains account identifier details.
The account identifier details stored against this token will be used to process the request.
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.
Existence
OPTIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
40

transactionSource  Enumeration = OPTIONAL

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
OPTIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

Response Parameters

merchant  Alphanumeric + additional characters = Always Provided

The unique identifier issued to you by your payment provider.
Existence
Always Provided
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
40

result  Enumeration = Always Provided

A system-generated high level overall result of the transaction/operation.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
FAILURE
The operation was declined or rejected by the gateway, acquirer or issuer
PENDING
The operation is currently in progress or pending processing
SUCCESS
The operation was successfully processed
UNKNOWN
The result of the operation is unknown

correlationId  String = CONDITIONAL

A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100

custom  JSON Text = CONDITIONAL

Provides additional data relevant to the options available for processing a payment.
If applicable, your payment service provider will describe how to use this data.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is valid Json Format
XSD type
string
minimum length
1
maximum length
4000

gatewayEntryPoint  Enumeration = CONDITIONAL

The interface through which the transaction is submitted to the gateway.
Existence
CONDITIONAL
Fixed value
Validation Rules
The interface through which the transaction is submitted to the gateway.
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AUTO
The transaction was automatically generated by the gateway. For example, a Capture transaction for Auto-Capture or an order reversal transaction for risk rejected orders.
BATCH
The transaction was submitted as part of a merchant batch. Batches can either be uploaded via Batch or via Merchant Administration.
CHECKOUT_VIA_WEBSITE
The transaction was created via checkout. The payer was redirected from your website to checkout.
MERCHANT_ADMINISTRATION
The transaction was initiated in Merchant Administration.
MERCHANT_MANAGER
The transaction was initiated in Merchant Manager.
SERVICE_PROVIDER_API
The transaction was reported by an acquirer or alternate payment provider.
WEB_SERVICES_API
The transaction was submitted via Web Services API.

merchant  Alphanumeric + additional characters = Always Provided

The unique identifier issued to you by your payment provider.
Existence
Always Provided
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
40

order.amount  Decimal = CONDITIONAL

The total amount for the order.  This is the net amount plus any merchant charge amounts.If you provide any sub-total amounts, then the sum of these amounts (order.itemAmount, order.taxAmount, order.shippingAndHandlingAmount, order.cashbackAmount, order.gratuityAmount, order.merchantCharge.amount and order.dutyAmount), minus the order.discountAmount must equal the net amount.
The value of this field in the response is zero if payer funds are not transferred.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3

order.currency  Upper case alphabetic text = CONDITIONAL

The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

order.merchantCharge   = CONDITIONAL

Information about additional fees that you are charging the payer for processing the payment for this order, for example, a surcharge, convenience or service fee.
Fixed value

order.merchantCharge.amount  Decimal = Always Provided

The amount of the additional fee that you are charging the payer.
If you provide a charge amount, you must include it in the total amount for the order.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3

order.merchantCharge.type  Enumeration = Always Provided

The type of the additional fee that you are charging the payer.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
SURCHARGE
A fee that covers your cost of accepting accepting a payment method.

order.netAmount  Decimal = CONDITIONAL

The amount payable for the order before surcharging is applied.
If you specify a net amount the gateway will calculate the surcharge for you. Alternatively, you can specify the surcharge amount (order.surchargeAmount) yourself.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3

order.surchargeAmount  Decimal = CONDITIONAL

A fee charged by you to cover the cost of accepting a payment method.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3

paymentPlanProduct   = CONDITIONAL

Information about the payment plan products for which payment plan offers are provided.
Fixed value

paymentPlanProduct.{paymentPlanProductId}.logoUrl  URI = CONDITIONAL

The URL of the logo for the payment plan product.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must be an absolute URI conforming to the URI syntax published by IETF RFC 2396. The following schemes are forbidden : javascript
XSD type
string

paymentPlanProduct.{paymentPlanProductId}.name  String = CONDITIONAL

The display name of the payment plan product.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
60

paymentPlanProduct.{paymentPlanProductId}  Alphanumeric + additional characters = CONDITIONAL

An identifier to uniquely identify the payment plan product in the gateway.
The identifier for the payment plan.
See Payment Plans for the supported payment plans and their identifiers.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
60

paymentTypes   = CONDITIONAL

The payment method the payer wishes to use to pay for this order.
Fixed value

paymentTypes.ach   = CONDITIONAL

Details about supported Automated Clearing House (ACH) payment options
Fixed value

paymentTypes.ach.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.ach.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.ach.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.ach.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.alipay   = CONDITIONAL

Details about supported Alipay payment options.
Fixed value

paymentTypes.alipay.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.alipay.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.alipay.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.alipay.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.bancanet   = CONDITIONAL

Details about supported BancaNet browser payment options.
Fixed value

paymentTypes.bancanet.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.bancanet.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.bancanet.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.bancanet.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.bancontact   = CONDITIONAL

Details about supported Bancontact payment options.
Fixed value

paymentTypes.bancontact.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.bancontact.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.bancontact.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.bancontact.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.blik   = CONDITIONAL

Details about supported Blik payment options.
Fixed value

paymentTypes.blik.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.blik.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.blik.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.blik.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.boletobancario   = CONDITIONAL

Details about supported Boleto Bancario payment options.
Fixed value

paymentTypes.boletobancario.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.boletobancario.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.boletobancario.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.boletobancario.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.card   = CONDITIONAL

Details about supported credit and debit card payment options.
Fixed value

paymentTypes.card.3DSecureSchemes[n]   = CONDITIONAL

Information on whether you are set up to use one or more 3DSecure schemes.
The 3DSecure scheme applicable for an order depends on the card type used to pay for the order.
Fixed value

paymentTypes.card.3DSecureSchemes[n].3DSecureScheme  Enumeration = Always Provided

The list of valid 3D-Secure schemes supported for this order based on the values supplied in the request parameters.
For example, MasterCard SecureCode, Verified by Visa, JSecure, Diners Club ProtectBuy.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AMEX_SAFE_KEY
J_SECURE
MADA_SECURE
OTHER
PROTECT_BUY
SECURE_CODE
VERIFIED_BY_VISA

paymentTypes.card.brand  Enumeration = CONDITIONAL

The brand name used to describe the card that is recognized and accepted globally.
For many major card types this will match the scheme name. In some markets, a card may also be co-branded with a local brand that is recognized and accepted within its country/region of origin (see card.localBrand).
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.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AMEX
American Express
CHINA_UNIONPAY
China UnionPay
DINERS_CLUB
Diners Club
DISCOVER
Discover
JCB
JCB (Japan Credit Bureau)
LOCAL_BRAND_ONLY
The card does not have a global brand.
MAESTRO
Maestro
MASTERCARD
MasterCard
RUPAY
RuPay
UATP
UATP (Universal Air Travel Plan)
UNKNOWN
The brand of the card used in the transaction could not be identified
VISA
Visa

paymentTypes.card.capabilities[n]   = CONDITIONAL

Indicates capabilities available to you for card payments.
Fixed value

paymentTypes.card.capabilities[n].capability  Enumeration = Always Provided

Indicates capabilities available to you for card payments.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ADDRESS_VERIFICATION
Indicates if you are allowed to use the Address Verification Service (AVS) to verify address details supplied by the cardholder.
CARD_SECURITY_CODE
Indicates if you are allowed to use the Card Security Check to verify the Card Security Code (CSC) supplied by the cardholder
CARD_TYPE_SELECTION
Indicates if you or the payer have an option to select the card type when the card has been identified as co-branded card.
NO_CARD_SECURITY_CODE_PRINTED_ON_CARD
Indicates if you are allowed to accept payments from credit cards without a Card Security Code (CSC) printed on the card.

paymentTypes.card.cardTypes[n]   = CONDITIONAL

Information on the card types supported for this order.
Fixed value

paymentTypes.card.cardTypes[n].cardType  String = Always Provided

The list of valid card types for this order based on the values supplied in the request parameters.
For example, MasterCard, Visa, American Express.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
3
maximum length
50

paymentTypes.card.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.card.currencyConversion   = CONDITIONAL

Information on currency conversion if the merchant has the permission to offer dynamic currency conversion (DCC) services to the payer.
Fixed value

paymentTypes.card.currencyConversion.exchangeRateSource  String = CONDITIONAL

The financial data agency used as a source for the exchange rate.
The source of the exchange rate may need to be displayed to the payer on the merchant site to satisfy regulatory requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100

paymentTypes.card.currencyConversion.exchangeRateTime  DateTime = CONDITIONAL

The timestamp of when the conversion rate is effective.
The timestamp may need to be displayed to the payer on the merchant site to satisfy regulatory requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
XSD type
string

paymentTypes.card.currencyConversion.gatewayCode  Enumeration = Always Provided

Summary of the success or otherwise of the DCC quote request.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ERROR
The DCC provider was unable to process this operation.
INSUFFICIENT_INFORMATION
Cannot provide DCC quote as required fields are missing (amount, currency, card prefix or session identifier or token).
NOT_ELIGIBLE
DCC not available for this card or currency.
QUOTE_PROVIDED
DCC quote successfully processed.
UNSUPPORTED_CARD_BRAND
DCC only supported for Visa, MasterCard, and Maestro cards.

paymentTypes.card.currencyConversion.marginPercentage  Decimal = CONDITIONAL

The foreign exchange markup applied as a percentage to the transaction amount for providing the conversion service.
The margin percentage may need to be displayed to the payer on the merchant site to satisfy regulatory requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
10000000
minimum value
0
maximum post-decimal digits
5

paymentTypes.card.currencyConversion.offerText  String = CONDITIONAL

This is a piece of HTML markup that can be included as part of your website to offer the payer the currency conversion quote.
It contains information necessary to comply with scheme requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
4096

paymentTypes.card.currencyConversion.payerAmount  Decimal = CONDITIONAL

The total amount of the transaction in the payer's currency.
You must include this field if the payer accepted the DCC offer you presented to them.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3

paymentTypes.card.currencyConversion.payerCurrency  Upper case alphabetic text = CONDITIONAL

The currency of the DCC rate quote provided by your DCC Service Provider.
The currency must be expressed as an ISO 4217 alpha code, e.g. USD and must be different to that provided for transaction currency. You must include this field if the payer accepted the DCC offer you presented to them.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.card.currencyConversion.payerExchangeRate  Decimal = CONDITIONAL

The exchange rate used to convert the transaction amount into the payer's currency.
The payer exchange rate includes the foreign exchange markup (marginPercentage). The payer exchange rate is displayed to the payer on the merchant site.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000000000
minimum value
0
maximum post-decimal digits
12

paymentTypes.card.currencyConversion.provider  Enumeration = CONDITIONAL

This identifies the name of the provider of the DCC quote.
This data is for information purposes, and may be useful if you use multiple DCC providers.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
FEXCO
FTT
GLOBAL_PAYMENTS
IBM
TRAVELEX_CURRENCY_SELECT
UNICREDIT

paymentTypes.card.currencyConversion.providerCode  ASCII Text = CONDITIONAL

Value as generated by the quote provider that summarizes the success or otherwise of the DCC quote request.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
1
maximum length
100

paymentTypes.card.currencyConversion.providerReceipt  String = CONDITIONAL

The quote provider's unique reference to the rate quote.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100

paymentTypes.card.currencyConversion.quoteExpiry  DateTime = CONDITIONAL

The timestamp indicating when the DCC quote offer expires.
Existence
CONDITIONAL
Fixed value
Validation Rules
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
XSD type
string

paymentTypes.card.currencyConversion.requestId  String = CONDITIONAL

The unique identifier for your DCC quote request as returned in the PAYMENT_OPTIONS_INQUIRY response.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100

paymentTypes.card.defaultCardType  String = CONDITIONAL

Default card type for the supplied co-branded BIN.
For example, MasterCard, Visa, American Express.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
3
maximum length
50

paymentTypes.card.fundingMethod  Enumeration = CONDITIONAL

The method used by the payer to provide the funds for the payment.
You may use this information to support decisions about merchant charges. This information is gathered from 3rd party sources and may not be accurate in all circumstances.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CHARGE
The payer has a line of credit with the issuer which must be paid off monthly.
CREDIT
The payer has a revolving line of credit with the issuer.
DEBIT
Funds are immediately debited from the payer's account with the issuer.
UNKNOWN
The account funding method could not be determined.

paymentTypes.card.interactionConstraints  Comma separated enumeration = CONDITIONAL

Indicates if the cardholder is required to provide additional information when using a card to pay for the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be one or more comma separated members of the following list. The values are case sensitive.
CREDIT_DEBIT_SELECTION
Indicates if the cardholder must be forced to select between using a credit card or a debit card, before entering their card details.
CARD_TYPE_SELECTION
Indicates if the cardholder must be forced to select the card type.This is required when the card is identified as a co-branded card and regulation stipulates that the payer must select the card type.The card type selected by the payer must subsequently be provided in field sourceOfFunds.provided.card.cardType on financial transaction requests.
CARD_SECURITY_CODE_ENTRY
Indicates if the cardholder must be forced to enter the Card Security Code (CSC) when using a credit card to pay for the order.

paymentTypes.card.issuer  String = CONDITIONAL

The issuer of the card, if known.
WARNING: This information may be incorrect or incomplete – use at your own risk.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
0
maximum length
255

paymentTypes.card.localBrand  String = CONDITIONAL

The brand name used to describe a card that is recognized and accepted within its country/region of origin.
The card may also be co-branded with a brand name that is recognized and accepted globally (see card.brand).
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.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
3
maximum length
50

paymentTypes.card.scheme  Enumeration = CONDITIONAL

The organization that owns a card brand and defines operating regulations for its use.
The card scheme also controls authorization and settlement of card transactions among issuers and acquirers.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AMEX
American Express
CHINA_UNIONPAY
China UnionPay
DINERS_CLUB
Diners Club
DISCOVER
Discover
JCB
JCB (Japan Credit Bureau)
MASTERCARD
MasterCard
OTHER
The scheme of the card used in the transaction could not be identified.
RUPAY
RuPay
UATP
UATP (Universal Air Travel Plan)
VISA
Visa

paymentTypes.card.tags  String = CONDITIONAL

Tags provide you with additional information about the card.
For example, identifying if it is an EBT (Electronic Benefits Transfer) or Health Benefit Card. You can use this information to support your decisions about accepting payments with this card. The data is encoded in JSON as an object map indexed on the tag name. Some standard tag names are EBT and HEALTH_BENEFIT_CARD_IIAS. If these tags apply to the card, the tag will have value true, otherwise it will be absent. Other tag names with other values might also exist, depending on which acquirer processed the transaction. For example, an EBT card might return value: {"ACME_CARD_IDENTIFIER":"23", "EBT":true} Contact your payment provider if you wish to understand all tags available for your acquirers.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
2048

paymentTypes.card.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.card.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.card.walletProviders[n]   = CONDITIONAL

Indicates the wallet providers you are enabled and configured for, and that are supported for this order.
Fixed value

paymentTypes.card.walletProviders[n].secureRemoteCommerce   = CONDITIONAL

Provide details about the Secure Remote Commerce (SRC) wallet interaction.
Fixed value

paymentTypes.card.walletProviders[n].secureRemoteCommerce.defaultPayerCountry  Upper case alphabetic text = CONDITIONAL

The ISO 3166 alpha-3 country code of the payer's country to be used to present country-specific content to the payer during the Secure Remote Commerce interaction.
This is the default country to be used, unless it is overwritten for this transaction in the interaction.country field.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.card.walletProviders[n].secureRemoteCommerce.scheme[n]   = CONDITIONAL

Details regarding the merchant's Secure Remote Commerce (SRC) configuration specific to the scheme
Fixed value

paymentTypes.card.walletProviders[n].secureRemoteCommerce.scheme[n].dpaId  String = Always Provided

Unique identifier assigned to the merchant (called Digital Payment Application) by the Secure Remote Commerce (SRC) System for this scheme.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100

paymentTypes.card.walletProviders[n].secureRemoteCommerce.scheme[n].name  Enumeration = Always Provided

Scheme for which Secure Remote Commerce (SRC) configuration for the merchant is provided.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AMERICAN_EXPRESS
American Express
MASTERCARD
Mastercard
VISA
Visa

paymentTypes.card.walletProviders[n].secureRemoteCommerce.shippingAddressCountries  Comma separated strings = CONDITIONAL

A comma separated list of ISO 3166-1 alpha-3 country codes.
The merchant only ships to countries included in this list. For a Secure Remote Commerce (SRC) interaction only shipping addresses with a country contained in the list must be accepted.
Existence
CONDITIONAL
Fixed value
Validation Rules
Each String represents an ISO 3166-1 alpha-3 code for the country.
XSD type
string
minimum length
3
maximum length
3

paymentTypes.card.walletProviders[n].walletProvider  Enumeration = Always Provided

Details about the source of the payment details used for digital payment methods.
Provide this value when you process payments for:
  • 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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AMEX_EXPRESS_CHECKOUT
Amex Express Checkout wallet provider.
APPLE_PAY
Apple Pay mobile wallet provider.
CHASE_PAY
Chase Pay wallet provider.
GOOGLE_PAY
Google Pay mobile wallet provider.
MASTERPASS_ONLINE
MasterPass Online wallet provider.
SAMSUNG_PAY
Samsung Pay mobile wallet provider.
VISA_CHECKOUT
Visa Checkout wallet provider.

paymentTypes.directDebitCanada   = CONDITIONAL

Details about supported Direct Debit Canada payment options
Fixed value

paymentTypes.directDebitCanada.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.directDebitCanada.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.directDebitCanada.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.directDebitCanada.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.enets   = CONDITIONAL

Details about supported eNETS payment options.
Fixed value

paymentTypes.enets.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.enets.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.enets.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.enets.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.epsUeberweisung   = CONDITIONAL

Details about supported eps-Überweisung payment options.
Fixed value

paymentTypes.epsUeberweisung.countries[n]   = CONDITIONAL

Information on the countries for the payer's bank supported for this order.
Fixed value

paymentTypes.epsUeberweisung.countries[n].countryCode  Upper case alphabetic text = CONDITIONAL

The list of supported countries (expressed using ISO 3166 alpha-3 code) for this order based on the values supplied in the request parameters.
For example, POL stands for Poland.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.epsUeberweisung.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.epsUeberweisung.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.epsUeberweisung.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.epsUeberweisung.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.giftCard   = CONDITIONAL

Details about supported gift card payment options.
Fixed value

paymentTypes.giftCard.cardTypes[n]   = CONDITIONAL

Information on the gift card types supported for this order.
Fixed value

paymentTypes.giftCard.cardTypes[n].cardType  String = Always Provided

Information on the gift card types supported for this order.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50

paymentTypes.giftCard.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.giftCard.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.giftCard.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.giftCard.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.giropay   = CONDITIONAL

Details about supported giropay browser payment options.
Fixed value

paymentTypes.giropay.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.giropay.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.giropay.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.giropay.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.grabPay   = CONDITIONAL

Details about supported GrabPay payment options.
Fixed value

paymentTypes.grabPay.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.grabPay.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.grabPay.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.grabPay.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.ideal   = CONDITIONAL

Details about supported iDEAL payment options.
Fixed value

paymentTypes.ideal.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.ideal.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.ideal.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.ideal.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.klarnaFinancing   = CONDITIONAL

Details about supported Klarna Financing payment options.
Fixed value

paymentTypes.klarnaFinancing.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.klarnaFinancing.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.klarnaFinancing.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.klarnaFinancing.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.klarnaPayLater   = CONDITIONAL

Details about supported Klarna Pay Later payment options.
Fixed value

paymentTypes.klarnaPayLater.countries[n]   = CONDITIONAL

Information on the countries for the payer's bank supported for this order.
Fixed value

paymentTypes.klarnaPayLater.countries[n].countryCode  Upper case alphabetic text = CONDITIONAL

The list of supported countries (expressed using ISO 3166 alpha-3 code) for this order based on the values supplied in the request parameters.
For example, POL stands for Poland.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.klarnaPayLater.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.klarnaPayLater.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.klarnaPayLater.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.klarnaPayLater.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.klarnaPayNow   = CONDITIONAL

Details about supported Klarna Pay Now payment options.
Fixed value

paymentTypes.klarnaPayNow.countries[n]   = CONDITIONAL

Information on the countries for the payer's bank supported for this order.
Fixed value

paymentTypes.klarnaPayNow.countries[n].countryCode  Upper case alphabetic text = CONDITIONAL

The list of supported countries (expressed using ISO 3166 alpha-3 code) for this order based on the values supplied in the request parameters.
For example, POL stands for Poland.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.klarnaPayNow.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.klarnaPayNow.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.klarnaPayNow.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.klarnaPayNow.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.mercadoPagoCheckout   = CONDITIONAL

Details about supported Mercado Pago Checkout payment options.
Fixed value

paymentTypes.mercadoPagoCheckout.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.mercadoPagoCheckout.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.multibanco   = CONDITIONAL

Details about supported Multibanco payment options.
Fixed value

paymentTypes.multibanco.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.multibanco.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.openBankingBankTransfer   = CONDITIONAL

Details about supported Open Banking Bank Transfer payment options.
Fixed value

paymentTypes.openBankingBankTransfer.capabilities[n]   = CONDITIONAL

Details about your open banking configuration capabilities.
Fixed value

paymentTypes.openBankingBankTransfer.capabilities[n].capability  Enumeration = Always Provided

Configuration available to you for the Open Banking Bank Transfer payment method.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
REFUNDS
Indicates that you have the privilege to perform refunds and the gateway will store account details on your behalf for this purpose.

paymentTypes.oxxo   = CONDITIONAL

Details about supported OXXO payment options.
Fixed value

paymentTypes.oxxo.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.oxxo.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.oxxo.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.oxxo.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.payU   = CONDITIONAL

Details about supported PayU payment options.
Fixed value

paymentTypes.payU.countries[n]   = CONDITIONAL

Information on the countries for the payer's bank supported for this order.
Fixed value

paymentTypes.payU.countries[n].countryCode  Upper case alphabetic text = CONDITIONAL

The list of supported countries (expressed using ISO 3166 alpha-3 code) for this order based on the values supplied in the request parameters.
For example, POL stands for Poland.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.payU.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.payU.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.payU.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.payU.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.payconiq   = Always Provided

Details about supported Payconiq payment options.
Fixed value

paymentTypes.payconiq.countries[n]   = CONDITIONAL

Information on the payer's country for the purpose of the payconiq interaction supported for this order.
Fixed value

paymentTypes.payconiq.countries[n].countryCode  Upper case alphabetic text = CONDITIONAL

The list of supported countries (expressed using ISO 3166 alpha-3 code) for this order based on the values supplied in the request parameters.
For example, POL stands for Poland.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.payconiq.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.payconiq.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.payconiq.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.payconiq.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.paypal   = CONDITIONAL

Details about supported PayPal payment options.
Fixed value

paymentTypes.paypal.accountId  String = Always Provided

The ID provided to you by PayPal when you create a PayPal account.
This identifies you as the merchant in messages that the gateway submits to PayPal.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50

paymentTypes.paypal.capabilities[n]   = CONDITIONAL

Details about your Paypal configuration capabilities.
Fixed value

paymentTypes.paypal.capabilities[n].capability  Enumeration = Always Provided

Configuration available to you for the PayPal payment method.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
PAYPAL_SMART_BUTTON
Allows the merchant to offer PayPal Smart button to payer inorder to make purchase for PayPal transactions.

paymentTypes.paypal.clientId  String = Always Provided

The ID provided to your payment service provider when creating a PayPal account.
This identifies your payment service provider in messages that the gateway submits to PayPal.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50

paymentTypes.paypal.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.paypal.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.paypal.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.paypal.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.paysafecard   = CONDITIONAL

Details about supported paysafecard payment options.
Fixed value

paymentTypes.paysafecard.countries[n]   = CONDITIONAL

Information on the payer's country for the purpose of the paysafecard interaction supported for this order.
Fixed value

paymentTypes.paysafecard.countries[n].countryCode  Upper case alphabetic text = CONDITIONAL

The list of supported countries (expressed using ISO 3166 alpha-3 code) for this order based on the values supplied in the request parameters.
For example, POL stands for Poland.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.paysafecard.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.paysafecard.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.paysafecard.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.paysafecard.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.pbba   = CONDITIONAL

Details about supported Pay by Bank app payment options.
Fixed value

paymentTypes.pbba.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.pbba.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.pbba.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.pbba.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.poli   = CONDITIONAL

Details about supported POLi payment options.
Fixed value

paymentTypes.poli.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.poli.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.poli.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.poli.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.przelewy24   = CONDITIONAL

Details about supported Przelewy24 payment options.
Fixed value

paymentTypes.przelewy24.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.przelewy24.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.przelewy24.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.przelewy24.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.sepa   = CONDITIONAL

Details about supported SEPA payment options.
Fixed value

paymentTypes.sepa.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.sepa.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.sepa.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.sepa.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.sofort   = CONDITIONAL

Details about supported Sofortbanking browser payment options.
Fixed value

paymentTypes.sofort.countries[n]   = CONDITIONAL

Information on the countries for the payer's bank supported for this order.
Fixed value

paymentTypes.sofort.countries[n].countryCode  Upper case alphabetic text = CONDITIONAL

The list of supported countries (expressed using ISO 3166 alpha-3 code) for this order based on the values supplied in the request parameters.
For example, POL stands for Poland.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.sofort.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.sofort.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.sofort.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.sofort.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.trustly   = CONDITIONAL

Details about supported Trustly payment options.
Fixed value

paymentTypes.trustly.countries[n]   = CONDITIONAL

Information on the countries for the payer's bank supported for this order.
Fixed value

paymentTypes.trustly.countries[n].countryCode  Upper case alphabetic text = CONDITIONAL

The list of supported countries (expressed using ISO 3166 alpha-3 code) for this order based on the values supplied in the request parameters.
For example, POL stands for Poland.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.trustly.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.trustly.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.trustly.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.trustly.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.unionpay   = CONDITIONAL

Details about supported UnionPay SecurePay payment options.
Fixed value

paymentTypes.unionpay.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.unionpay.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.unionpay.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.unionpay.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

paymentTypes.wechatpay   = CONDITIONAL

Details about supported WeChatPay payment options.
Fixed value

paymentTypes.wechatpay.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

paymentTypes.wechatpay.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

The list of valid currencies (expressed using ISO 4217 alpha code) for this order based on the values supplied in the request parameters.
For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3

paymentTypes.wechatpay.transactionSources[n]   = CONDITIONAL

Information on the supported sources through which the order can be received.
Fixed value

paymentTypes.wechatpay.transactionSources[n].transactionSource  Enumeration = Always Provided

Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.

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.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
SERVICE_PROVIDER
Transaction reported by the acquirer.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

result  Enumeration = Always Provided

A system-generated high level overall result of the transaction/operation.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
FAILURE
The operation was declined or rejected by the gateway, acquirer or issuer
PENDING
The operation is currently in progress or pending processing
SUCCESS
The operation was successfully processed
UNKNOWN
The result of the operation is unknown

supportedPaymentOperations[n]   = CONDITIONAL

Information on the supported payment operations available to the merchant.
Fixed value

supportedPaymentOperations[n].supportedPaymentOperation  Enumeration = Always Provided

The list of supported payment operations available to the merchant.
For example, AUTHORIZE, PURCHASE.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AUTHORIZE
Merchant has privilege to perform Authorizations.
PURCHASE
Merchant has privilege to perform Purchases

error   = CONDITIONAL

Information on possible error conditions that may occur while processing an operation using the API.
Fixed value

error.cause  Enumeration = CONDITIONAL

Broadly categorizes the cause of the error.
For example, errors may occur due to invalid requests or internal system failures.
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
INVALID_REQUEST
The request was rejected because it did not conform to the API protocol.
REQUEST_REJECTED
The request was rejected due to security reasons such as firewall rules, expired certificate, etc.
SERVER_BUSY
The server did not have enough resources to process the request at the moment.
SERVER_FAILED
There was an internal system failure.

error.explanation  String = CONDITIONAL

Textual description of the error based on the cause.
This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
1000

error.field  String = CONDITIONAL

Indicates the name of the field that failed validation.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100

error.supportCode  String = CONDITIONAL

Indicates the code that helps the support team to quickly identify the exact cause of the error.
This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100

error.validationType  Enumeration = CONDITIONAL

Indicates the type of field validation error.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
INVALID
The request contained a field with a value that did not pass validation.
MISSING
The request was missing a mandatory field.
UNSUPPORTED
The request contained a field that is unsupported.

result  Enumeration = CONDITIONAL

A system-generated high level overall result of the operation.
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ERROR
The operation resulted in an error and hence cannot be processed.

Copyright © 2023 Mastercard