Payment Options Inquiry

Request to retrieve the options available for processing a payment, for example, the credit cards and currencies.

You can also use this operation to perform a Rate Quote for Dynamic Currency Conversion.

Warning! This operation must not be called directly from the browser, as it would reveal the integration password to customers.

This operation may not be needed if such values rarely change and can be hard-coded into the website handling the transaction. However, the operation is useful for populating and validating transaction fields (for example) if these values can change in real time for a business's website.

If the operation is called with no parameters, all values that could apply for all fields are returned: all of the possible currencies, all of the possible card types, and so on. Non-complex websites can use this unmodified data set for building a website's presentation and input validation.

Some websites require more complex configuration (for example, where USD and EUR currencies are supported on MasterCard and Visa, but only USD on American Express). Call the operation with parameters to restrict the returned values. If a sourceOfFunds.provided.card.prefix is passed in, only currencies applicable to the card brand identified by the prefix are returned. If an order.currency is passed in, only payment options applicable for that currency are returned.

URL https://na.gateway.mastercard.com/api/rest/version/45/merchant/{merchantId}/paymentOptionsInquiry
HTTP Method GET
Authentication This operation requires authentication via one of the following methods:
  • Certificate authentication.
  • Basic HTTP authentication as described at w3.org. Provide 'merchant.<your gateway merchant ID>' in the userid portion and your API password in the password portion.

Request Parameters

correlationId  String = OPTIONAL

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

locale  String = OPTIONAL

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
JSON type
String
minimum length
2
maximum length
5

order   = OPTIONAL

Information about the order associated with this transaction.
Fixed value

order.amount  Decimal = OPTIONAL

If you supply this value then you must provide order.currency to filter the response values.
Existence
OPTIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
JSON type
String
minimum length
1
maximum length
14

order.currency  Upper case alphabetic text = OPTIONAL

Existence
OPTIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
JSON type
String
minimum length
3
maximum length
3

paymentType  Enumeration = OPTIONAL

Existence
OPTIONAL
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
ACH
BANCANET
CARD
GIFT_CARD
GIROPAY
PAYPAL
SOFORT
UNION_PAY

session.id  ASCII Text = OPTIONAL

Values provided in the request will override values contained in the session.
Existence
OPTIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
JSON type
String
minimum length
31
maximum length
35

session.version  ASCII Text = OPTIONAL

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
JSON type
String
minimum length
10
maximum length
10

sourceOfFunds   = OPTIONAL

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

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.
JSON type
String
minimum length
1
maximum length
6

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

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
JSON type
String
minimum length
5
maximum length
7

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

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
JSON type
String
minimum length
16
maximum length
16

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

Existence
COMPULSORY
Fixed value
Validation Rules
Data is hexadecimal encoded
JSON type
String
minimum length
20
maximum length
20

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

Existence
COMPULSORY
Fixed value
Validation Rules
Data is hexadecimal encoded
JSON type
String
minimum length
32
maximum length
1024

sourceOfFunds.provided.card.prefix  Digits = OPTIONAL

Existence
OPTIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
JSON type
String
minimum length
10
maximum length
10

sourceOfFunds.token  Alphanumeric = OPTIONAL

Existence
OPTIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
JSON type
String
minimum length
1
maximum length
40

transactionSource  Enumeration = OPTIONAL

For example, INTERNET, MOTO.
Existence
OPTIONAL
Fixed value
Validation Rules
JSON 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.
MOTO
Transaction received by mail or telephone.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

{merchantId}  Alphanumeric + additional characters COMPULSORY

Existence
COMPULSORY
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
40

Response Parameters

merchant  Alphanumeric + additional characters = Always Provided

Existence
Always Provided
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
JSON type
String
minimum length
1
maximum length
40

result  Enumeration = Always Provided

Existence
Always Provided
Fixed value
Validation Rules
JSON 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

transactionMode  Enumeration = Always Provided

Existence
Always Provided
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
AUTHORIZE_CAPTURE
The payment is authorized only (AUTHORIZATION transaction). The merchant must submit a Capture request to move the funds from the payer's account to the merchant's account.
PURCHASE
The payment happens immediately (PURCHASE transaction). The funds are immediately moved from the payer's account to the merchant's account.

correlationId  String = CONDITIONAL

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

merchant  Alphanumeric + additional characters = Always Provided

Existence
Always Provided
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
JSON type
String
minimum length
1
maximum length
40

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

