Payment Options Inquiry

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

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 cardType is passed in, only the currencies applicable to that card type are returned. If a currency is passed in, only the card types applicable for that currency are returned.

GET https://na.gateway.mastercard.com/api/rest/version/16 / merchant / {merchantId} / paymentOptionsInquiry

Authentication Copied to clipboard

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 Reporting API password in the password portion.

Request Copied to clipboard

URL Parameters Copied to clipboard

{merchantId} Copied to clipboard Alphanumeric + additional characters REQUIRED

The unique identifier issued to you by your payment provider.


Data may consist of the characters 0-9, a-z, A-Z, '-', '_'

Min length: 1 Max length: 40

Fields Copied to clipboard

To view the optional fields, please toggle on the "Show optional" setting.

cardType Copied to clipboard Enumeration

The card type used for the payment.

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 Copied to clipboard String

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.

Data can consist of any characters

Min length: 1 Max length: 100
currency Copied to clipboard Upper case alphabetic text

The currency of the order expressed as an ISO 4217 alpha code.

Data must consist of the characters A-Z

Min length: 3 Max length: 3
paymentType Copied to clipboard Enumeration

The payment method the cardholder wishes to use to pay for this order.

For example, CREDIT, PAYPAL, BANCANET, SOFORT, GIROPAY.

Value must be a member of the following list. The values are case sensitive.

BANCANET
CREDIT
GIROPAY
PAYPAL
SOFORT
transactionSource Copied to clipboard Enumeration

The source through which the order has been received.

For example, INTERNET, MOTO.

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.


Response Copied to clipboard

Fields Copied to clipboard

3DSecureSchemes[n] Copied to clipboard

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.

3DSecureSchemes[n].3DSecureScheme Copied to clipboard 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.

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 Copied to clipboard Boolean ALWAYS PROVIDED

Indicates if you are allowed to use the Address Verification Service (AVS) to verify address details supplied by the cardholder.

JSON boolean values 'true' or 'false'.

cardSecurityCode Copied to clipboard 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.

JSON boolean values 'true' or 'false'.

cardTypes[n] Copied to clipboard

Information on the card types supported for this order.

cardTypes[n].cardType Copied to clipboard 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.

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 Copied to clipboard String

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.

Data can consist of any characters

Min length: 1 Max length: 100
currencies[n] Copied to clipboard

Information on the currencies supported for this order.

currencies[n].currency Copied to clipboard Upper case alphabetic text

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.

Data must consist of the characters A-Z

Min length: 3 Max length: 3
enforceCardSecurityCodeEntry Copied to clipboard Enumeration

Indicates if the cardholder must be forced to enter the Card Security Code (CSC) when using a credit card to pay for the order.

Value must be a member of the following list. The values are case sensitive.

FALSE
TRUE
UNDETERMINED
merchant Copied to clipboard Alphanumeric + additional characters ALWAYS PROVIDED

Your identifier issued to you by your provider.

Data may consist of the characters 0-9, a-z, A-Z, '-', '_'

Min length: 1 Max length: 40
noCardSecurityCodePrintedOnCard Copied to clipboard Boolean ALWAYS PROVIDED

Indicates if you are allowed to accept payments from credit cards without a Card Security Code (CSC) printed on the card.

JSON boolean values 'true' or 'false'.

paymentPlans[n] Copied to clipboard

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

paymentPlans[n].endDate Copied to clipboard String

The end date for the payment plan.

This field is only returned if the plan has a known end date.

Data can consist of any characters

Min length: 10 Max length: 50
paymentPlans[n].minimumOrderAmounts[n] Copied to clipboard

Information on the minimum order amount for the payment plan.

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

paymentPlans[n].minimumOrderAmounts[n].amount Copied to clipboard Decimal

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.

Data is a decimal number.

Max value: 1000000000000 Min value: 0 Max post-decimal digits: 3
paymentPlans[n].minimumOrderAmounts[n].currency Copied to clipboard String

The currency (expressed as an ISO 4217 alpha code) for the minimum order amount.

Data can consist of any characters

Min length: 3 Max length: 3
paymentPlans[n].numberOfDeferrals[n] Copied to clipboard

Information on the number of deferral months for payment plans.

Applicable only to payment plans supporting deferrals.

paymentPlans[n].numberOfDeferrals[n].numberOfDeferral Copied to clipboard Integer

The list of valid values specifying the number of months for which the payment can be deferred.

JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.

Min value: 1 Max value: 99
paymentPlans[n].numberOfPayments[n] Copied to clipboard

Information on the number of installments for the payment plan.

Applicable only to payment plans supporting installments.

paymentPlans[n].numberOfPayments[n].numberOfPayment Copied to clipboard Integer

The list of valid values specifying the number of monthly installments payable by the cardholder.

JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.

Min value: 1 Max value: 99
paymentPlans[n].planId Copied to clipboard String

An auto-generated unique identifier for the payment plan, which is assigned by the system when you configure the payment plan in Merchant Administration.

The Plan ID is unique across all Payment Plan types configured for you. This field is returned only if plan type is BANAMEX_CUSTOM.

Data can consist of any characters

Min length: 1 Max length: 16
paymentPlans[n].planName Copied to clipboard String

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

Data can consist of any characters

Min length: 1 Max length: 80
paymentPlans[n].planTemplate Copied to clipboard Enumeration

The payment plan template used to generate this payment plan instance.

This field is only returned if applicable for this payment plan.

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 Copied to clipboard String

The start date for the payment plan.

This field is only returned if the plan has a known start date.

Data can consist of any characters

Min length: 10 Max length: 50
paymentPlans[n].type Copied to clipboard Enumeration

The type of payment plan.

Value must be a member of the following list. The values are case sensitive.

AMEX_PLANAMEX
AMEX_PLANN
BANAMEX_CUSTOM
BANORTE_FULL_PAYMENT_WITH_DEFERRAL
BANORTE_WITHOUT_INTEREST
BANORTE_WITH_INTEREST
CIELO
REDECARD
paymentTypes[n] Copied to clipboard

Information on payment types for this order.

paymentTypes[n].paymentType Copied to clipboard 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.

Value must be a member of the following list. The values are case sensitive.

BANCANET
CREDIT
GIROPAY
PAYPAL
SOFORT
result Copied to clipboard Enumeration ALWAYS PROVIDED

A system-generated high level overall result of the transaction/operation.

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 Copied to clipboard 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.

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] Copied to clipboard

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

transactionSources[n].transactionSource Copied to clipboard 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.

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.

Errors Copied to clipboard

error Copied to clipboard

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

error.cause Copied to clipboard Enumeration

Broadly categorizes the cause of the error.

For example, errors may occur due to invalid requests or internal system failures.

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 Copied to clipboard String

Textual description of the error based on the cause.

This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.

Data can consist of any characters

Min length: 1 Max length: 1000
error.field Copied to clipboard String

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.

Data can consist of any characters

Min length: 1 Max length: 100
error.supportCode Copied to clipboard String

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.

Data can consist of any characters

Min length: 1 Max length: 100
error.validationType Copied to clipboard Enumeration

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.

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 Copied to clipboard Enumeration

A system-generated high level overall result of the operation.

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.