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.
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 API password in the password portion.
Request Copied to clipboard
URL Parameters Copied to clipboard
Alphanumeric + additional characters
REQUIRED
The unique identifier issued to you by your payment provider.
This identifier can be up to 12 characters in length.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Min length: 1 Max length: 40Fields Copied to clipboard
To view the optional fields, please toggle on the "Show optional fields" setting.
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.
Data can consist of any characters
OPTIONAL
Additional information about the external token repository you are configured with.
These fields are MANDATORY for MerchantLink merchants and must not contain sensitive data.
String
OPTIONAL
Provide the site code required to save card details against a token.
For example: '{"siteCode":"BNE"}'.
Data can consist of any characters
OPTIONAL
Information about the order associated with this transaction.
Decimal
OPTIONAL
The total amount for the order.
If you supply this value then you must provide order.currency to filter the response values.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Upper case alphabetic text
OPTIONAL
The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
Enumeration
OPTIONAL
The payment method the payer wishes to use to pay for this order.
Value must be a member of the following list. The values are case sensitive.
BANCANET
CREDIT
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.
Data consists of ASCII characters
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.
Digits
OPTIONAL
The first 6 digits of the card number up to a maximum of 9 digits, as printed on the card.
Data is a string that consists of the characters 0-9.
Alphanumeric
OPTIONAL
Uniquely identifies a card and associated details.
Data may consist of the characters 0-9, a-z, A-Z
Enumeration
OPTIONAL
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
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.
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
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'.
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'.
CONDITIONAL
Information on the card types supported for this order.
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
EBT
ELO
FARMERS_CARD
JCB
LASER
MASTERCARD
MASTERCARD_PURCHASE_CARD
PRIVATE_LABEL_CARD
Q_CARD
SORIANA
TRUE_REWARDS
UATP
VISA
VISA_DEBIT
VISA_PURCHASE_CARD
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.
Data can consist of any characters
CONDITIONAL
Information on the currencies supported for this order.
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.
Data must consist of the characters A-Z
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.
Value must be a member of the following list. The values are case sensitive.
FALSE
TRUE
UNDETERMINED
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, '-', '_'
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'.
CONDITIONAL
Information on valid payment plans for this order based on the values supplied in the request parameters.
String
CONDITIONAL
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
CONDITIONAL
Information on the minimum order amount for the payment plan.
This field is only returned if the plan has a minimum order 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.
Data is a decimal number.
String
CONDITIONAL
The currency (expressed as an ISO 4217 alpha code) for the minimum order amount.
Data can consist of any characters
Integer
CONDITIONAL
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.
Integer
CONDITIONAL
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.
Boolean
CONDITIONAL
Indicates if the payer is charged interest on the payment plan.
JSON boolean values 'true' or 'false'.
String
CONDITIONAL
The identifier for the payment plan.
See Payment Plans for the supported payment plans and their identifiers.
Data can consist of any characters
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
Data can consist of any characters
Enumeration
CONDITIONAL
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
String
CONDITIONAL
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
CONDITIONAL
Information on payment types for this order.
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
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
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.
CONDITIONAL
Information on the supported sources through which the order can be received.
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.
CONDITIONAL
Indicates the wallet providers you are enabled and configured for, and that are supported for this order.
Enumeration
ALWAYS PROVIDED
The wallet provider used to collect the customer's payment details used for this transaction.
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.
Errors Copied to clipboard
Information on possible error conditions that may occur while processing an operation using the API.
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.
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
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
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
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.
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.