For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
JSON 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

For example, INTERNET, MOTO.
Existence
Always Provided
Fixed value
Validation Rules
JSON 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.
MOTO
Transaction received by mail or telephone.
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

For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
JSON 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

For example, INTERNET, MOTO.
Existence
Always Provided
Fixed value
Validation Rules
JSON 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.
MOTO
Transaction received by mail or telephone.
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

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

For example, MasterCard SecureCode, Verified by Visa, JSecure, Diners Club ProtectBuy.
Existence
Always Provided
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
AMEX_SAFE_KEY
J_SECURE
PROTECT_BUY
SECURE_CODE
VERIFIED_BY_VISA

paymentTypes.card.brand  Enumeration = CONDITIONAL

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

Existence
Always Provided
Fixed value
Validation Rules
JSON 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
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

For example, MasterCard, Visa, American Express.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
JSON 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.currencies[n].currency  Upper case alphabetic text = CONDITIONAL

For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
JSON type
String
minimum length
3
maximum length
3

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 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
JSON type
String
minimum length
1
maximum length
100

paymentTypes.card.currencyConversion.exchangeRateTime  DateTime = CONDITIONAL

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"
JSON type
String

paymentTypes.card.currencyConversion.gatewayCode  Enumeration = Always Provided

Existence
Always Provided
Fixed value
Validation Rules
JSON 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 margin percentage may need to be displayed to the payer on the merchant site to satisfy regulatory requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a decimal number.
JSON type
Number
maximum value
10000000
minimum value
0
maximum post-decimal digits
5

paymentTypes.card.currencyConversion.offerText  String = CONDITIONAL

It contains information necessary to comply with scheme requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
4096

paymentTypes.card.currencyConversion.payerAmount  Decimal = CONDITIONAL

You must include this field if the payer accepted the DCC offer you presented to them.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a decimal number.
JSON type
Number
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3

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

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
JSON type
String
minimum length
3
maximum length
3

paymentTypes.card.currencyConversion.payerExchangeRate  Decimal = CONDITIONAL

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
Data is a decimal number.
JSON type
Number
maximum value
1000000000000000000
minimum value
0
maximum post-decimal digits
12

paymentTypes.card.currencyConversion.provider  Enumeration = CONDITIONAL

This data is for information purposes, and may be useful if you use multiple DCC providers.
Existence
CONDITIONAL
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
FEXCO
TRAVELEX_CURRENCY_SELECT

paymentTypes.card.currencyConversion.providerCode  ASCII Text = CONDITIONAL

Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
JSON type
String
minimum length
1
maximum length
100

paymentTypes.card.currencyConversion.providerReceipt  String = CONDITIONAL

Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
100

paymentTypes.card.currencyConversion.quoteExpiry  DateTime = CONDITIONAL

Existence
CONDITIONAL
Fixed value
Validation Rules
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
JSON type
String

paymentTypes.card.currencyConversion.requestId  String = CONDITIONAL

Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
100

paymentTypes.card.enforceCardSecurityCodeEntry  Enumeration = CONDITIONAL

Existence
CONDITIONAL
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
FALSE
TRUE
UNDETERMINED

paymentTypes.card.fundingMethod  Enumeration = CONDITIONAL

You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.
Existence
CONDITIONAL
Fixed value
Validation Rules
JSON 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.issuer  String = CONDITIONAL

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
JSON type
String
minimum length
0
maximum length
255

paymentTypes.card.localBrand  String = CONDITIONAL

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
JSON type
String
minimum length
3
maximum length
50

paymentTypes.card.paymentPlans[n]   = CONDITIONAL

Information on valid payment plans for this order based on the values supplied in the request parameters.
Fixed value

paymentTypes.card.paymentPlans[n].endDate  String = CONDITIONAL

This field is only returned if the plan has a known end date.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
10
maximum length
50

paymentTypes.card.paymentPlans[n].minimumOrderAmounts[n]   = CONDITIONAL

This field is only returned if the plan has a minimum order amount.
Fixed value

paymentTypes.card.paymentPlans[n].minimumOrderAmounts[n].amount  Decimal = CONDITIONAL

The configured payment plans will be offered only if the total order amount is greater than or equal to this minimum order amount.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a decimal number.
JSON type
Number
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3

paymentTypes.card.paymentPlans[n].minimumOrderAmounts[n].currency  String = CONDITIONAL

Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
3
maximum length
3

