Update Acquirer Link
Operation to create or update a merchant's acquirer link.
Authentication
This operation requires authentication via one of the following methods:
- Certificate authentication.
-
Basic HTTP authentication as described at
w3.org.
Provide 'MSO.
<your gateway MSO ID>
' in the userid portion and your API password in the password portion.
Request
URL Parameters
Alphanumeric + additional characters
REQUIRED
The identifier that uniquely identifies you or an MSO that has authorized you to use this operation on their behalf.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.'
Min length: 1 Max length: 16Alphanumeric + 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: 36Fields
String
= UPDATE_MERCHANT_ACQUIRER_LINK
FIXED
Any sequence of zero or more unicode characters.
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
REQUIRED
The merchant's details.
REQUIRED
The merchant's acquirer link details.
Boolean
OPTIONAL
Allows you to enable the Account Updater functionality for this merchant acquirer link.
Account Updater provides updates received on cardholder accounts from participating issuers to the associated card schemes. To enable the merchant to receive these updates, your merchant must register for this feature with the acquirer and the associated card schemes. If Account Updater is enabled,
- you can enable the Token Maintenance Service functionality for the merchant and
- the merchant can request account updates for tokens that contain payment details for which transaction requests are processed via this acquirer.
JSON boolean values 'true' or 'false'.
OPTIONAL
Details regarding an NPCI acquirer link configuration.
Boolean
OPTIONAL
Defines if merchant is a small merchant in accordance with the RBI(Reserve Bank of India) guidelines.
JSON boolean values 'true' or 'false'.
Enumeration
OPTIONAL
The transaction frequency the merchant will be allowed to set when initiating a transaction.
You may select multiple transaction frequencies.
Note: If you set this value it will only apply if the merchant uses version 53 and lower of the API.
Value must be a member of the following list. The values are case sensitive.
INSTALLMENTS
The transaction identifies a payment that is paid off in installments.
RECURRING
The transaction is one in a number of recurring payments.
SINGLE_TRANSACTION
The transaction identifies a one-off payment.
Enumeration
OPTIONAL
The transaction sources the merchant will be allowed to set when initiating a transaction.
You may select multiple transaction sources.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
The merchant can set Call Centre as the transaction source when initiating a transaction.
CARD_PRESENT
The merchant can set Card Present as the transaction source when initiating a transaction.
INTERNET
The merchant can set Internet as the transaction source when initiating a transaction.
MAIL_ORDER
The merchant can set Mail Order as the transaction source when initiating a transaction.
MERCHANT
The merchant can set Merchant as the transaction source when initiating a transaction.
MOTO
The merchant can set Mail Order/Telephone Order (MOTO) as the transaction source when initiating a transaction.
TELEPHONE_ORDER
The merchant can set Telephone Order as the transaction source when initiating a transaction.
VOICE_RESPONSE
The merchant can set Voice Response as the transaction source when initiating a transaction.
String
OPTIONAL
The time each day, at which automatic settlement of transactions with the acquirer should be triggered by the gateway.
Data can consist of any characters
Alphanumeric + additional characters
OPTIONAL
A 4-digit code used to classify the merchant's business by the type of goods or services it offers.
This is also known as the Merchant Category Code (MCC).
You can provide a single MCC or multiple MCCs as a comma-separated list (the first entry will be used as the default). When you specify multiple MCC values, the merchant can provide an MCC value from this list to use for a transaction.
You can also specify the value 'ANY' (only if supported by the acquirer) to enable the merchant to provide any MCC value for a transaction.
Data may consist of the characters 0-9, a-z, A-Z, ','
String
OPTIONAL
The Bank Merchant ID/SE Number is an identifier allocated to the merchant by their acquiring bank.
If you set up more than one acquirer link for a single acquirer, these do not need to use the same Bank Merchant ID.
Data can consist of any characters
String
OPTIONAL
The identifier for the set of card BINs that are allowed to be processed using this acquirer link.
Use this field to ensure that transactions performed with a card with a BIN in this set is routed via this acquirer link. For example, domestic card transactions must be routed to a specific merchant acquirer link and cross-border transactions can be routed to a different link. The same card BIN set may be set up on multiple acquirer links, however, the combination of line of business, payment type, currency, and card BIN set must be unique on each acquirer link. Note: this identifier must match the one assigned by the gateway for the card BIN set.
Data can consist of any characters
String
OPTIONAL
The list of valid card types supported by this merchant acquirer link.
Data can consist of any characters
Alphanumeric
REQUIRED
The list of currencies supported for this merchant acquirer link, expressed using the three-letter alphabetic code according to ISO-4217 must be provided, e.g. "USD" for United States Dollar.
Data may consist of the characters 0-9, a-z, A-Z
Enumeration
REQUIRED
The merchants default transaction frequency must be one of the allowable transaction frequencies for this merchant.
Defines the transaction frequency set, if none has been provided for that transaction.
Note: If you set this value it will only apply if the merchant uses version 53 and lower of the API.
Value must be a member of the following list. The values are case sensitive.
INSTALLMENTS
The transaction identifies a payment that is paid off in installments.
RECURRING
The transaction is one in a number of recurring payments.
SINGLE_TRANSACTION
The transaction identifies a one-off payment.
Enumeration
REQUIRED
The merchants default transaction source must be one of the allowable transaction sources for this merchant.
Defines the transaction source sent to the acquirer, if none has been provided for that transaction.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
The merchant can set Call Centre as the transaction source when initiating a transaction.
CARD_PRESENT
The merchant can set Card Present as the transaction source when initiating a transaction.
INTERNET
The merchant can set Internet as the transaction source when initiating a transaction.
MAIL_ORDER
The merchant can set Mail Order as the transaction source when initiating a transaction.
MERCHANT
The merchant can set Merchant as the transaction source when initiating a transaction.
MOTO
The merchant can set Mail Order/Telephone Order (MOTO) as the transaction source when initiating a transaction.
TELEPHONE_ORDER
The merchant can set Telephone Order as the transaction source when initiating a transaction.
VOICE_RESPONSE
The merchant can set Voice Response as the transaction source when initiating a transaction.
Enumeration
OPTIONAL
Allows you to specify transaction sources for which a Card Security Code (CSC) must be provided when processing transactions using this merchant acquirer link.
CSC enforcement does not apply to:
- Merchant-initiated transactions.
- Card Present transactions.
- Transactions with Maestro cards for a transaction source of Internet.
CSC enforcement only applies to Authorization, Purchase, and Standalone Capture transactions.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
The merchant can set Call Centre as the transaction source when initiating a transaction.
CARD_PRESENT
The merchant can set Card Present as the transaction source when initiating a transaction.
INTERNET
The merchant can set Internet as the transaction source when initiating a transaction.
MAIL_ORDER
The merchant can set Mail Order as the transaction source when initiating a transaction.
MERCHANT
The merchant can set Merchant as the transaction source when initiating a transaction.
MOTO
The merchant can set Mail Order/Telephone Order (MOTO) as the transaction source when initiating a transaction.
TELEPHONE_ORDER
The merchant can set Telephone Order as the transaction source when initiating a transaction.
VOICE_RESPONSE
The merchant can set Voice Response as the transaction source when initiating a transaction.
OPTIONAL
Allows you to define exclusion rules for transactions that must not be processed via the merchant acquirer link based on the combination of card type, funding method and issuer country.
For example, if the merchant acquirer link is configured for card types Mastercard and Visa but you want to exclude all Debit cards issued in Canada, provide merchant.acquirerLink.exclusionRules[0].fundingMethods[DEBIT] and merchant.acquirerLink.exclusionRules[0].issuingCountries=[CAN].
Comma separated strings
OPTIONAL
Provide the list of card types for which the exclusion rule applies.
You can only specify card types that are supported by this merchant acquirer link. If this field is not provided or is provided and empty, the exclusion rule will be applied to all card brands.
Data can consist of any characters
Comma separated strings
OPTIONAL
Provide the list of issuer countries for which the rule does not apply.
The rule will be applied to all but the countries listed. If the exclusion rule applies to a small number of countries, you may instead want to define the list of countries to which the exclusion rule applies, in field merchant.acquirerLink.exclusionRules[n].issuerCountries. If neither merchant.acquirerLink.exclusionRules[n].issuerCountries nor merchant.acquirerLink.exclusionRules[n].excludedIssuerCountries are provided, the exclusion rule will be applied for all issuer countries. Provide the three-letter country code according to ISO 3166-1 alpha-3.
Each String represents an ISO 3166-1 alpha-3 code for the country.
Comma separated enumeration
OPTIONAL
Provide the list of funding methods for which the exclusion rule applies.
If this field is not provided or is provided and empty, the exclusion rule will be applied to all funding methods.
Value must be one or more comma separated members of the following list. The values are case sensitive.
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.
CHARGE
The payer has a line of credit with the issuer which must be paid off monthly.
UNKNOWN
The account funding method could not be determined.
Comma separated strings
OPTIONAL
Provide the list of issuer countries for which the exclusion rule applies.
If the exclusion rule applies to a large number of countries, you may instead want to define the list of countries to which the exclusion rule does not apply, in field merchant.acquirerLink.exclusionRules[n].excludedIssuerCountries. If neither merchant.acquirerLink.exclusionRules[n].issuerCountries nor merchant.acquirerLink.exclusionRules[n].excludedIssuerCountries are provided, the exclusion rule will be applied for all issuer countries. Provide the three-letter country code according to ISO 3166-1 alpha-3.
Each String represents an ISO 3166-1 alpha-3 code for the country.
Enumeration
OPTIONAL
Defines how transactions for which the gateway is unable to determine the issuer country should be handled.
Value must be a member of the following list. The values are case sensitive.
EXCLUDED
The exclusion rule will not be applied to requests where the issuer country could not be determined by the gateway.
INCLUDED
The exclusion rule will be applied to requests where the issuer country could not be determined by the gateway.
String
OPTIONAL
Description of the goods sold by the merchant, for example, books or electronics.
Data can consist of any characters
Alphanumeric + additional characters
REQUIRED
An identifier to uniquely identify an acquirer link for the merchant on the gateway.
Use this identifier to specify an acquirer link when updating details for that acquirer link.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
String
OPTIONAL
If, when integrating with the gateway, the merchant is using a solution (e.g. a shopping cart or e-commerce solution) that you provide, support or certify, you may want to use this field to provide a unique identifier for the solution.
Data can consist of any characters
Enumeration
REQUIRED
The payment types supported by this acquirer via this merchant acquirer link.
Value must be a member of the following list. The values are case sensitive.
ACH
The acquirer supports ACH payments.
ALIPAY
The acquirer supports Alipay payments.
BANCANET
The acquirer supports BancaNet Directo online browser payments.
BOLETO_BANCARIO
The acquirer supports Boleto Bancario payments.
CREDIT
The acquirer supports credit cards, debit cards such as Maestro Debit card, and/or Visa debit cards.
ENETS
The acquirer supports eNETS payments.
GIFT_CARD
The acquirer supports Gift Card payments.
GIROPAY
The acquirer supports giropay online browser payments.
GRABPAY
The acquirer supports GrabPay payments.
IDEAL
The acquirer supports iDEAL payments.
KLARNA_FINANCING
The acquirer supports Klarna Financing payments.
KLARNA_PAY_LATER
The acquirer supports Klarna Pay Later payments.
MERCADO_PAGO_CHECKOUT
The acquirer supports Mercado Pago Checkout payments.
OXXO
The acquirer supports OXXO payments.
PAYPAL
The acquirer supports PayPal online browser payments.
PBBA
The acquirer supports pay by bank app payments.
POLI
The acquirer supports POLi payments.
REWARD
The acquirer supports reward points payments.
SEPA
The acquirer supports SEPA payments.
SOFORTBANKING
The acquirer supports Sofortbanking online browser payments.
UNION_PAY
The acquirer supports UnionPay SecurePay browser payments.
WECHAT_PAY
The acquirer supports WeChatPay payments.
OPTIONAL
Configuration of the merchant-acquirer link to use exemptions from the Regulatory Technical Standards (RTS) requirements for Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2) regulations in the European Economic Area.
Integer
OPTIONAL
The merchant's fraud rate, as determined by the acquirer, expressed in basis points (bps).
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Enumeration
OPTIONAL
A list of Payment Services Directive 2 (PSD2) exemptions that the merchant can claim.
Provide a comma-separated list of applicable values.
Value must be a member of the following list. The values are case sensitive.
LOW_RISK
Allows the merchant to claim an exemption because the acquirer has a low fraud rate.
SCA_DELEGATION
Allows the merchant to claim an exemption where the issuer has delegated Strong Customer Authentication (SCA) using a compliant method to a third party.
SECURE_CORPORATE_PAYMENT
Allows the merchant to claim an exemption because the transaction is a corporate or Business-to-Business (B2B) payment performed using dedicated payment processes and protocols that are not available to consumers and offer at least equivalent security levels.
Enumeration
REQUIRED
Defines if the merchant can use the acquirer link and if so, for what purpose.
Note:
Setting the value to FALLBACK can be used to support moving processing of the merchant's transactions from one acquirer link to another.
When moving transaction processing from one link to another, the status of the new link is set to TEST_AND_PRODUCTION or TEST_ONLY, and the status of the old link is set to FALLBACK. In this case,
- New orders will be processed using the new link, and
- Subsequent transactions for orders created using the old link will be processed on the old link.
Value must be a member of the following list. The values are case sensitive.
DISABLED
The acquirer link can no longer be used by the merchant.
FALLBACK
The acquirer link is used to process transactions when no other suitable test or production link is available, or to process subsequent transactions on a order that was created on this link.
TEST_AND_PRODUCTION
The acquirer link can be used for testing and processing live transactions.
TEST_ONLY
The acquirer link can be used for testing only but not processing live transactions.
Alphanumeric
OPTIONAL
The unique identifiers for the terminal IDs, that the acquirer assigned to the merchant.
Data may consist of the characters 0-9, a-z, A-Z
Hex
OPTIONAL
The Merchant Verification Value (MVV) assigned to the merchant by Visa.
Value will be submitted to the acquirer on transaction requests with card type Visa (if supported).
Data is hexadecimal encoded
OPTIONAL
Details that are specific for a specific acquirer.
OPTIONAL
Details regarding an AMEX_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding an ANZAU_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding an ANZNZ_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
ANZ National Bank via MAA
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding a B+S Card Services acquirer link configuration.
Enumeration
OPTIONAL
The industry code that the merchant operates in, as used by the financial institution.
Value must be a member of the following list. The values are case sensitive.
ADULT
AIRLINE
AUCTION
DIGITAL_CONTENT
E_TICKETING
GAMBLING
GAMING
HOTEL
ONLINE_FINANCIAL
RETAIL
SERVICES
TRAVEL
UTILITIES
OPTIONAL
Details regarding an BancaNet acquirer link configuration.
Digits
OPTIONAL
The merchant's business or establishment number.
This field is mandatory only if the Payment Reference Type is "CAPTURE_A" or "CAPTURE_B".
Data is a number between 101 and 999999 represented as a string.
Digits
OPTIONAL
The identifier used by BancaNet Directo to determine the destination of funds transfer.
The value for this field must be an integer and must not exceed 4 digits.
Data is a number between 0 and 9999 represented as a string.
Digits
OPTIONAL
The merchant's Banamex Electronic Banking ID provided by the merchant when signing the BancaNet Directo contract.
The value for this field must be an integer and must not exceed 12 digits.
Data is a number between 0 and 999999999999 represented as a string.
Digits
OPTIONAL
The identifier for the merchant's bank account number.
This must be the same bank account number, the bank details of which are registered against the BancaNet Directo account.
Data is a number between 0 and 9999999 represented as a string.
Digits
OPTIONAL
The identifier for the bank branch that holds the merchant's account.
This must be the same bank, the account details of which are registered against the BancaNet Directo account.
Data is a number between 0 and 9999 represented as a string.
Enumeration
OPTIONAL
The merchant's choice of payment reference type when signing the BancaNet Directo contract.
Value must be a member of the following list. The values are case sensitive.
ALPHANUMERIC
The gateway uses the algorithm MOD-97 to generate a alphanumeric Merchant Payment Reference.
BOTH
The gateway uses the algorithm MOD-97 to generate a numeric as well as an alphanumeric for the Merchant Payment Reference.
CAPTURE_A
The merchant's choice of payment reference type is the capture line A.
CAPTURE_B
The merchant's choice of payment reference type is the capture line B.
NUMERIC
The gateway uses the algorithm MOD-97 to generate a numeric Merchant Payment Reference.
OPTIONAL
Details regarding a Banorte acquirer link configuration.
Alphanumeric
OPTIONAL
Provider password (Pwd) required to access the processing system.
The merchant receives this information when they set up an account with Banorte.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
OPTIONAL
Provider user name (Usr) required to access the processing system.
The merchant receives this information when they set up an account with Banorte.
Data may consist of the characters 0-9, a-z, A-Z
OPTIONAL
Bank of China via MAA
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding boleto bancario acquirer link configuration.
Digits
REQUIRED
The number issued by Citi that uniquely identifies the merchant.
Data is a string that consists of the characters 0-9.
Digits
REQUIRED
The number issued by Citi that uniquely identifies the merchant's account that will process this transaction.
Data is a string that consists of the characters 0-9.
Boolean
OPTIONAL
An indicator that specifies if the Control Number will be provided by the Merchant during transaction processing.
The Control Number is used in forming the barcode on the Boleto.
JSON boolean values 'true' or 'false'.
Digits
REQUIRED
The number issued by Citi that uniquely identifies the type of transaction associated with merchant.
Data is a string that consists of the characters 0-9.
OPTIONAL
Details regarding an BQL_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
PT.
Bank Rakyat Indonesia (Persero) Tbk. via MAA
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding a CAP acquirer link configuration.
String
REQUIRED
The Store Id is an identifier allocated to the merchant by CAP as part of on boarding process.
Data can consist of any characters
OPTIONAL
Details regarding an CBA_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding a CIC acquirer link configuration.
Enumeration
OPTIONAL
The industry code that the merchant operates in, as used by the financial institution.
Value must be a member of the following list. The values are case sensitive.
ADULT
AIRLINE
AUCTION
DIGITAL_CONTENT
E_TICKETING
GAMBLING
GAMING
HOTEL
ONLINE_FINANCIAL
RETAIL
SERVICES
TRAVEL
UTILITIES
Alphanumeric
OPTIONAL
Provider key (Key) required to access the processing system.
The merchant receives this information when they set up an account with CIC.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
OPTIONAL
Provider password (Passphrase) required to access the processing system.
The merchant receives this information when they set up an account with CIC
Data may consist of the characters 0-9, a-z, A-Z
OPTIONAL
Details regarding a Cielo acquirer link configuration.
Alphanumeric
OPTIONAL
Provider key (chave) required to access the processing system.
The merchant receives this information when they set up an account with Cielo.
Data may consist of the characters 0-9, a-z, A-Z
OPTIONAL
Details regarding Citibank Private Label Card acquirer link configuration.
String
REQUIRED
The Partner ID issued to the merchant by Citibank.
The Partner ID identifies a group of merchant profiles within the Citibank system that belongs to the same merchant. This means that the same Partner ID can be assigned to more than one Citibank Merchant ID, i.e. to more than one merchant profile in the gateway (field merchant.acquirerLink.bankMerchantId).
Data can consist of any characters
OPTIONAL
Details regarding an DBS_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding an DINERS_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding an E-Global acquirer link configuration.
Digits
OPTIONAL
The acquirer is responsible for registering the merchant with Mastercard to allow the merchant to act as an aggregator.
Mastercard will issue the merchant with a Payment Facilitator ID. This ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9.
String
REQUIRED
When submitting a transaction on behalf of a sub-merchants, this name may be displayed on the payer's cardholder statement (together with the sub-merchant name).
It may be up to 7 characters long, and combined with the sub-merchant name must not exceed 21 characters. Use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Digits
OPTIONAL
The acquirer is responsible for registering the merchant with Visa to allow the merchant to act as an aggregator.
Visa will issue the merchant with a Payment Facilitator ID. This ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9.
OPTIONAL
Details regarding a Giropay acquirer link configuration.
Digits
OPTIONAL
The merchant is issued an Acquirer Merchant ID when they sign up with a giropay acquirer.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The merchant is issued an External Merchant ID when they sign up with a giropay acquirer.
Data can consist of any characters
String
OPTIONAL
The merchant is issued an External Merchant Tag when they sign up with a giropay acquirer.
Data can consist of any characters
Digits
OPTIONAL
Bank account number of the merchant's bank account.
The customer will transfer the money into this bank account.
Data is a string that consists of the characters 0-9.
Digits
OPTIONAL
Bank identifier of the merchant's bank account.
Must be 8 digits. Add leading zeros if required. The customer will transfer the money into this bank account.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
Bank account holder name of the merchant's bank account.
The customer will transfer the money into this bank account.
Data can consist of any characters
OPTIONAL
Details regarding a Global Payments East acquirer link configuration.
Digits
OPTIONAL
The merchant's Bank Identification Number (BIN).
Will be submitted to the acquirer with each transactions sent for processing.
Data is a string that consists of the characters 0-9.
OPTIONAL
Details regarding a GWS acquirer link configuration.
String
OPTIONAL
When submitting a transaction on behalf of a sub-merchants, this name may be displayed on the payer's cardholder statement (together with the sub-merchant name).
It may be up to 12 characters long and combined with the sub-merchant name must not exceed 37 characters. Use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The country location of the merchant.
The value must be a three-letter country code according to ISO 3166-1 alpha-3.
Data must consist of the characters A-Z
OPTIONAL
Details regarding an HSBC_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding an HSBCMYH_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Mashreq Bank via MAA
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding an NAB_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding a Paymenttech Tampa acquirer link configuration.
Digits
OPTIONAL
Sent to the acquirer in authorization, authorization reversals, sysreversals and batch settlement requests.
Data is a string that consists of the characters 0-9.
OPTIONAL
Details regarding a PayPal acquirer link configuration.
Email
OPTIONAL
The email address of the merchant's PayPal business account.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Email
OPTIONAL
The email address of the merchant's PayPal Sandbox account.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
OPTIONAL
Details regarding a PPro acquirer link configuration.
String
OPTIONAL
The merchant's contract identifier.
The merchant is issued with this contract ID when they sign up with PPRO.
Data can consist of any characters
OPTIONAL
Details regarding a Redecard acquirer link configuration.
Alphanumeric
OPTIONAL
Provider password (Pwd) required to access the processing system.
The merchant receives this information when they set up an account with Redecard.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
OPTIONAL
Provider user name (Usr) required to access the processing system.
The merchant receives this information when they set up an account with Redecard.
Data may consist of the characters 0-9, a-z, A-Z
OPTIONAL
Details regarding an S2I acquirer link configuration.
Decimal
OPTIONAL
Provide the Independent Sales Organization (ISO) ID of the ISO that the merchant is associated with.The ISO ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The acquirer is responsible for registering a Marketplace merchant with Visa.
Visa will issue the merchant with a Marketplace ID.This ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The acquirer is responsible for registering a merchant that wants to act as a Payment Facilitator with Mastercard.
Mastercard will issue the merchant with a Payment Facilitator ID.This ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
When submitting a transaction on behalf of a sub-merchants, this name may be displayed on the payer's cardholder statement (together with the sub-merchant name).
It may be 3, 7 or 12 characters long and combined with the sub-merchant name (as provided on the transaction request) must not exceed 21 characters. Use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Decimal
OPTIONAL
The acquirer is responsible for registering a merchant that wants to act as a Payment Facilitator with Visa.
Visa will issue the merchant with a Payment Facilitator ID.This ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
OPTIONAL
Information about the merchant held with the Service Provider.
String
OPTIONAL
The unique identifier for the merchant with the Service Provider.
Data can consist of any characters
OPTIONAL
Details regarding a Sofortbanking acquirer link configuration.
String
OPTIONAL
The merchant must activate input verification in their Sofortbanking account.
The notification password must be the same as the one in the merchants Sofortbanking account and is used by to generate a hash value that is used to securely identify the messages received from Sofortbanking.
Data can consist of any characters
Digits
OPTIONAL
The merchant is issued a Project ID (Projektnummer) when they sign up with Sofortbanking.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The merchant must activate input verification in their Sofortbanking account.
The project password must be the same as the one in the merchants Sofortbanking account and is used to generate a hash value that is used to securely identify the messages sent to Sofortbanking.
Data can consist of any characters
Digits
OPTIONAL
The merchant is issued a user ID (Kundennummer) when they sign up with Sofortbanking.
Data is a string that consists of the characters 0-9.
OPTIONAL
Details regarding an SUNCORP_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding a TSYS acquirer link configuration.
String
OPTIONAL
Identifies the institution that signs the merchant.
Data can consist of any characters
String
OPTIONAL
The merchant chain identification number.
Data can consist of any characters
Digits
OPTIONAL
The merchant's Bank Identification Number (BIN).
Will be submitted to the acquirer with each transactions sent for processing.
Data is a string that consists of the characters 0-9.
Digits
OPTIONAL
Identifies a specific merchant store within the TSYS Acquiring Solutions' system.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
Processor specific time zone differential.
Data can consist of any characters
String
OPTIONAL
The merchant assigned Terminal ID Number.
Data can consist of any characters
OPTIONAL
Details regarding a Vantiv acquirer link configuration.
Digits
OPTIONAL
The merchant's Bank Identification Number (BIN).
Will be submitted to the acquirer with each transactions sent for processing.
Data is a string that consists of the characters 0-9.
OPTIONAL
Details regarding an VCB_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding an WBC_NZ_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
OPTIONAL
Details regarding an WBCS2I_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
REQUIRED
The unique identifier for the acquirer issued by the gateway.
Please contact ANZ Worldline Payment Solutions for a list of supported acquirers and their ID.
Data can consist of any characters
OPTIONAL
Configuration required for the merchant to perform payer authentication, including 3DS authentication and ITMX LSS.
OPTIONAL
Configuration required to perform 3-D Secure payer authentication, including 3-D Secure version 1 and 3-D Secure version 2.
OPTIONAL
Configuration required for the merchant to perform 3-D Secure payer authentication using American Express SafeKey, including 3-D Secure version 1 and 3-D Secure version 2.
Digits
OPTIONAL
Configuration required for the merchant to perform 3-D Secure payer authentication using American Express SafeKey, including 3-D Secure version 1 and 3-D Secure version 2.
Data is a string that consists of the characters 0-9.
OPTIONAL
Configuration required for the merchant to perform 3-D Secure payer authentication using Diners ProtectBuy, including 3-D Secure version 1 and 3-D Secure version 2.
Digits
OPTIONAL
Configuration required for the merchant to perform 3-D Secure payer authentication using Diners ProtectBuy, including 3-D Secure version 1 and 3-D Secure version 2.
Data is a string that consists of the characters 0-9.
OPTIONAL
Configuration required for the merchant to perform 3-D Secure payer authentication using JCB J/Secure, including 3-D Secure version 1 and 3-D Secure version 2.
Digits
OPTIONAL
Configuration required for the merchant to perform 3-D Secure payer authentication using JCB J/Secure, including 3-D Secure version 1 and 3-D Secure version 2.
Data is a string that consists of the characters 0-9.
OPTIONAL
Configuration required for the merchant to perform 3-D Secure payer authentication using Mastercard SecureCode, including 3-D Secure version 1 and 3-D Secure version 2.
Digits
OPTIONAL
Acquirer BIN to be used to identify the acquirer when performing 3-D Secure payer authentication using Mastercard SecureCode for this merchant acquirer link.
Data is a string that consists of the characters 0-9.
OPTIONAL
Configuration required for the merchant to perform 3-D Secure payer authentication using Verified by Visa, including 3-D Secure version 1 and 3-D Secure version 2.
Digits
OPTIONAL
Configuration required for the merchant to perform 3-D Secure payer authentication using Verified by Visa, including 3-D Secure version 1 and 3-D Secure version 2.
Data is a string that consists of the characters 0-9.
OPTIONAL
Configuration specific for payer authentication using 3-D Secure version 1.
OPTIONAL
Configuration specific for payer authentication using 3-D Secure version 1 using American Express SafeKey.
String
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use American Express SafeKey.
Data can consist of any characters
OPTIONAL
Configuration specific for payer authentication using 3-D Secure version 1 using Diners Protect Buy.
String
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use Diners ProtectBuy.
Data can consist of any characters
OPTIONAL
Configuration required to perform payer authentication using JSecure Authentication.
String
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use J/Secure.
Data can consist of any characters
String
OPTIONAL
Merchant Password provided to the merchant by their acquirer when they registered to use J/Secure.
If a password is set, the field does not return the actual password, but the value 'xxxxxx'.
Data can consist of any characters
OPTIONAL
Configuration required to perform payer authentication using Mastercard Authentication.
String
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use MasterCard SecureCode.
Data can consist of any characters
String
OPTIONAL
Merchant Password provided to the merchant by their acquirer when they registered to use MasterCard SecureCode.
If a password is set, the field does not return the actual password, but the value 'xxxxxx'.
Data can consist of any characters
OPTIONAL
Configuration required to perform payer authentication using Visa Authentication.
String
OPTIONAL
Card Acceptor ID provided to the merchant by their acquirer when they registered to use Verified by Visa (3-D Secure).
Data can consist of any characters
String
OPTIONAL
Card Acceptor Terminal ID provided to the merchant by their acquirer when they registered to use Verified by Visa (3-D Secure).
Data can consist of any characters
String
OPTIONAL
Merchant Password provided to the merchant by their acquirer when they registered to use Verified by Visa (3-D Secure).
If a password is set, the field does not return the actual password, but the value 'xxxxxx'.
Data can consist of any characters
OPTIONAL
Configuration required to perform payer authentication using ITMX LSS Authentication.
String
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use ITMX LSS Authentication.
Data can consist of any characters
JSON Text
OPTIONAL
This field triggers custom processing.
MasterCard will inform you if this is applicable to your merchants.
Data is valid Json Format
OPTIONAL
Details regarding payment plans supported for this merchant acquirer link.
Note that not all fields in this parameter group will be applicable to the configuration of all payment plans. Please refer to the Online Integration Guide for details about supported payment plans.
Integer
OPTIONAL
A limitation on the number of periods for which the first payment can be deferred.
The payer will be offered either no deferrals, or this number of deferrals.
Operations attempting to set a value that is not supported by the plan will be rejected. Please refer to the Online Integration Guide for the supported values for each payment plan.
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Integer
OPTIONAL
The maximum number of installments that will be offered to payers using this payment plan.
The payer will be offered all values that are supported by the plan, up to and including this value.
Operations attempting to set a value that is not supported by the plan will be rejected. Please refer to the Online Integration Guide for the supported values for each payment plan.
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
OPTIONAL
A minimum order value for which the payment plan will be offered.
A payer is offered this plan if their order is:
- • in a supported currency, and
- • has an amount equal or greater than the minimum amount for that currency.
The default value is an empty list.
Decimal
OPTIONAL
A minimum order amount for which the payment plan will be offered.
Data is a decimal number.
Upper case alphabetic text
OPTIONAL
The currency of the minimum order amount expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
String
OPTIONAL
The ID of the payment plan you want to enable for the merchant acquirer link (e.g. PlanN).
Please refer to the Online Integration Guide for the payment plans supported and their IDs.
Data can consist of any characters
Response
Fields
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
Enumeration
ALWAYS PROVIDED
A system-generated high level overall result of the 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
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.