Shopping Options Inquiry
Request to retrieve the options available for shopping cart interactions.
This request can be used to retrieve foreign exchange rate quotes from your Multi-Currency Pricing service provider. This allows you to display your shopping cart pages and then process payments in the payer's currency using guaranteed rates.
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
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
Information about Foreign Exchange (FX) rates provided by your Multi-Currency Pricing service provider.
Upper case alphabetic text
REQUIRED
The currency that your Multi-Currency Pricing service provider will use for settlement to your account.
This is also the currency in which you price your inventory, expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
Container for fields that control the response returned for the request.
Enumeration
OPTIONAL
Indicates if you wish the gateway to return details of Foreign Exchange (FX) rate quotes from your Multi-Currency Pricing service provider in the service provider's format.
If you set this value to INCLUDE, the full response data from the service provider will be returned in multiCurrencyPricing.providerResponseData.
If you do not specify this value it will be set to EXCLUDE.
Value must be a member of the following list. The values are case sensitive.
EXCLUDE
Exclude the full response data from the service provider.
INCLUDE
Include the full response data from the service provider.
Response Copied to clipboard
Fields Copied to clipboard
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
Alphanumeric + additional characters
ALWAYS PROVIDED
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, '-', '_'
Information about Foreign Exchange (FX) rates provided by your Multi-Currency Pricing service provider.
Upper case alphabetic text
ALWAYS PROVIDED
The currency that your Multi-Currency Pricing service provider will use for settlement to your account.
This is also the currency in which you price your inventory, expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
Alphanumeric
ALWAYS PROVIDED
The Multi-Currency Pricing service provider's unique reference for a set of Foreign Exchange (FX) rate quotes.
You can use this value if you are talking to your provider about a rate quote.
When submitting a SHOPPING_OPTIONS_INQUIRY request can get the full rate quote response data returned by the MCP service provider by setting the responseControls.mcpSourceData to INCLUDE.
Data may consist of the characters 0-9, a-z, A-Z
JSON Text
CONDITIONAL
The full rate quote response data returned by your Multi-Currency Pricing service provider.
If you wish to return this data, then set responseControls.mcpResponseData to INCLUDE.
Data is valid Json Format
Details of the Foreign Exchange (FX) currencies and rates available for your specified multiCurrencyPricing.merchantCurrency.
A rate will be provided for each payer currency and tenor for which you have been configured by your Multi-Currency Pricing service provider.
For example, if your merchant currency is USD, and you are configured for GBP and AUD payer currencies for both SP (spot) and 1W (1 week) tenors, then you will receive four quotes: GBP/SP, GBP/1W, AUD/SP, AUD/1W.
Decimal
ALWAYS PROVIDED
The Foreign Exchange (FX) rate quoted.
To convert amounts in your merchant currency to an amount in the payer's currency, multiply by this rate.
For example, if multiCurrencyPricing.merchantCurrency is USD, multiCurrencyPricing.quote[[n].payerCurrency is GBP, and the fxRate is 0.7743, then 100 USD =77.43 GBP.
Note: it is your responsibility to round or truncate the foreign amount you calculate as appropriate for the currency and your needs. For example, if you calculated a payer amount for GBP of 77.4356, then you round it to no more than two decimal places (77.44). You could also choose to round it to say 77.50.
Whatever rule you chose, the amount that goes into your account will be determined by the payer amount that you provide in the payment transaction request.
Data is a decimal number.
Upper case alphabetic text
ALWAYS PROVIDED
A foreign currency you can present to the payer on your website.
If you use this quote, then it is also the currency you use for the payment transaction.
The currency is expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
String
ALWAYS PROVIDED
Unique identifier for the Foreign Exchange (FX) rate quote for this payer currency and tenor.
You must provide this identifier in a payment transaction request (for example, AUTHORIZE or PAY) when you used this FX rate quote to calculate the payment amount.
Data can consist of any characters
Alphanumeric
ALWAYS PROVIDED
The period of time from the date of the deal (payment transaction) until the date it settles (value date).
For example, spot (SP), one week (1W), one month (1M).
These values are expressed in industry standard terms. For the majority of Multi-Currency Pricing cases, Spot (SP) tenor is used.
Data may consist of the characters 0-9, a-z, A-Z
DateTime
ALWAYS PROVIDED
The date and time when the Foreign Exchange (FX) rate quote expires.
After this time, your Multi-Currency Pricing (MCP) service provider might not guarantee the rate.
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
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
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.