MasterCard Payment Gateway API Reference: Operations -
Version 25,
Protocol: REST-JSON

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://ap-gateway.mastercard.com/api/rest/version/25/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

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

order   = OPTIONAL

Information about the order associated with this transaction.
Fixed value

order.amount  Decimal = OPTIONAL

The total amount for the order.
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

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

paymentType  Enumeration = OPTIONAL

The payment method the payer wishes to use to pay for this order.
Existence
OPTIONAL
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
BANCANET
CREDIT
GIROPAY
PAYPAL
SOFORT

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

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.prefix  Digits = OPTIONAL

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

sourceOfFunds.token  Alphanumeric = OPTIONAL

Uniquely identifies a card and associated details.
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

The source through which the order has been received.
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

The unique identifier issued to you by your payment provider.
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

addressVerificationService  Boolean = Always Provided

Indicates if you are allowed to use the Address Verification Service (AVS) to verify address details supplied by the cardholder.
Existence
Always Provided
Fixed value
Validation Rules
JSON boolean values 'true' or 'false'.
JSON type
Boolean

cardSecurityCode  Boolean = Always Provided

Indicates if you are allowed to use the Card Security Check to verify the Card Security Code (CSC) supplied by the cardholder.
Existence
Always Provided
Fixed value
Validation Rules
JSON boolean values 'true' or 'false'.
JSON type
Boolean

merchant  Alphanumeric + additional characters = Always Provided

Your identifier issued to you by your provider.
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

noCardSecurityCodePrintedOnCard  Boolean = Always Provided

Indicates if you are allowed to accept payments from credit cards without a Card Security Code (CSC) printed on the card.
Existence
Always Provided
Fixed value
Validation Rules
JSON boolean values 'true' or 'false'.
JSON type
Boolean

result  Enumeration = Always Provided

A system-generated high level overall result of the transaction/operation.
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

Defines the merchants transaction mode, i.e. if the funds are immediately requested to be moved from the payer's account or the payment is authorized only and the funds will be moved/captured later.
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.

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

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
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_C0DE
VERIFIED_BY_VISA

addressVerificationService  Boolean = Always Provided

Indicates if you are allowed to use the Address Verification Service (AVS) to verify address details supplied by the cardholder.
Existence
Always Provided
Fixed value
Validation Rules
JSON boolean values 'true' or 'false'.
JSON type
Boolean

cardSecurityCode  Boolean = Always Provided

Indicates if you are allowed to use the Card Security Check to verify the Card Security Code (CSC) supplied by the cardholder.
Existence
Always Provided
Fixed value
Validation Rules
JSON boolean values 'true' or 'false'.
JSON type
Boolean

cardTypes[n]   = CONDITIONAL

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

cardTypes[n].cardType  Enumeration = 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
JSON type
String
Value must be a member of the following list. The values are case sensitive.
AMEX
AMEX_PURCHASE_CARD
BANAMEX_COSTCO
CARNET
CARTE_BANCAIRE
COSTCO_MEMBER_CREDIT
DINERS_CLUB
DISCOVER
EBT
ELO
FARMERS_CARD
JCB
LASER
MAESTRO
MASTERCARD
MASTERCARD_PURCHASE_CARD
PRIVATE_LABEL_CARD
Q_CARD
RUPAY
SORIANA
TRUE_REWARDS
UATP
VISA
VISA_DEBIT
VISA_PURCHASE_CARD

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

currencies[n]   = CONDITIONAL

Information on the currencies supported for this order.
Fixed value

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

currencyConversion   = CONDITIONAL

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

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

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

currencyConversion.gatewayCode  Enumeration = Always Provided

Summary of the success or otherwise of the DCC quote request.
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.

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

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

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

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

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

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

enforceCardSecurityCodeEntry  Enumeration = CONDITIONAL

Indicates if the cardholder must be forced to enter the Card Security Code (CSC) when using a credit card to pay for the order.
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

merchant  Alphanumeric + additional characters = Always Provided

Your identifier issued to you by your provider.
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

noCardSecurityCodePrintedOnCard  Boolean = Always Provided

Indicates if you are allowed to accept payments from credit cards without a Card Security Code (CSC) printed on the card.
Existence
Always Provided
Fixed value
Validation Rules
JSON boolean values 'true' or 'false'.
JSON type
Boolean

paymentPlans[n]   = CONDITIONAL

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

paymentPlans[n].endDate  String = CONDITIONAL

The end date for the payment plan.
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

paymentPlans[n].minimumOrderAmounts[n]   = CONDITIONAL

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

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

The minimum order amount for the payment plan.
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

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

The currency (expressed as an ISO 4217 alpha code) for the minimum order amount.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
JSON type
String
minimum length
3
maximum length
3

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

The list of valid values specifying the number of months for which the payment can be deferred.
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

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

The list of valid values specifying the number of monthly installments payable by the cardholder.
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

paymentPlans[n].payerInterest  Boolean = CONDITIONAL

Indicates if the payer is charged interest on the payment plan.
Existence
CONDITIONAL
Fixed value
Validation Rules
JSON boolean values 'true' or 'false'.
JSON type
Boolean

paymentPlans[n].planId  String = CONDITIONAL

The identifier for the payment plan.
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

paymentPlans[n].planName  String = CONDITIONAL

The plan name as specified by you when you defined the parameters for this payment plan.
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

paymentPlans[n].planTemplate  Enumeration = CONDITIONAL

The payment plan template used to generate this payment plan instance.
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

paymentPlans[n].startDate  String = CONDITIONAL

The start date for the payment plan.
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[n]   = CONDITIONAL

Information on payment types for this order.
Fixed value

paymentTypes[n].paymentType  Enumeration = Always Provided

The list of valid payment types for this order based on the values supplied in the request parameters.
For example, CREDIT, PAYPAL.
Existence
Always Provided
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
BANCANET
CREDIT
GIROPAY
PAYPAL
SOFORT

result  Enumeration = Always Provided

A system-generated high level overall result of the transaction/operation.
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

Defines the merchants transaction mode, i.e. if the funds are immediately requested to be moved from the payer's account or the payment is authorized only and the funds will be moved/captured later.
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.

transactionSources[n]   = CONDITIONAL

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

transactionSources[n].transactionSource  Enumeration = Always Provided

The list of valid transaction sources for this order based on the values supplied in the request parameters.
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.

walletProviders[n]   = CONDITIONAL

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

walletProviders[n].walletProvider  Enumeration = Always Provided

The wallet provider used to collect the customer's payment details used for this transaction.
Existence
Always Provided
Fixed value
Validation Rules
JSON type
String
Value must be a member of the following list. The values are case sensitive.
MASTERPASS_ONLINE
MasterPass Online wallet provider.
VISA_CHECKOUT
Visa Checkout wallet provider.

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

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

A system-generated high level overall result of the operation.
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