paymentTypes.card.paymentPlans[n].numberOfDeferrals[n]  Integer = CONDITIONAL

Existence
CONDITIONAL
Fixed value
Validation Rules
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
JSON type
Number
minimum value
0
maximum value
99

paymentTypes.card.paymentPlans[n].numberOfPayments[n]  Integer = CONDITIONAL

Existence
CONDITIONAL
Fixed value
Validation Rules
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
JSON type
Number
minimum value
1
maximum value
99

paymentTypes.card.paymentPlans[n].payerInterest  Boolean = CONDITIONAL

Existence
CONDITIONAL
Fixed value
Validation Rules
JSON boolean values 'true' or 'false'.
JSON type
Boolean

paymentTypes.card.paymentPlans[n].planId  String = CONDITIONAL

See Payment Plans for the supported payment plans and their identifiers.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
40

paymentTypes.card.paymentPlans[n].planName  String = CONDITIONAL

This field is only returned if applicable for this payment plan
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
80

paymentTypes.card.paymentPlans[n].planTemplate  Enumeration = CONDITIONAL

This field is only returned if applicable for this payment plan.
Existence
CONDITIONAL
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
PAY_IN_FULL_AFTER_DEFERRAL
PAY_IN_INSTALLMENTS_INTEREST_FREE
PAY_IN_INSTALLMENTS_INTEREST_FREE_AFTER_DEFERRAL
PAY_IN_INSTALLMENTS_WITH_INTEREST
PAY_IN_INSTALLMENTS_WITH_INTEREST_AFTER_DEFERRAL

paymentTypes.card.paymentPlans[n].startDate  String = CONDITIONAL

This field is only returned if the plan has a known start date.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
10
maximum length
50

paymentTypes.card.scheme  Enumeration = CONDITIONAL

The card scheme also controls authorization and settlement of card transactions among issuers and acquirers.
Existence
CONDITIONAL
Fixed value
Validation Rules
JSON 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

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

For example, INTERNET, MOTO.
Existence
Always Provided
Fixed value
Validation Rules
JSON 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.
MOTO
Transaction received by mail or telephone.
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].walletProvider  Enumeration = Always Provided

Existence
Always Provided
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
AMEX_EXPRESS_CHECKOUT
Amex Express Checkout wallet provider.
MASTERPASS_ONLINE
MasterPass Online wallet provider.
VISA_CHECKOUT
Visa Checkout wallet provider.

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

Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
JSON 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

For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
JSON 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

For example, INTERNET, MOTO.
Existence
Always Provided
Fixed value
Validation Rules
JSON 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.
MOTO
Transaction received by mail or telephone.
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

For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
JSON 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

For example, INTERNET, MOTO.
Existence
Always Provided
Fixed value
Validation Rules
JSON 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.
MOTO
Transaction received by mail or telephone.
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.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

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

For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
JSON 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

For example, INTERNET, MOTO.
Existence
Always Provided
Fixed value
Validation Rules
JSON 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.
MOTO
Transaction received by mail or telephone.
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.currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

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

For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
JSON 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

For example, INTERNET, MOTO.
Existence
Always Provided
Fixed value
Validation Rules
JSON 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.
MOTO
Transaction received by mail or telephone.
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

For example, AUD stands for Australian Dollar.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
JSON 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

For example, INTERNET, MOTO.
Existence
Always Provided
Fixed value
Validation Rules
JSON 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.
MOTO
Transaction received by mail or telephone.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.

result  Enumeration = Always Provided

Existence
Always Provided
Fixed value
Validation Rules
JSON 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

transactionMode  Enumeration = Always Provided

Existence
Always Provided
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
AUTHORIZE_CAPTURE
The payment is authorized only (AUTHORIZATION transaction). The merchant must submit a Capture request to move the funds from the payer's account to the merchant's account.
PURCHASE
The payment happens immediately (PURCHASE transaction). The funds are immediately moved from the payer's account to the merchant's account.

error   = CONDITIONAL

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

error.cause  Enumeration = CONDITIONAL

For example, errors may occur due to invalid requests or internal system failures.
Fixed value
Validation Rules
JSON 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

This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
1000

error.field  String = CONDITIONAL

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
JSON type
String
minimum length
1
maximum length
100

error.supportCode  String = CONDITIONAL

This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
1
maximum length
100

error.validationType  Enumeration = CONDITIONAL

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Fixed value
Validation Rules
JSON 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

Fixed value
Validation Rules
JSON 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