Verify
Request to verify the cardholder's account before processing the financial transaction. The card is verified using the verification method supported by the acquirer and the data provided in the request.
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: 40String
REQUIRED
A unique identifier for this order to distinguish it from any other order you create.
Use this identifier when referring to this order in subsequent transactions and in retrieval operations. This value must be unique for every order you create using your merchant profile.
Data can consist of any characters
Min length: 1 Max length: 40String
REQUIRED
Unique identifier for this transaction to distinguish it from any other transaction on the order.
An order can have transactions representing:
- Movement of money. For example, payments and refunds.
- Validations. For example, account verification or 3-D Secure authentication of the payer.
- Undoing other transactions. For example, voiding a payment transaction.
- Chargebacks.
- Fees from your payment service provider.
If you attempt an operation and it fails (eg you try to PAY on a card with no funds), then you need a new id for each retry.
Data can consist of any characters
Min length: 1 Max length: 40Fields Copied to clipboard
OPTIONAL
Additional details for account funding transactions (order.purchaseType=ACCOUNT_FUNDING).
Account funding transactions are transactions that pull money from the sender's card account for the purpose of funding another account, the recipient's account. Depending on the type of account funding transaction you may be required to provide some or all the details in this parameter group.
Enumeration
OPTIONAL
Defines the purpose of the account funding payment.If not provided the value is defaulted to OTHER.
Value must be a member of the following list. The values are case sensitive.
CRYPTOCURRENCY_PURCHASE
The funds from this account funding transaction will exclusively be used to purchase cryptocurrency.
MERCHANT_SETTLEMENT
The funds from this account funding transaction will be used to settle the proceeds of processing card transactions.
OTHER
The funds from this account funding transaction will be used for any other purpose, e.g. transferring funds from a person to a person or transferring funds into a staged wallet. This is the default value.
PAYROLL
The funds from this account funding transaction will be used to pay salaries.
OPTIONAL
Details about the recipient who will subsequently receive the funds that you are debiting from the sender in this transaction.
OPTIONAL
Details about the account of recipient who will subsequently receive the funds that you are debiting from the sender in this transaction.
Enumeration
OPTIONAL
If the recipient account type is an account with an associated card (accountFunding.recipient.account.identifierType=CARD_NUMBER) you must specify the funding method of the card.
If not provided the value is defaulted to UNKNOWN.
Value must be a member of the following list. The values are case sensitive.
CHARGE
The payer has a line of credit with the issuer which must be paid off monthly.
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.
UNKNOWN
The account funding method is not known. This is the default value.
String
OPTIONAL
The account identifier for the payment recipient's account.
For example, this may be a card number or bank account number. You must specify the type of identifier in field accountFunding.recipient.account.identifierType. In the response, the value will be masked. The masking format depends on the type of account identifier.
Data can consist of any characters
Enumeration
OPTIONAL
Defines the type of the recipient's account identifier that you have provided in field accountFunding.recipient.account.identifier.
If not provided the value is defaulted to OTHER.
Value must be a member of the following list. The values are case sensitive.
BANK_ACCOUNT_BIC
The recipient's account identifier is a bank account number and Business Identifier Code (BIC).
BANK_ACCOUNT_IBAN
The recipient's account identifier is an International Bank Account Number (IBAN).
BANK_ACCOUNT_NATIONAL
The recipient's account identifier is a bank account number and a national bank identifier, for example, a routing number (RTN).
CARD_NUMBER
The recipient's account identifier is a card number.
EMAIL_ADDRESS
The recipient's account identifier is an email address.
OTHER
The recipient's account identifier type can not be classified using any of the other categories. This is the default value
PHONE_NUMBER
The recipient's account identifier is a phone number.
SOCIAL_NETWORK_PROFILE_ID
The recipient's account identifier is a social network profile ID.
STAGED_WALLET_USER_ID
The recipient's account identifier is a user ID for a staged digital wallet. For a staged wallet, when the payer makes a payment using the wallet, the funds are pulled from an account associated with the wallet (first stage) before they are credited to the recipient of the wallet payment (second stage).
Upper case alphabetic text
OPTIONAL
The 3 letter ISO standard alpha country code of the recipient.
Data must consist of the characters A-Z
Date
OPTIONAL
The date of birth of the recipient in yyyy-mm-dd format.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
String
OPTIONAL
First name of the recipient.
Data can consist of any characters
String
OPTIONAL
Last name of the recipient.
Data can consist of any characters
String
OPTIONAL
Middle name of the recipient.
Data can consist of any characters
String
OPTIONAL
The post code or zip code of the recipient.
Data can consist of any characters
String
OPTIONAL
The state or province code of the recipient.
The value must match the second part of the ISO 3166-2 code. For an address in the United States provide the 2-letter ISO 3166-2 state code. For US military bases provide one of AE, AA, AP. For an address in Canada provide the 2-letter ISO 3166-2 province code.
Data can consist of any characters
Boolean
OPTIONAL
Defines if the sender and recipient of the account funding payment are the same or not.
If not provided the value is defaulted to FALSE.
JSON boolean values 'true' or 'false'.
Enumeration
OPTIONAL
Defines if the sender is a person, a commercial organization, a non-profit organization or a government
Value must be a member of the following list. The values are case sensitive.
COMMERCIAL_ORGANIZATION
The sender is a commercial organization. Examples include account to account transfers initiated by a commercial organization for the purpose of transferring funds to one of their accounts, business to business payments, and disbursements for insurance claims, payroll, investment dividends, merchant rebates.
GOVERNMENT
The sender is a government or government agency. Examples include government agencies paying salaries, pensions, social benefits or tax credits.
NON_PROFIT_ORGANIZATION
The sender is a non-profit organization. Examples include non-profit organizations delivering emergency aid payments.
PERSON
The sender is a person. Examples include account to account transfers initiated by a person to their own account or a different person's account and adding funds to a staged wallet.
OPTIONAL
A series of related orders that execute one commercial agreement.
For example, linking the orders for a series of recurring payments (a mobile phone subscription), split tenders (one payment using two cards), or when the merchant offers to take payments by a series of installments (hire purchase).
You must provide this data for some types of payments (such as recurring), but you can provide it for any cases where you want to link orders together.
Enumeration
OPTIONAL
Indicates if all the payments within the agreement use the same amount or if the amount differs between the payments.
The field must be provided for recurring payment agreements.
Value must be a member of the following list. The values are case sensitive.
FIXED
All payments in the recurring payment agreement have the same amount. Examples include magazine subscriptions or gym memberships.
VARIABLE
The amount for the payments within the recurring payment agreement differs between payments. Examples include usage-based charges like utility or phone bills.
String
OPTIONAL
Additional information requested for the agreement which cannot be passed using other available data fields.
This field must not contain sensitive data.
Data can consist of any characters, but sensitive data will be rejected
Date
OPTIONAL
Date at which your agreement with the payer to process payments expires.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
String
OPTIONAL
Your identifier for the agreement you have with the payer to process payments.
When you collect cards from your payers and store them for later use, you must provide an agreement ID when you use the stored values for:
- Recurring payments: you have an agreement with the payer that authorizes you to automatically debit their account at agreed intervals for fixed or variable amounts. For example, gym membership, phone bills, or magazine subscriptions.
- Installment payments: you have an agreement with the payer that authorizes you to process multiple payments over an agreed period of time for a single purchase. For example, the payer purchases an item for $1000 and pays for it in four monthly installments.
- Unscheduled: you have an agreement with the payer that authorizes you to process future payments when required. For example, the payer authorizes you to process an account top-up transaction for a transit card when the account balance drops below a certain threshold.
- Industry Practice: you have an agreement with the payer that authorizes you to initiate additional transactions to fulfil a standard business practice related to an original payment initiated by the payer. For example, a delayed charge for use of the hotel mini bar after the payer has checked out or a no show penalty charge when the payer fails to show for a booking.
Data can consist of any characters
Decimal
OPTIONAL
The maximum amount for a single payment in the series as agreed with the payer under your agreement with them.
The amount must be provided in the currency of the order.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The minimum amount for a single payment in the series as agreed with the payer under your agreement with them.
The amount must be provided in the currency of the order.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Integer
OPTIONAL
The minimum number of days between payments agreed with the payer under your agreement with them.
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Integer
OPTIONAL
The number of merchant-initiated payments within the recurring payment agreement.
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Enumeration
OPTIONAL
The frequency of the payments within the series as agreed with the payer under your agreement with them.
Value must be a member of the following list. The values are case sensitive.
AD_HOC
The agreement if for payments on an ah-hoc basis.
DAILY
The agreement if for a daily payment.
FORTNIGHTLY
The agreement if for a fortnightly payment.
MONTHLY
The agreement if for a monthly payment.
OTHER
The agreement is for payments according to a schedule other than the ones listed in the other enumeration values for this field.
QUARTERLY
The agreement if for a quarterly payment.
TWICE_YEARLY
The agreement if for a payment twice a year.
WEEKLY
The agreement if for a weekly payment.
YEARLY
The agreement if for a yearly payment.
OPTIONAL
For an installment agreement where the payer purchased goods and/or services from a retailer but entered an installment agreement to pay for this purchase with you, you must provide details about the retailer.
String
OPTIONAL
Provide an abbreviation of the retailer's trading name that can be used by the issuer to indicate the retailer on the payer's statement.
Data can consist of any characters
String
OPTIONAL
A 4-digit code used to classify the retailer's business by the type of goods or services it offers.
Data can consist of any characters
String
OPTIONAL
The retailer's trading name.
Data can consist of any characters
Date
OPTIONAL
This is the effective start date for the payment agreement.
Cannot be in the past.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Enumeration
OPTIONAL
The type of commercial agreement that the payer has with you.
Specify the agreement type when you have provided a value for agreement.id and this payment is the first in a series of payments. The default value is OTHER.
The gateway will use the value you specify for subsequent payments in the series.
Value must be a member of the following list. The values are case sensitive.
INSTALLMENT
An agreement where the payer authorizes the payment for a single purchase to be split into a number of payments processed at agreed intervals. For example, pay for a purchase in six monthly installments.
OTHER
An agreement where you want to link related payments for any purpose other than processing recurring, installment, or unscheduled payments. For example, split tender payments.
RECURRING
An agreement where the payer authorizes you to process repeat payments for bills or invoices at agreed intervals (for example, weekly, monthly). The amount might be fixed or variable.
UNSCHEDULED
An agreement where the payer authorizes you to automatically deduct funds for a payment for an agreed purchase when required (unscheduled). For example, auto top-ups when the account value falls below a threshold.
String
= VERIFY
FIXED
Any sequence of zero or more unicode characters.
OPTIONAL
Information about how the payer's identity is verified.
For example, using 3-D Secure authentication.
This parameter group include payer authentication options available to you, parameters you need to perform payer authentication for an available method, and the results of payer authentication.
OPTIONAL
Information about payer authentication using 3-D Secure authentication.
Only provide these fields if you authenticated the payer using a different 3-D Secure service provider. If you authenticated the payer using the gateway, then provide authentication.transactionId instead.
Parameters in this group apply to both 3-D Secure authentication version 1 and 3-D Secure Authentication version 2.
Depending on the 3-D Secure authentication version applicable you will also need additional parameters:
- 3-D Secure authentication version 1: see the authentication.3ds1 parameter group.
- 3-D Secure authentication version 2: see the authentication.3ds2 parameter group.
Alphanumeric
OPTIONAL
Indicates the security level of the transaction.
This is the Electronic Commerce Indicator (ECI) value provided by the issuer's Access Control Server (ACS) to indicate the results of the attempt to authenticate the payer.
Data may consist of the characters 0-9, a-z, A-Z
Base64
OPTIONAL
The base64 encoded value generated by the issuer.
The authentication token Included in subsequent transaction request messages and used by the card scheme to verify that the authentication occurred and the values provided are valid. The token should be used unaltered.
For 3DS version 1, this field corresponds to the Cardholder Authentication Verification Value (CAVV) for Visa, the Accountholder Authentication Value (AAV) for MasterCard and JCB, or the American Express Verification Value (AEVV) for American Express.
For 3DS version 2, this field corresponds to the Authentication Value.
Data is Base64 encoded
String
OPTIONAL
A unique identifier for the 3-D Secure authentication transaction.
For 3DS version 1, this field corresponds to the XID. The XID is an identifier generated by the gateway on behalf of the merchant.
For 3DS version 2, this field corresponds to the identifier assigned by the scheme directory server.
This identifier should be used in subsequent operation requests unaltered.
An XID submitted in this field must be in base64 format.
Data can consist of any characters
OPTIONAL
Information about payer authentication using 3-D Secure authentication version 2.
Only provide these fields if you authenticated the payer using a different 3-D Secure service provider. If you authenticated the payer using the gateway, then provide authentication.transactionId instead.
String
OPTIONAL
Reference number assigned to the issuer's Access Control Server (ACS) by EMV Co upon approval of the ACS.
This field corresponds to EMVCo field acsReferenceNumber.
Data can consist of any characters
String
OPTIONAL
A unique transaction identifier assigned by the Access Control Server to identify the 3DS transaction.
Data can consist of any characters
Enumeration
OPTIONAL
The EMV 3DS authentication scheme that was used to process the authentication request.
You must provide this field for co-branded card transactions that were authenticated outside MPGS using an external 3DS provider.
For example, for externally authenticated Mada co-branded transactions, you must provide either MADA, MASTERCARD or VISA to specify the 3DS directory server.
Value must be a member of the following list. The values are case sensitive.
AMEX
for American Express SafeKey EMV 3DS authentications
CARTE_BANCAIRE
for FAST'R by CB EMV 3DS authentications
DISCOVER
for Diners Club/Discover ProtectBuy EMV 3DS authentications
ITMX
for ITMX LSS EMV 3DS authentications
JCB
for JCB J/Secure EMV 3DS authentications
MADA
for mada secure EMV 3DS authentications
MASTERCARD
for Mastercard Identity Check EMV 3DS authentications
UNIONPAY
for UnionPay EMV 3DS authentications
VISA
for Visa Secure EMV 3DS authentications
JSON Text
OPTIONAL
Additional information returned by the scheme or issuer in the authentication response that must be included (together with the standard authentication details) when submitting the transaction for processing by the acquirer.
Data is valid Json Format
String
OPTIONAL
Reference number assigned to the Directory Server (DS) by EMV Co upon approval of the DS.
This field corresponds to EMVCo field dsReferenceNumber.
Data can consist of any characters
Alphanumeric + additional characters
OPTIONAL
The version of the EMV 3-D Secure protocol used to perform 3-D Secure authentication, in the format specified by EMVCo.
For example, 2.1.0
Data may consist of the characters 0-9, a-z, A-Z, '.'
String
OPTIONAL
A code indicating the reason for the transaction status returned in authentication.3ds2.transactionStatus.
Refer to the EMVCo specification for 3-D Secure.
Data can consist of any characters
Alpha
OPTIONAL
Indicates the result of payer authentication with the issuer.
This is the value returned in the transaction status field from the issuer's Access Control Server (ACS). For example, Y, N, U, A, R
Refer to the EMVCo specification for 3-D Secure.
Data may consist of the characters a-z, A-Z
Decimal
OPTIONAL
The amount for which the payer authentication has been performed.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
DateTime
OPTIONAL
Date and time of the payer authentication being performed.
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
String
OPTIONAL
The transactionId you used for the Initiate Authentication operation.
Data can consist of any characters
OPTIONAL
Information on the billing address including the contact details of the payer.
OPTIONAL
The payer's billing address.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
String
OPTIONAL
The city portion of the address.
Data can consist of any characters
String
OPTIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
OPTIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
OPTIONAL
The state or province of the address.
Data can consist of any characters
String
OPTIONAL
The three character ISO 3166-2 country subdivision code for the state or province of the address.
Providing this field might improve your payer experience for 3-D Secure payer authentication.
Data can consist of any characters
String
OPTIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
OPTIONAL
The second line of the address (if provided).
Data can consist of any 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
OPTIONAL
Information about the customer, including their contact details.
Email
OPTIONAL
The email address of the customer.
The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
OPTIONAL
The payer's first name.
Data can consist of any characters
String
OPTIONAL
The payer's last or surname.
Data can consist of any characters
Telephone Number
OPTIONAL
The payer's mobile phone or cell phone number in ITU-T E123 format, for example +1 607 1234 5678
The number consists of:
- '+'
- country code (1, 2 or 3 digits)
- 'space'
- national number ( which may embed single spaces characters for readability).
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Telephone Number
OPTIONAL
The payer's phone number in ITU-T E123 format, for example +1 607 1234 456
The number consists of:
- '+'
- country code (1, 2 or 3 digits)
- 'space'
- national number ( which may embed single spaces characters for readability).
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
String
OPTIONAL
The tax registration identifier of the customer.
Data can consist of any characters
OPTIONAL
Additional details for debt repayment transactions (order.purchaseType=DEBT_REPAYMENT).
If your Merchant Category Code is 6012 (Merchandise and Services—Customer Financial Institutions) or 6051 ( (Non-Financial Institutions – Foreign Currency, Non-Fiat Currency)) you may be required to provide some or all the details in this parameter group.
OPTIONAL
Details about the recipient of the payment and the destination account for the payment.
String
REQUIRED
The account identifier for the payment recipient's account.
For payments into a card account provide the card number. For payments into other accounts (for example a bank account) provide the account number. The value provided will be returned masked in the response.
Data can consist of any characters
Date
REQUIRED
The date of birth of the primary payment recipient in yyyy-mm-dd format.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
String
REQUIRED
Last name of the primary payment recipient.
Data can consist of any characters
String
REQUIRED
Postcode of the primary payment recipient.
Data can consist of any characters
OPTIONAL
Information about the device used by the payer for this transaction.
String
OPTIONAL
The telephone number captured by ANI (Automatic Number Identification) when the customer calls to place the order.
Data can consist of any characters
String
OPTIONAL
The 2 digit ANI information identifier provided by the telephone company to indicate the call type, for example, cellular (61-63), toll free (24,25), etc.
Data can consist of any characters
String
OPTIONAL
The User-Agent header of the browser the customer used to place the order.
For example, MOZILLA/4.0 (COMPATIBLE; MSIE 5.0; WINDOWS 95)
Data can consist of any characters
String
OPTIONAL
Information collected about a remote computing device for the purpose of providing a unique identifier for the device.
For example, session ID, blackbox ID.
Data can consist of any characters
String
OPTIONAL
The name of the server to which the customer is connected.
Data can consist of any characters
String
OPTIONAL
The IP address of the device used by the payer, in nnn.nnn.nnn.nnn format.
Data can consist of any characters
String
OPTIONAL
The person who initiated this transaction.
This field is automatically populated by the gateway if the transaction was created via Merchant Administration (gatewayEntryPoint=MERCHANT_ADMINISTRATION) or Merchant Manager (MERCHANT_MANAGER). In this case this is the name that the person used to log in to Merchant Administration or Merchant Manager respectively.
Data can consist of any characters
REQUIRED
Information about the order associated with this transaction.
Decimal
OPTIONAL
The total amount for the order. This is the net amount plus any merchant charge amounts.If you provide any sub-total amounts, then the sum of these amounts (order.itemAmount, order.taxAmount, order.shippingAndHandlingAmount, order.cashbackAmount, order.gratuityAmount, order.merchantCharge.amount and order.dutyAmount), minus the order.discountAmount must equal the net amount.
The value of this field in the response is zero if payer funds are not transferred.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Upper case alphabetic text
REQUIRED
The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
String
OPTIONAL
Information about this order that is of interest to you.
For example order.custom.X, where 'X' is defined by you and must be less than 100 characters from the set A-Z, a-z, 0-9. For example, order.custom.salesRegion. You can specify up to 50 such fields. They are not sent to acquirers.
Data can consist of any characters
String
OPTIONAL
A note from the payer about this order.
Data can consist of any characters
Date
OPTIONAL
The date the payer placed the order.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd.
ASCII Text
OPTIONAL
The payer's own reference for the order.
This reference may assist the payer to identify the order in their system. For example, a purchase order number, project identifier, or cost center.
Data consists of ASCII characters
String
OPTIONAL
Short textual description of the contents of the order for display to the payer on the payment provider's website.
Data can consist of any characters
OPTIONAL
Information about a price reduction you have applied to the order.
For example, you may apply discounts for trade, employees, bulk purchase, or a sales promotion.
Decimal
OPTIONAL
The total amount of the discount you have applied to the order.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
The code you use to identify the reason for the discount.
Data can consist of any characters
String
OPTIONAL
A description of your reason for the discount.
Data can consist of any characters
Decimal
OPTIONAL
The duty amount (also known as customs tax, tariff or dues) for the order.
Data is a decimal number.
Decimal
OPTIONAL
The amount the payer has chosen to provide as a gratuity or tip in addition to the amount they are paying for the goods or services they are purchasing from you.
The gratuity amount is included in the total amount of the order you provide in order.amount.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
The invoice number you issued for this order.
Data can consist of any characters
String
OPTIONAL
Your tax registration identifier provided by the Local/State/Province tax authority.
If you are a Canadian merchant, use this field to provide your Tax Registration ID for paying Provincial Sales Tax (PST).
Data can consist of any characters
OPTIONAL
Use this parameter group to provide additional information if you are a marketplace.You are considered a marketplace if you operate an electronic commerce website or mobile application that brings together payers and retailers and you are selling the goods or services on behalf of the retailer.In this case, the card schemes may require you to register with them as a marketplace and assign you a Marketplace ID.
You should provide this identifier to your payment service provider so that the gateway can automatically include it in all transaction messages to your acquirer.
Enumeration
OPTIONAL
Provide information about the location of the retailers for goods or services included in this order.Where a retailer is located in a country different from your country, they are considered a foreign retailer, otherwise they are considered a domestic retailer.
Value must be a member of the following list. The values are case sensitive.
DOMESTIC_ONLY
The order only contains items from domestic retailers.
FOREIGN_AND_DOMESTIC
The order contains items from both foreign and domestic retailers.
FOREIGN_ONLY
The order only contains items from foreign retailers.
Digits
OPTIONAL
A 4-digit code used to classify your business by the type of goods or services it offers.This is also known as the Merchant Category Code (MCC).
You only need to provide the MCC if you want to override the default value configured for your acquirer link.The value you provide must match one of those configured by your payment service provider.
Data is a string that consists of the characters 0-9.
Url
OPTIONAL
The URL to which the gateway will send Webhook notifications when an order is created or updated.
To receive notifications at this URL, you must enable Webhook notifications in Merchant Administration. Ensure the URL is HTTPS
Ensure that this is a valid URL according to RFC 1738.
String
OPTIONAL
Your identifier for the part of your organization that is responsible for the order.
You might provide this data when you want to track the accountability for the order. For example, store number, sales region, branch, or profit center
Data can consist of any characters
String
OPTIONAL
Your identifier for the part of your organization that is responsible for the order.
You might provide this data when you want to track the accountability for the order. For example, store number, sales region, branch, or profit center
Data can consist of any characters
Enumeration
OPTIONAL
Indicates the purchase of specific types of goods or services.
You must provide a value if your Merchant Category Code (MCC) is one of the following:
6051 (Quasi Cash – Merchant or Non-Financial Institutions – Foreign Currency, Non-Fiat Currency) and this transaction is for the purchase of cryptocurrency. Set the value to CRYPTOCURRENCY.
6211 (Securities – Brokers/Dealers) and this transaction is for the purchase of high-risk securities. Set the value to HIGH_RISK_SECURITIES.
6012 (Merchandise and Services—Customer Financial Institutions) or 6051 (Non-Financial Institutions – Foreign Currency, Non-Fiat Currency) and this transaction is for debt repayment. Set the value to DEBT_REPAYMENT.
If the transaction pulls money from an account for the purpose of crediting another account you must set purchase type to ACCOUNT_FUNDING.
You may set purchase type to OTHER for any other type of payment.
Value must be a member of the following list. The values are case sensitive.
ACCOUNT_FUNDING
The transaction pulls money from an account for the purpose of crediting another account. You may be required to provide additional details about the account funding transaction in the accountFunding parameter group.
CRYPTOCURRENCY
The transaction is for the purchase of a cryptocurrency.
DEBT_REPAYMENT
You may be required to provide additional details about the debt repayment in the debtRepayment parameter group.
HIGH_RISK_SECURITIES
The transaction is for the purchase of high-risk securities.
OTHER
Use this value if the purchase type for the transaction does not fit in any of the other categories.
String
OPTIONAL
The identifier of the order.
For example, a shopping cart number, an order number, or an invoice number.
Data can consist of any characters
String
OPTIONAL
The name of the person who requested the goods or services.
Data can consist of any characters
Decimal
OPTIONAL
The total shipping and handling amount for the order, including taxes on the shipping and/or handling.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The tax amount levied on the shipping and handling amount for the order.
This amount is included in the shipping and handling amount provided in field order.shippingAndHandlingAmount.
Data is a decimal number.
Decimal
OPTIONAL
The tax rate applied to the shipping and handling amount for the order to determine the shipping and handling tax amount.
For a tax rate of 2.5% provide 0.025.
Data is a decimal number.
OPTIONAL
Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.
These merchants are referred to as your sub-merchants. The sub-merchant's details you provide may be displayed on the payer's cardholder statement. Note that your acquirer may require you to register with the card scheme(s) before allowing you to submit sub-merchant details with a transaction. This data must be on the initial transaction of an order, subsequent transactions with sub-merchant will be rejected.
OPTIONAL
The sub-merchant's address.
String
OPTIONAL
The city portion of the address.
Data can consist of any characters
String
OPTIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
OPTIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
OPTIONAL
The state or province code of the address.
For an address in the United States provide the 2-letter ISO 3166-2 state code. For US military bases provide one of AE, AA, AP.
For an address in Canada provide the 2-letter ISO 3166-2 province code.
Data can consist of any characters
String
OPTIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
OPTIONAL
The second line of the address (if provided).
Data can consist of any characters
Digits
OPTIONAL
Code used by acquirer to describe the business or industry the sub-merchant operates in.
Data is a string that consists of the characters 0-9.
Telephone Number
OPTIONAL
Only provide this field if you have received a notification from the scheme that either you or the sub-merchant has a high number of disputes.
In this case, provide a phone number that payers can use to contact the sub-merchant in case of a dispute. Where applicable, the issuer may display this phone number on the cardholder statement. The phone number must be provided in ITU-T E123 format.
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Email
OPTIONAL
The sub-merchant's email address.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Upper case alphabetic text
OPTIONAL
Only provide this field if the sub merchant is a government owned or controlled merchant.
A sub merchant is considered a government owned or controlled entity (government controlled merchant) if 50% or more of the sub merchant is owned by the government. Provide the ISO 3166 three-letter country code of the government country where this differs from the sub merchant's physical location country.
Data must consist of the characters A-Z
Alphanumeric + additional characters
REQUIRED
Your identifier for the sub-merchant.
You can use this identifier in searches and reports in the gateway.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '.'
String
OPTIONAL
If the sub merchant is a marketplace, provide the marketplace ID assigned to them by Visa.
A sub merchant is considered a marketplace if they operate a platform (online commerce website or mobile application) where retailers can sell goods and services.
Data can consist of any characters
String
OPTIONAL
The sub-merchant's phone number
Data can consist of any characters
String
OPTIONAL
The legal name of the sub-merchant.
Data can consist of any characters
String
REQUIRED
The trading name of the sub merchant, also known as doing business as (DBA), operating as or trading as.
For MasterCard transactions the name must not exceed 21 characters. For American Express transactions the name must not exceed 27 characters (or 36 characters including the aggregator name). The trading name may be displayed on the payer's cardholder statement. Therefore if you need to shorten it, use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
OPTIONAL
Use this parameter group to provide a breakdown of tax types, amount per tax type, and rate per tax type included in order.taxAmount.
Decimal
OPTIONAL
The tax amount included in this order for the tax type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The tax rate (percentage) used to determine the tax amount included in this order for the tax type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
The type of tax included in the order amount.
The correct value as used by your acquirer may have to be provided. Contact your payment service provider for details.
Data can consist of any characters
Decimal
OPTIONAL
The total amount of tax included in this order.
This value will be used for all pay orders and full capture transactions unless you provide us with a different amount in the transaction.taxAmount.
This amount is the sum of the tax amount for all the items contained in the order. If you supply both this value and any line item details, then this amount MUST equal the sum of the item.quantity times the item.unitTaxAmount for all the line items.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
Your tax registration identifier provided by the Federal/National tax authority (for example, federal tax identification number, ABN).
If you are a Canadian merchant, use this field to provide your Tax Registration ID for paying Harmonized Sales Tax (HST) or Goods and Services Tax (GST) collected by the Canada Revenue Agency.
Data can consist of any characters
Enumeration
OPTIONAL
Indicates your tax status for this order.
Value must be a member of the following list. The values are case sensitive.
EXEMPT
Indicates that you are exempt from tax.
NOT_EXEMPT
Indicates that you are not exempt from tax.
NOT_PROVIDED
Indicates that you are not providing information about being exempt from tax.
OPTIONAL
Information relevant for Transaction Filtering.
OPTIONAL
Allows you to provide the Address Verification Service (AVS) Response Code Transaction Filtering rules to be applied to the transactions for this order.
If provided, these rules override the AVS Response Code Transaction Filtering rules you have configured in Merchant Administration.
Enumeration
REQUIRED
The action to be performed for the Address Verification Service (AVS) Response Code.
Value must be a member of the following list. The values are case sensitive.
NO_ACTION
No action should be taken by the gateway.
REJECT
The gateway must reject the transaction.
REVIEW
The gateway must mark this transaction as requiring a review.
Enumeration
REQUIRED
The Address Verification Service (AVS) Response Code for which you are defining the rule.
Value must be a member of the following list. The values are case sensitive.
ADDRESS_MATCH
Street address matched
ADDRESS_ZIP_MATCH
Street address and zip/postcode were matched
NAME_ADDRESS_MATCH
Card holder name and street address matched
NAME_MATCH
Card holder name matched
NAME_ZIP_MATCH
Card holder name and zip/postcode matched
NOT_AVAILABLE
No data available from issuer or AVS data not supported for transaction
NOT_REQUESTED
AVS not requested
NOT_VERIFIED
AVS could not be verified for an international transaction
NO_MATCH
No match
SERVICE_NOT_AVAILABLE_RETRY
Issuer system is unavailable. Retry can be attempted
SERVICE_NOT_SUPPORTED
Service currently not supported by acquirer or merchant
ZIP_MATCH
Zip/postcode matched. Street address not matched
String
OPTIONAL
The wallet indicator as returned by the wallet provider.
Data can consist of any characters
Enumeration
OPTIONAL
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.
AMEX_EXPRESS_CHECKOUT
Amex Express Checkout wallet provider.
APPLE_PAY
Apple Pay mobile wallet provider.
CHASE_PAY
Chase Pay wallet provider.
GOOGLE_PAY
Google Pay mobile wallet provider.
MASTERPASS_ONLINE
MasterPass Online wallet provider.
SAMSUNG_PAY
Samsung Pay mobile wallet provider.
SECURE_REMOTE_COMMERCE
Secure Remote Commerce (SRC) wallet provider.
VISA_CHECKOUT
Visa Checkout wallet provider.
String
OPTIONAL
If, when integrating with the gateway, you are using a solution (e.g. a shopping cart or e-commerce solution) provided, supported or certified by your payment service provider, enter the solution ID issued by your payment service provider here.
If your payment service provider has not provided you with a solution ID, you should ignore this field.
Data can consist of any characters
OPTIONAL
Information about the device used to initiate the transaction at the Point-of-Sale (POS).
OPTIONAL
The address where the POS is located.
For the posTerminal.address.country field - EMV: 9F1A.
String
OPTIONAL
The city portion of the address.
Data can consist of any characters
String
OPTIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
OPTIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
OPTIONAL
The state or province of the address.
Data can consist of any characters
String
OPTIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
OPTIONAL
The second line of the address (if provided).
Data can consist of any characters
Enumeration
OPTIONAL
Specifies whether the terminal is attended by the merchant.
You only need to provide this field for card present transactions.
You must provide a value for this field for chip transactions with UK acquirers.
This field corresponds to EMV tag 9F35
Value must be a member of the following list. The values are case sensitive.
ATTENDED
Attended terminal.
SEMI_ATTENDED
Where a card or proximity payment device is present; and the cardholder is present; and the cardholder completes the transaction and, if required, an individual representing the merchant or acquirer assist the cardholder to complete the transaction.
UNATTENDED
Unattended terminal.
UNKNOWN_OR_UNSPECIFIED
Unknown or unspecified.
Enumeration
OPTIONAL
Indicates the capabilities of the terminal to support card present, card not present or both.
Value must be a member of the following list. The values are case sensitive.
CARD_NOT_PRESENT
Card not present.
CARD_PRESENT
Card present.
CARD_PRESENT_AND_CARD_NOT_PRESENT
Card present and card not present.
Enumeration
OPTIONAL
Indicates the type of cardholder-activated terminal (CAT) used by the payer for the transaction.
A CAT is typically an unattended terminal. For example a terminal used to purchase transit tickets, a terminal use to pay parking fees, toll fees, or automated dispensing machines.
There are seven types (levels) of CAT devices. Each level has specific card scheme requirements.
If you do not provide a value for this field for a Card Present payment the gateway defaults the value to NOT_CARDHOLDER_ACTIVATED.
This field corresponds to EMV tag 9F35
Value must be a member of the following list. The values are case sensitive.
AUTOMATED_DISPENSING_MACHINE_WITH_PIN
CAT level 1 terminal.
ELECTRONIC_COMMERCE
CAT level 6 terminal.
IN_FLIGHT_COMMERCE
CAT level 4 terminal.
LIMITED_AMOUNT_TERMINAL
CAT level 3 terminal.
MPOS_ACCEPTANCE_DEVICE
CAT level 9 terminal.
NOT_CARDHOLDER_ACTIVATED
Terminal is not activated by the cardholder.
SELF_SERVICE_TERMINAL
CAT level 2 terminal.
TRANSPONDER_TRANSACTION
CAT level 7 terminal.
Enumeration
OPTIONAL
Indicates the type of input the terminal is capable of receiving.
For example, chip, magnetic stripe read, key entry or contactless.
This field corresponds to EMV tag 9F33
Value must be a member of the following list. The values are case sensitive.
BARCODE
The terminal supports data input using a barcode reader.
CHIP
Chip read only.
CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE
MSR, chip and key entry.
CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID
The terminal supports chip read, key entry, magnetic stripe read, and RFID read.
CHIP_AND_MAGNETIC_STRIPE
MSR and chip.
CONTACTLESS_CHIP
Contactless chip.
CONTACTLESS_MAGNETIC_STRIPE
Contactless MSR.
CONTACTLESS_OR_MAGNETIC_STRIPE
The terminal supports both contactless interaction with a chip and magnetic stripe read.
KEY_ENTRY
Key entry only.
KEY_ENTRY_AND_MAGNETIC_STRIPE
MSR and key entry.
MAGNETIC_STRIPE
Magnetic strip read (MSR) only.
UNKNOWN
VOICE_AUDIO_RESPONSE
String
OPTIONAL
The name that you use to uniquely identify the location of the Point Of Sale instance used to initiate the transaction.
Examples could be S43_L12 (Lane 12 in Shop 43) or Kiosk_76. This field can be used for your search or reporting needs, and might be used by fraud management systems.
This field corresponds to EMV tag 9F1C
Data can consist of any characters
Enumeration
OPTIONAL
Indicates the physical location of the terminal in relation to your business premises.
If you do not provide a value for this field for a mobile wallet payment the gateway defaults the value to PAYER_TERMINAL_OFF_PREMISES.
Value must be a member of the following list. The values are case sensitive.
MERCHANT_TERMINAL_OFF_PREMISES
A terminal under the merchant's control but not on the merchant's premises was used.
MERCHANT_TERMINAL_ON_PREMISES
A terminal under the merchant's control on the merchant's premises was used.
NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE
A voice or an audio response system was used, not a physical terminal.
PAYER_TERMINAL_OFF_PREMISES
A terminal under the payer's control and off the merchant's premises was used. For example, a mobile device or personal computer.
PAYER_TERMINAL_ON_PREMISES
A terminal under the payer's control on the merchant's premises was used. For example, a mobile device or personal computer.
OPTIONAL
Information about mobile POS (mPOS) device.
Enumeration
OPTIONAL
The card reader used by an mPOS device.
Value must be a member of the following list. The values are case sensitive.
BUILT_IN
Off-the-shelf mobile phone or tablet with only a built-in contactless reader.
INTEGRATED_DONGLE
Dedicated mobile terminal with an integrated card reader.
SEPARATE_DONGLE
Off-the shelf device or dedicated mobile terminal, with a separate card reader.
Enumeration
OPTIONAL
Indicates the reason for sending a transaction online to the acquirer rather than completing it locally at the terminal.
The online reason code is mandatory for chip and chip fallback transactions (including reversals) for all online transactions.
Where more than one reason applies, then the order of priority used for the enumeration list applies.
Value must be a member of the following list. The values are case sensitive.
CHIP_APPLICATION_DATA_FILE_ERROR
The application data file on the chip was unable to process. The terminal has possession of the card. Only used by integrated ICC/MSR terminals (where the terminal has possession of the card and when this condition can be accurately identified).
CHIP_COMMON_DATA_FILE_ERROR
The application common data file on the chip was unable to process. Only used by integrated ICC/MSR terminals (where the terminal has possession of the card and when this condition can be accurately identified).
FORCED_BY_CHIP
The chip application forced the the transaction to go online.
FORCED_BY_ISSUER
Issuer rules forced the transaction to go online. For example, the card is expired.
FORCED_BY_MERCHANT
Rules in the merchant's POS application forced the transaction to go online. For example, the card was used twice or send one in a certain number of authorizations online.
FORCED_BY_TERMINAL
The terminal forced the transaction to go online. For example, the results of tests the terminal carried out during the EMV process indicated to send the transaction online.
MERCHANT_SUSPICIOUS
The merchant has indicated a suspicious transaction. For example, they indicated an unsuccessful signature check or the card returned an inappropriate cryptogram.
OVER_FLOOR_LIMIT
The transaction amount is above the limit set for local processing of the transaction at the terminal.
RANDOM_SELECTION_BY_TERMINAL
The terminal has randomly selected the transaction for online processing.
UNABLE_TO_PROCESS_CHIP
The terminal is not able to process a chip transaction. The transaction was sent online as a fallback.
Enumeration
OPTIONAL
Indicates how you or the Payer entered the Primary Account Number (PAN) of the card at the terminal.
Value must be a member of the following list. The values are case sensitive.
BARCODE_READER
The PAN was entered via a barcode reader.
CHIP
The PAN was entered by reading data from the chip on the card.
CHIP_FALLBACK
A chip-capable terminal failed to process the transaction using data on the card's chip. Therefore, the PAN was read using a fallback mode.
CONTACTLESS
The PAN was entered by a contactless interaction with a chip.
ECOMMERCE
The PAN was entered via an electronic commerce interaction, including chip.
KEYED
The PAN was manually entered.
MOBILE_COMMERCE
OPTICAL_CHARACTER_READER
The PAN was entered via an an optical character reader.
RFID_CHIP
An RFID device was used. Chip data is provided.
RFID_STRIPE
An RFID device was used. Stripe data is provided.
SWIPE
The PAN was read from the magnetic stripe, and the full, unaltered contents of the stripe are provided.
SWIPE_WITH_SIGNATURE
The PAN was read from the magnetic stripe and a signature was provided.
UNKNOWN
The mode of PAN entry is unknown.
VOICE_AUTHORIZATION
VOICE_RESPONSE
The PAN was collected using a Voice Response Unit.
Enumeration
OPTIONAL
Indicates the capability of the terminal to accept entry of the Payer's PIN.
This field corresponds to EMV tag 9F33
Value must be a member of the following list. The values are case sensitive.
OFFLINE_PIN_ONLY
Only offline PIN is supported.
PIN_NOT_SUPPORTED
Neither offline nor online PIN is supported.
PIN_PAD_INOPERATIVE
PIN is supported but the POS or Payment Client has determined that it is not operational.
PIN_SUPPORTED
Both offline & online PIN supported.
SOFTWARE_ONLINE_PIN_ONLY
mPOS Software-based PIN Entry Capability (online PIN supported).
UNKNOWN
The PIN entry capability is not known.
Integer
OPTIONAL
The maximum number of PIN characters that can be entered at the terminal
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
ASCII Text
OPTIONAL
PAN Entry Device Serial Number.
The unique serial number of the PED.
Data consists of ASCII characters
OPTIONAL
Information about the store or business location.
String
OPTIONAL
Your unique identifier for the specific store or business location where the transaction took place.
Data can consist of any characters
String
OPTIONAL
Your name for the specific store or business location where the transaction took place.
Data can consist of any characters
OPTIONAL
Container for fields that control the response returned for the request.
String
OPTIONAL
Indicates how sensitive data is returned in the response.
Data can consist of any characters
OPTIONAL
Information relevant to risk assessment.
Enumeration
OPTIONAL
The risk rules you wish to bypass when performing risk assessment for an order.
Value must be a member of the following list. The values are case sensitive.
ALL
String
OPTIONAL
Additional data passed to third-party risk assessment providers.
This field is only relevant if you use a third-party risk assessment provider, and you have agreed with them the values to provide (maximum 100 characters in a field name from the set A-Z, a-z, 0-9, maximum 4kB in length of values across all custom risk fields). An example might be:
Field: risk.custom.headOfficeLocation
Value: London UK
Data can consist of any characters
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
ASCII Text
OPTIONAL
Use this field to implement optimistic locking of the session content.
Do this if you make business decisions based on data from the session and wish to ensure that the same data is being used for the request operation.
To use optimistic locking, record session.version when you make your decisions, and then pass that value in session.version when you submit your request operation to the gateway.
If session.version provided by you does not match that stored against the session, the gateway will reject the operation with error.cause=INVALID_REQUEST.
See Making Business Decisions Based on Session Content.
Data consists of ASCII characters
OPTIONAL
Shipping information for this order.
OPTIONAL
The address to which this order will be shipped.
String
OPTIONAL
The city portion of the address.
Data can consist of any characters
String
OPTIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
OPTIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
Enumeration
OPTIONAL
How you obtained the shipping address.
Value must be a member of the following list. The values are case sensitive.
ADDRESS_ON_FILE
Order shipped to an address that you have on file.
NEW_ADDRESS
Order shipped to an address provided by the payer for this transaction.
String
OPTIONAL
The state or province of the address.
Data can consist of any characters
String
OPTIONAL
The three character ISO 3166-2 country subdivision code for the state or province of the address.
Providing this field might improve your payer experience for 3-D Secure payer authentication.
Data can consist of any characters
String
OPTIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
OPTIONAL
The second line of the address (if provided).
Data can consist of any characters
Enumeration
OPTIONAL
Indicates whether the shipping address provided is the same as the payer's billing address.
Provide this value if you are not providing the full shipping and billing addresses, but you can affirm that they are the same or different.
The default value for this field is:
SAME - if the shipping and billing address are supplied, and all fields are the same (ignoring non-alphanumerics).
DIFFERENT - if the shipping and billing address are supplied, and at least one field is different (ignoring non-alphanumerics).
UNKNOWN - either shipping address or billing address is absent.
Value must be a member of the following list. The values are case sensitive.
DIFFERENT
The shipping and billing addresses are different.
SAME
The shipping and billing addresses are the same.
UNKNOWN
It is not known if the shipping and billing addresses are the same.
OPTIONAL
Details of the contact person at the address the goods will be shipped to.
Email
OPTIONAL
The contact person's email address.
The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
OPTIONAL
The first name of the person to whom the order is being shipped.
Data can consist of any characters
String
OPTIONAL
The last name or surname of the person to whom the order is being shipped.
Data can consist of any characters
Telephone Number
OPTIONAL
The contact person's mobile phone or cell phone number in ITU-T E123 format, for example +1 607 1234 5678
The number consists of:
- '+'
- country code (1, 2 or 3 digits)
- 'space'
- national number ( which may embed single spaces characters for readability).
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Telephone Number
OPTIONAL
The contact person's phone number in ITU-T E123 format, for example +1 607 1234 456
The number consists of:
- '+'
- country code (1, 2 or 3 digits)
- 'space'
- national number ( which may embed single spaces characters for readability).
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Enumeration
OPTIONAL
The shipping method used for delivery of this order.
Value must be a member of the following list. The values are case sensitive.
ELECTRONIC
Electronic delivery.
GROUND
Ground (4 or more days).
NOT_SHIPPED
Order for goods that are not shipped (for example, travel and event tickets)
OVERNIGHT
Overnight (next day).
PICKUP
Shipped to a local store for pick up.
PRIORITY
Priority (2-3 days).
SAME_DAY
Same day.
Alphanumeric + additional characters
OPTIONAL
The post code or zip code of the address the order is shipped from.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
REQUIRED
The details describing the source of the funds to be used.
For card payments these 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.
OPTIONAL
Information about the source of funds when it is directly provided (as opposed to via a token or session).
For browser payments, the source of funds details are usually collected from the payer on the payment provider's website and provided to you when you retrieve the transaction details (for a successful transaction). However, for some payment types (such as giropay), you must collect the information from the payer and supply it here.
OPTIONAL
For ACH (sourceOfFunds.type=ACH) you must provide values for all fields within this parameter group, including details about the payers bank account as well as the type of ACH payment.
Enumeration
OPTIONAL
An indicator identifying the type of bank account.
- Consumer (checking or savings), or
- Business
For pre-arranged payments (sourceOfFunds.provided.ach.secCode=PPD) retrieve this information from the payer.
If payments were telephone-initiated (sourceOfFunds.provided.ach.secCode=TEL) or internet-initiated (sourceOfFunds.provided.ach.secCode=WEB) you may choose to limit the payer's options (e.g. only support consumer checking accounts), depending on your type of business (e.g. B2C online webshop).
Value must be a member of the following list. The values are case sensitive.
CONSUMER_CHECKING
Consumer Checking Account
CONSUMER_SAVINGS
Consumer Savings Account
CORPORATE_CHECKING
Business Checking Account
String
OPTIONAL
The name of the bank account holder, as it appears on the account at the receiving financial institution.
Retrieve this information from the payer.
Data can consist of any characters
Alphanumeric + additional characters
OPTIONAL
The identifier of the bank account at the receiving financial institution.
Retrieve this information from the payer.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-', '/'
Digits
OPTIONAL
The identifier of the receiving financial institution.
Also known as:
- Routing number,
- Transit number, or
- ABA number
Retrieve this information from the payer.
See also http://en.wikipedia.org/wiki/Routing_transit_number.
Data is a string that consists of the characters 0-9.
Enumeration
OPTIONAL
Identifies the Standard Entry Class (SEC) code to be sent to the issuer.
The SEC is defined by NACHA and describes the origin and intent of the payment. For details please refer to https://www.nacha.org/.
Value must be a member of the following list. The values are case sensitive.
PPD
An ACH debit or credit payment (B2C) that has been authorized by an authenticated customer in written form (signed or similarly authenticated). PPD is used for pre-arranged payments (e.g. employee payroll, mortgage payments, expense reimbursement).
TEL
An ACH debit payment (B2C) that has been authorized by an authenticated customer via phone. TEL may only be used if a relationship already exists between you and the consumer, or, the consumer initiates the contact with you.
WEB
An ACH debit payment (B2C) that has been authorized by an authenticated customer via the internet or a wireless network.
OPTIONAL
Details about the card.
Use this parameter group when you have sourced payment details using:
Cards: the card details entered directly or collected using a Point of Sale (POS) terminal.
Device payment methods such as Apple Pay, Android Pay, Samsung Pay or Google Pay.
Digital wallets such as Masterpass, Visa Checkout or Amex Express Checkout.
Card scheme tokens where the card was tokenized using a card scheme tokenization service such as Mastercard Digital Enablement Service (MDES).
String
OPTIONAL
This field is only applicable if the gateway has identified the card as the co-branded card.
For a co-branded card, the PAYMENT_OPTIONS_INQUIRY response contains both brands in field paymentTypes.card.cardTypes[n] (when the request contains field sourceOfFunds.provided.card.prefix).
- • You will receive paymentTypes.card.interactionConstraints=CARD_TYPE_SELECTION in the PAYMENT_OPTIONS_INQUIRY response if the card type selection is mandatory. In this case, you must let the payer select the card type and provide this field in the request.
- • You will receive paymentTypes.card.capabilities[n].capability=CARD_TYPE_SELECTION in the PAYMENT_OPTIONS_INQUIRY response if the card type selection is optional. In this case, you may let the payer select the card type or make the selection yourself and provide this field in the request. If not provided, the gateway will make the selection based on your configuration and the card type.
- • If the PAYMENT_OPTIONS_INQUIRY response contains neither of the above fields, the gateway determines the card type and requests that contain this field will be rejected by the gateway.
Data can consist of any characters
OPTIONAL
Details about the card that you have sourced using digital payment methods.
Use this parameter group when you have sourced payment details using:
- • Device payment methods such as Apple Pay, Android Pay, Samsung Pay, or Google Pay.
- • Digital wallets such as Masterpass, Visa Checkout or Amex Express Checkout.
- • Card scheme tokens. This applies when you have tokenized the payer's card number using a card scheme tokenization service such as Mastercard Digital Enablement Service (MDES).
Digits
OPTIONAL
The Electronic Commerce Indicator generated for payments made using a device payment method.
You source this field directly from the decrypted payment token.
This field is not applicable for payments using digital wallets or card scheme tokens.
Data is a string that consists of the characters 0-9.
Base64
OPTIONAL
A cryptogram used to authenticate the transaction.Use this field for:
- • Device payments: source this field directly from the decrypted payment token.
- • Card scheme tokens: source this field directly from the decrypted transaction credentials.
Data is Base64 encoded
String
OPTIONAL
This field only applies to transactions that originate from an EMV capable terminal.
It contains selected EMV fields as provided by the terminal.
For the list of field tags to include (if provided by the terminal), see Card Present Payments. Requests with any other tags are rejected by the gateway.
Some of the tags represent data that can occur on explicit fields in this API. You can submit the value either in this field, or in both places. For example, the PAN can be presented as EMV tag 5A in this field, or included both the sourceOfFunds.provided.card.number API field and in EMV tag 5A in this field.
If you specify the EMV tag only, we can populate the explicit field in the API. Fields where this is supported have the text "This field corresponds to EMV tag <tag name>" in their field descriptions.
If you specify both places, there will be no population of the explicit field or validation that the data matches.
The API response will not contain PCI sensitive fields.
Data can consist of any characters
OPTIONAL
Expiry date, as shown on the card.
This field corresponds to EMV tag 5F24
Digits
REQUIRED
Month, as shown on the card.
Months are numbered January=1, through to December=12.
Data is a number between 1 and 12 represented as a string.
Digits
REQUIRED
Year, as shown on the card.
The Common Era year is 2000 plus this value.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The cardholder's name as printed on the card.
Data can consist of any characters
Digits
OPTIONAL
The account number of the payer's account used for the payment.
On requests, provide the number in the form that you receive it (as explained below). On responses, the gateway populates it with a form that the payer would recognize (also explained in more detail below).
- Request
On request, populate this field based on the payment method you are using for the payment:- • Card: the account number embossed onto the card. This field corresponds to EMV tag 5A.
- • Device payment methods such as Apple Pay, Android Pay, Samsung Pay, or Google Pay. Normally for device payments, you would populate sourceOfFunds.provided.card.devicePayment.paymentToken and the gateway will decrypt and extract this field. However, you can populate this field if you decrypt the payment token yourself. In this case use the Device PAN (DPAN) provided in the payment token.
- • Digital wallets such as Masterpass, Visa Checkout or Amex Express Checkout. In this case, provide the PAN retrieved from the wallet.
- • Scheme tokens such as MDES (Mastercard Digital Enablement Service). Supply the value called the "Token PAN".
- Response
On return, the card number will be populated in 6.4 masking format, for example, 000000xxxxxx0000. If you wish to return unmasked card numbers, you must have the requisite permission, set responseControls.sensitiveData field to UNMASK, and authenticate your call to the API using certificate authentication.
When a DPAN or scheme token was provided in the transaction request, then this field will represent the PAN of the associated payer's account (when supported by the acquirer). This is also referred to as the Funding PAN (FPAN).
Data is a string that consists of the characters 0-9.
OPTIONAL
This holds the PAN in the case where it is encrypted by the terminal using DUKPT key exchange.
Digits
OPTIONAL
The BIN of the card.
If you provide this, the gateway will check that the decrypted PAN has these leading six digits. If the check fails, the gateway will reject the transaction.
If you do not provided this, the gateway will not perform this check.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The P2PE encryption state as determined by the terminal.
INVALID means the terminal detected some form of error in the encryption process. The gateway will decline transactions with INVALID encryption state. This field may be omitted when the value is VALID.
Data can consist of any characters
Hex
OPTIONAL
The initialization vector supplied by the terminal to seed the encryption of this payload.
Omit this value if the terminal is not using an initialization vector to seed encryption.
Data is hexadecimal encoded
Hex
REQUIRED
The DUKPT key serial number supplied by the terminal.
Data is hexadecimal encoded
Hex
REQUIRED
The DUKPT encrypted payload supplied by the terminal.
Data is hexadecimal encoded
OPTIONAL
The PIN (Personal Identification Number) entered by a payer at the point of sale that is used to authenticate their identity as the cardholder with the issuer.
Provide this data in the case where you want the PIN verified online by the issuer. The gateway can support PINs encoded in ISO 9564-1 formats 0, 1, 3 and 4, but the supported format will depend on integration.
Enumeration
OPTIONAL
The PIN encryption state as determined by the terminal.
INVALID means the terminal detected some form of error in the encryption process. The gateway will decline transactions with INVALID encryption state. This field may be omitted when the value is VALID.
Value must be a member of the following list. The values are case sensitive.
INVALID
The encryption state is invalid.
VALID
The encryption state is valid.
Hex
REQUIRED
The DUKPT key serial number supplied by the terminal.
Data is hexadecimal encoded
Hex
REQUIRED
The DUKPT encrypted payload supplied by the terminal.
Data is hexadecimal encoded
Digits
OPTIONAL
Card verification code, as printed on the back or front of the card or as provided for a card scheme token.
Data is a string that consists of the characters 0-9.
Enumeration
OPTIONAL
This field only applies if you collect card details from your payer, store them, and either you or your payer use the stored credentials for subsequent payments.
Refer to Credential on File, Cardholder and Merchant-initiated Transactions for details.
Value must be a member of the following list. The values are case sensitive.
NOT_STORED
Set this value if you are not storing the card details provided by the payer for this transaction. The gateway sets this value by default, if you are submitting a payer-initiated transaction. You must not use this value when submitting merchant-initiated transactions.
STORED
Set this value if you have previously stored the card details provided by the payer and are now using these stored details. The gateway sets this value by default, if you are submitting a merchant-initiated transaction.
TO_BE_STORED
Set this value if this is the first transaction using these card details and you intend to store the card details if the transaction is successful.
Track 1 Data
OPTIONAL
This field contains the full track data.
You may optionally include the start and end sentinels and LRC.
Provide this for stripe and EMV fallback to stripe cases.
This field corresponds to EMV tag 56
Data must comply with ISO 7811-2 track 1 data character set.
Data may consist of the characters: ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ]]>
Track 2 Data
OPTIONAL
This field contains the full track data.
You may optionally include the start and end sentinels and LRC.
Provide this for stripe and EMV fallback to stripe cases.
The contents of this field must match the PAN and expiry fields included in the Transaction Request.
This field corresponds to EMV tag 57
Data must comply with ISO 7811-2 track 2 data character set.
Data may consist of the characters: ? ]]>
OPTIONAL
For Direct Debit payments in Canada you must provide the payer's bank account details in this parameter group.
Enumeration
OPTIONAL
An indicator identifying the type of bank account.
Value must be a member of the following list. The values are case sensitive.
CONSUMER_CHECKING
Consumer Checking Account
CONSUMER_SAVINGS
Consumer Savings Account
String
REQUIRED
The name of the bank account holder, as it appears on the account at the receiving financial institution.
Data can consist of any characters
Alphanumeric + additional characters
REQUIRED
The identifier of the bank account at the receiving financial institution.
The bank account number will be returned in a masked format, for example, xxxxxxxxxxxxx123.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-', '/'
Digits
REQUIRED
The identifier of the receiving financial institution.
Data is a string that consists of the characters 0-9.
Digits
REQUIRED
The transit number identifying the branch of the receiving financial institution where the bank account is held.
Data is a string that consists of the characters 0-9.