MasterCard Payment Gateway API Reference: Operations -
Version 48,
Protocol: checkout

configure()

The configure function is used to prepare the Checkout library for a payment. It must be called before either showEmbeddedPage() or showPaymentPage() to store payment details.

Usage

Checkout.configure(configuration);

Example

Checkout.configure({
    session: {
        id: '<your_session_id>'
    }
});

Arguments

configuration Object COMPULSORY

The configuration object describes the merchant, customer, payment, and checkout appearance and behaviour. Fields in the object can contain literal values or a function that returns the value. Functions will be invoked before showing the payment interface.

Validation problems with the configuration object will be delivered to the error callback.

airline Object = OPTIONAL

Airline industry specific data.
Fixed value

bookingReference String = OPTIONAL

The record locator used to access a specific Passenger Name Record (PNR).
PNR is a record in the database of a booking system that contains the itinerary for a passenger, or a group of passengers traveling together.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
6
maximum length
15

documentType String = OPTIONAL

The type of charge associated with the transaction.
Fixed value
Validation Rules
Document Type Code
Value must be a member of the following list. The values are case sensitive.
ADDITIONAL_COLLECTION
Additional Collection
AGENCY_EXCHANGE_ORDER
Agency Exchange Order
AGENCY_GROUP_TICKET
Agency Group Ticket
AGENCY_MISCELLANEOUS_CHARGE_ORDER
Agency Misc. Charge Order (MCO)
AGENCY_PASSENGER_TICKET
Agency Passenger Ticket
AGENCY_TOUR_ORDER_OR_VOUCHER
Agency Tour Order/Voucher
AIR_FREIGHT
SPD/Air Freight
ANIMAL_TRANSPORTATION_CHARGE
Animal Transportation Charge
CATALOGUE_MERCHANDISE_ORDERED
Catalogue Merchandise Ordered
CLUB_MEMBERSHIP_FEE
Club Membership Fee
COUPON_BOOK
Coupon Book
CREDIT_CLASS_SERVICE_ADJUSTMENT
Credit Class of Service Adjustment
CREDIT_DENIED_BOARDING
Credit Denied Boarding
CREDIT_EXCHANGE_REFUND
Credit Exchange Refund
CREDIT_LOST_TICKET_REFUND
Credit Lost Ticket Refund
CREDIT_MISCELLANEOUS_REFUND
Credit Misc. Refund
CREDIT_MULTIPLE_UNUSED_TICKETS
Credit Multiple Unused Tickets
CREDIT_OVERCHARGE_ADJUSTMENT
Credit Overcharge Adjustment
CREDIT_UNUSED_TRANSPORTATION
Credit Unused Transportation
DEBT_ADJUSTMENT_DUPLICATE_REFUND_OR_USE
Debt Adjustment Duplicate Refund/Use
DUTY_FREE_SALE
Duty Free Sale
EXCESS_BAGGAGE
Excess Baggage
EXCHANGE_ADJUSTMENT
Exchange Adjustment
EXCHANGE_ORDER
Exchange Order
FIREARMS_CASE
Firearms Case
FREQUENT_FLYER_FEE_OR_PURCHASE
Frequent Flyer Fee/Purchase
FREQUENT_FLYER_FULFILLMENT
Frequent Flyer Fulfillment
FREQUENT_FLYER_OVERNIGHT_DELIVERY_CHARGE
Frequent Flyer Overnight Delivery Charge
GROUP_TICKET
Group Ticket
IN_FLIGHT_ADJUSTMENT
In-flight Adjustment
IN_FLIGHT_CHARGES
In-flight Charges
IN_FLIGHT_DUTY_FREE_PURCHASE
In-flight Duty Free Purchase
IN_FLIGHT_MERCHANDISE_ORDERED
In-flight Merchandise Ordered
IN_FLIGHT_PHONE_CHARGES
In-flight Phone Charges
KENNEL_CHARGE
Kennel Charge
LOST_TICKET_APPLICATION
Lost Ticket Application
MISCELLANEOUS_CHARGE_ORDER_OR_PREPAID_TICKET_ADVICE
Misc. Charge Order (MCO) / Prepaid Ticket Auth.
MISCELLANEOUS_TAXES_FEES
Miscellaneous Tax(es) Fee(s)
PASSENGER_TICKET
Passenger Ticket
SELF_SERVICE_TICKETS
Self-Service Ticket(s)
SENIOR_CITIZEN_DISCOUNT_BOOKLETS
Senior Citizen Discount Booklets
SMALL_PACKAGE_DELIVERY
Small Package Delivery
SPECIAL_SERVICE_TICKET
Special Service Ticket
SUPPORTED_REFUND
Supported Refund
TICKET_BY_MAIL
Ticket by Mail
TOUR_DEPOSIT
Tour Deposit
TOUR_ORDER_VOUCHER
Tour Order Voucher
UNDERCHARGE_ADJUSTMENT
Undercharge Adjustment
UNSUPPORTED_REFUND
Unsupported Refund
UPGRADE_CHARGE
Upgrade Charge
VENDOR_REFUND_CREDIT
Vendor Refund Credit
VENDOR_SALE
Vendor Sale

itinerary Object = OPTIONAL

Itinerary details
Fixed value

leg Object = OPTIONAL

Travel leg details.
Fixed value

carrierCode = OPTIONAL

The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier for the trip leg.
Fixed value
Validation Rules
Data must match regex
regex
\w{2}|\d{3}|\w{2}/\d{3}
message
Carrier code must be 2 characters, 3 digits or a combination of both in the format: ZZ/999

conjunctionTicketNumber String = OPTIONAL

The ticket containing the coupon for this leg for an itinerary with more than four trip legs.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
11
maximum length
16

couponNumber String = OPTIONAL

The coupon number on the ticket for the trip leg.
Each trip leg requires a separate coupon. The coupon within the series is identified by the coupon number.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
1

departureAirport String = OPTIONAL

The 3 character IATA airport code of the departure airport for the trip leg.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

departureDate String = OPTIONAL

Date of departure for the trip leg.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

departureTax Number = OPTIONAL

Tax payable on departure for the trip leg.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14

departureTime String = OPTIONAL

Departure time in local time for the departure airport for this trip leg.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended time formats, hh:mm[:ss]Z or hh:mm[:ss](+/-)hh[:mm]

destinationAirport String = OPTIONAL

The 3 character IATA airport code for the destination airport for the trip leg.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

destinationArrivalDate String = OPTIONAL

Arrival date in local time for the destination airport for this trip leg.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

destinationArrivalTime String = OPTIONAL

Arrival time in local time for the destination airport for this trip leg.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended time formats, hh:mm[:ss]Z or hh:mm[:ss](+/-)hh[:mm]

endorsementsRestrictions String = OPTIONAL

Restrictions (e.g. non-refundable) or endorsements applicable to the trip leg.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
20

exchangeTicketNumber String = OPTIONAL

New ticket number issued when a ticket is exchanged for the trip leg.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
11
maximum length
16

fare Number = OPTIONAL

Total fare payable for the trip leg.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14

fareBasis String = OPTIONAL

Code defining the rules forming the basis of the fare (type of fare, class entitlement, etc.)
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
24

fees Number = OPTIONAL

Total fees payable for the trip leg.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14

flightNumber String = OPTIONAL

The flight number for the trip leg.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
4
maximum length
6

stopoverPermitted Boolean = OPTIONAL

Indicates if a stopover is permitted for the trip leg.
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)

taxes Number = OPTIONAL

Total taxes payable for the trip leg.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14

travelClass String = OPTIONAL

The industry code indicating the class of service (e.g. Business, Coach) for the leg.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
3

numberInParty Number = OPTIONAL

Number of passengers associated with this booking.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
minimum length
1
maximum length
3

originCountry String = OPTIONAL

The 3 character ISO 3166-1 alpha-3 country code of the country of origin for the itinerary.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

passenger Object = OPTIONAL

Passenger details
Fixed value

firstName String = OPTIONAL

First name of the passenger to whom the ticket is being issued.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

frequentFlyerNumber String = OPTIONAL

Frequent Flyer or Loyalty Program number for this passenger.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

lastName String = OPTIONAL

Last name of the passenger to whom the ticket is being issued.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

middleName String = OPTIONAL

Middle name of the passenger to whom the ticket is being issued.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

specificInformation String = OPTIONAL

Passenger specific information recorded on the ticket.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
59

title String = OPTIONAL

Title of the passenger to whom the ticket is being issued.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

planNumber String = OPTIONAL

Plan number supplied by the airline for this booking.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
2
maximum length
2

ticket Object = OPTIONAL

Ticket details
Fixed value

conjunctionTicketIndicator Boolean = OPTIONAL

Indicates if a conjunction ticket with additional coupons was issued.
Conjunction ticket refers to two or more tickets concurrently issued to a passenger and which together constitute a single contract of carriage.
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)

eTicket Boolean = OPTIONAL

Indicates if an electronic ticket was issued.
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)

exchangedTicketNumber String = OPTIONAL

The original ticket number when this is a transaction for an exchanged ticket.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
11
maximum length
16

issue Object = OPTIONAL

Ticket issue information.
Fixed value

address String = OPTIONAL

The address where the ticket was issued.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
16

carrierCode = OPTIONAL

The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier issuing the ticket.
Fixed value
Validation Rules
Data must match regex
regex
\w{2}|\d{3}|\w{2}/\d{3}
message
Carrier code must be 2 characters, 3 digits or a combination of both in the format: ZZ/999

carrierName String = OPTIONAL

Name of airline carrier issuing the ticket.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
25

city String = OPTIONAL

The city/town where the ticket was issued.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
18

country String = OPTIONAL

The 3 character ISO 3166-1 alpha-3 country code of the country where the ticket was issued.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

date String = OPTIONAL

The date the ticket was issued.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

travelAgentCode String = OPTIONAL

Industry code of the travel agent issuing the ticket.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
8
maximum length
9

travelAgentName String = OPTIONAL

Name of the travel agent issuing the ticket.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
30

restricted Boolean = OPTIONAL

Indicates if the issued ticket is refundable.
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)

ticketNumber String = OPTIONAL

The airline ticket number associated with the transaction.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
11
maximum length
16

totalFare Number = OPTIONAL

Total fare for all trip legs on the ticket.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14

totalFees Number = OPTIONAL

Total fee for all trip legs on the ticket.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14

totalTaxes Number = OPTIONAL

Total taxes for all trip legs on the ticket.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14

transactionType String = OPTIONAL

The type of transaction performed against this airline booking.
Fixed value
Validation Rules
Transaction Type
Value must be a member of the following list. The values are case sensitive.
EXCHANGE_TICKET
Exchange Ticket
MISCELLANEOUS_CHARGE
Miscellaneous Charge
REFUND
Refund
REVERSAL
Reversal
TICKET_PURCHASE
Ticket Purchase
TOUR_ORDER
Tour Order

billing Object = OPTIONAL

Details of the payer's billing address.
Fixed value

address Object = OPTIONAL

The payer's billing address.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value

city String = OPTIONAL

The city portion of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

company String = OPTIONAL

The name of the company associated with this address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

country String = OPTIONAL

The 3 letter ISO standard alpha country code of the address.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

postcodeZip String = OPTIONAL

The post code or zip code of the address.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
minimum length
1
maximum length
10

stateProvince String = OPTIONAL

The state or province of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

street String = OPTIONAL

The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

street2 String = OPTIONAL

The second line of the address (if provided).
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

constraints Object = OPTIONAL

Information about any constraints that apply to this transaction.
Specify constraints to ensure that the transaction conforms to predefined criteria. This is useful if your integration does not directly collect all the transaction values (e.g. a session-based integration or a checkout integration).
Fixed value

paymentPlans Object = OPTIONAL

Information about the payment plan constraints which apply for this transaction.
Specify payment plan constraints to restrict the available payment plan options for this transaction.
Fixed value

numberOfDeferrals Number = OPTIONAL

The allowable number of deferral months for the payment plan.
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
minimum value
0
maximum value
99

numberOfPayments Number = OPTIONAL

The allowable number of installments for the payment plan.
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
minimum value
1
maximum value
99

supported String = OPTIONAL

The identifiers for the payment plans supported for this transaction.
If you wish to offer any payment plans to the payer, provide the plan identifiers in this field else pass it as empty.

See Payment Plans for the supported payment plans and their identifiers.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40

customer Object = OPTIONAL

Information about the customer, including their contact details.
Fixed value

email String = 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.
Fixed value
Validation Rules
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses

firstName String = OPTIONAL

The payer's first name.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

lastName String = OPTIONAL

The payer's last or surname.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

mobilePhone String = OPTIONAL

The contact person's mobile phone or cell phone number.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

phone String = OPTIONAL

The phone number of the person to whom the order is being billed.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

device Object = OPTIONAL

Information associated with the device's source of transaction.
Fixed value

ani String = OPTIONAL

The telephone number captured by ANI (Automatic Number Identification) when the customer calls to place the order.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
10

aniCallType 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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
2

mobilePhoneModel String = OPTIONAL

The mobile phone manufacturer's identifier for the model of the mobile device used to initiate the payment.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
255

interaction Object = COMPULSORY

Information that controls the payer's checkout interaction.
Fixed value

googleAnalytics Object = OPTIONAL

Fixed value

propertyId String = OPTIONAL

The property ID for your shop site provided by Google Analytics in the form UA-XXXXX-Y.
Provide this ID if you want to track interactions with the checkout using Google Analytics. See www.google.com/analytics.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

cancelUrl String = COMPULSORY

The URL to which you want to redirect the payer's browser if they cancel their payment.
This could be a link to the payer's shopping cart, or the home page of your website.
Fixed value
Validation Rules
Data must be an absolute URI conforming to the URI syntax published by IETF RFC 2396. The following schemes are forbidden : javascript

displayControl Object = OPTIONAL

A group of objects that control the visibility of, and payer-interaction with, displayed information.
Fixed value

billingAddress String = OPTIONAL

Indicates if you require the payer to provide their billing address during the payment interaction.
If you do not provide this field, the billing address will be optional.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Hides data fields from the payer.
MANDATORY
Displays data fields and allows the payer to enter data into these fields.
OPTIONAL
Displays data fields and allows the payer to opt out of data entry for these fields.
READ_ONLY
Data is displayed but cannot be modified.

confirmAchAccountNumber String = OPTIONAL

Indicates if you wish to display a 'Confirm Account Number' field for the ACH Account Number entry.
If the field is shown, the gateway enforces that the same value is entered in both the 'Account Number' and 'Confirm Account Number' fields.If you do not provide a value for this field, the gateway defaults the value to SHOW.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Do not display confirm account number.
SHOW
Display confirm account number.

customerEmail String = OPTIONAL

Indicates if you require the payer to provide their email address on the payment interaction.
If you do not provide this field, the payer's email address will be hidden.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Hides data fields from the payer.
MANDATORY
Displays data fields and allows the payer to enter data into these fields.
OPTIONAL
Displays data fields and allows the payer to opt out of data entry for these fields.
READ_ONLY
Data is displayed but cannot be modified.

orderSummary String = OPTIONAL

Indicates if you wish to display a summary of the order before the payer submits their payment.
If you do not provide a value for this field, the gateway defaults the value to SHOW.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Do not display order summary.
SHOW
Display order summary, which may include payment details.
SHOW_PARTIAL
Display order summary which may not include payment details.

paymentConfirmation String = OPTIONAL

Indicates if you want the payer to confirm the payment details before they submit the payment.
If you do not provide a value for this field, the gateway defaults the value to HIDE.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Do not display payment confirmation.
SHOW
Display payment confirmation.

paymentTerms String = OPTIONAL

Indicates whether you wish to hide payment terms for a payment plan during the payment interaction.
If you do not provide this field the payment terms for a payment plan will be displayed.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Hides the payment terms from the payer. Note that offering Plan AMEX in some regions may require you to inform the payer of the payment terms before processing the payment.
SHOW_IF_SUPPORTED
Displays the payment terms, if available, to the payer.

shipping String = OPTIONAL

Indicates if you wish to hide the shipping details on the payment interaction.
If you don't provide this field, shipping details will be displayed to the payer.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Hides data fields from the payer.
READ_ONLY
Data is displayed but cannot be modified.

locale String = OPTIONAL

A language identifier or IETF language tag to control the language of the payment interaction with the payer (e.g. en_US, es, fr-CA).
By default, the language is determined from the payer's browser. Supply a value for this field only if you wish to override the default behavior. If the language you specify is not supported by the gateway, the payment is displayed in the best matching language.
Fixed value
Validation Rules
Data must be a language identifier or IETF language tag
minimum length
2
maximum length
5

merchant Object = COMPULSORY

Information that allows you to display your brand and business details during the payment interaction.
Fixed value

address Object = OPTIONAL

Information on your business address.
Fixed value

line1 String = OPTIONAL

The first line of your business address for display to the payer during the payment interaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100

line2 String = OPTIONAL

The second line of your business address for display to the payer during the payment interaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100

line3 String = OPTIONAL

The third line of your business address for display to the payer during the payment interaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100

line4 String = OPTIONAL

The fourth line of your business address for display to the payer during the payment interaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100

email String = OPTIONAL

The email address of your business for display to the payer during the payment interaction (e.g. an email address for customer service).
Fixed value
Validation Rules
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses

name String = COMPULSORY

The name of your business for display to the payer on the payment interaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40

phone String = OPTIONAL

The phone number of your business for display to the payer during the payment interaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
20

theme String = OPTIONAL

The theme used to control the look and feel of your checkout interaction.
If you do not provide this field the default theme is will be used.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
minimum length
1
maximum length
50

merchant String = COMPULSORY

The unique identifier issued to you by your payment provider.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
minimum length
1
maximum length
40

order Object = COMPULSORY

Information about the order associated with this transaction.
Fixed value

id String = OPTIONAL

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 created by your merchant profile.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40

amount Number = OPTIONAL

The total amount for the order.
If you provide both this value and any of the sub-total amounts (order.itemAmount, order.shippingAndHandlingAmount, order.taxAmount) then the sum of the sub-total amounts MUST equal the order.amount.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14

cashAdvance Boolean = OPTIONAL

Set this flag if the transaction is a manual cash disbursement transaction, i.e. cash is disbursed upon the acceptance of a card by a financial institution teller.
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)

certainty String = OPTIONAL

Indicates if you expect to capture the full order amount for which you are requesting authorization.
If you do not provide a value for order.certainty the default configured for you by your payment service provider will be used. The value provided in the response shows the value the gateway sent to the acquirer
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
ESTIMATED
The amount authorized is an estimate of the amount that will be captured. It is possible that the amount captured will be less, or might not be captured at all.
FINAL
The full authorized amount is expected to be captured within the mandated time. The order will only be cancelled in exceptional circumstances (for example, the payer cancelled their purchase).

currency String = COMPULSORY

The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

custom 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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
250

customerNote String = OPTIONAL

A note from the payer about this order.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
250

customerOrderDate String = OPTIONAL

The date the payer placed the order.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

customerReference String = 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.
Fixed value
Validation Rules
Data consists of ASCII characters
minimum length
0
maximum length
25

description String = OPTIONAL

Short textual description of the contents of the order.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
127

merchantCategoryCode Number = 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.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
minimum length
4
maximum length
4

owningEntity 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
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40

recurringPaymentAgreement String = OPTIONAL

Your reference to the contract or agreement you have with the payer to process recurring payments.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
30

reference String = OPTIONAL

The identifier of the order.
For example, a shopping cart number, an order number, or an invoice number.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40

requestorName String = OPTIONAL

The name of the person who requested the goods or services.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

shippingAndHandlingAmount Number = OPTIONAL

The total shipping and handling amount for the order.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14

subMerchant Object = 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.
Fixed value

address Object = OPTIONAL

The sub-merchant's address.
Fixed value

city String = OPTIONAL

The city portion of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

company String = OPTIONAL

The name of the company associated with this address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

country String = OPTIONAL

The 3 letter ISO standard alpha country code of the address.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

postcodeZip String = OPTIONAL

The post code or zip code of the address.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
minimum length
1
maximum length
10

stateProvince String = OPTIONAL

The state or province of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

street String = OPTIONAL

The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

street2 String = OPTIONAL

The second line of the address (if provided).
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

bankIndustryCode Number = OPTIONAL

Code used by acquirer to describe the business or industry the sub-merchant operates in.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
minimum length
4
maximum length
4

email String = OPTIONAL

The sub-merchant's email address.
Fixed value
Validation Rules
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses

identifier String = OPTIONAL

Your identifier for the sub-merchant.
You can use this identifier in searches and reports in the gateway.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

phone String = OPTIONAL

The sub-merchant's phone number
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

registeredName String = OPTIONAL

The legal name of the sub-merchant.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

tradingName String = OPTIONAL

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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

tax Object = 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.
Fixed value

amount Number = OPTIONAL

The tax amount included in this order for the tax type.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14

type 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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

taxAmount Number = OPTIONAL

The total tax amount for the order.
If you do not provide this value but provide line item data, then this amount is calculated as the sum of the item.quantity times the item.unitTaxAmount for all the line items (total tax amount).
If you provide both this value and line item data, then the order.taxAmount MUST equal the total tax amount.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14

taxRegistrationId 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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
30

partnerSolutionId 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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40

session Object = OPTIONAL

Fixed value

id String = OPTIONAL

Identifier of the payment session containing values for any of the request fields to be used in this operation.
Values contained in the session will override values provided by the request.
Fixed value
Validation Rules
Data consists of ASCII characters
minimum length
31
maximum length
35

version String = 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.
Fixed value
Validation Rules
Data consists of ASCII characters
minimum length
10
maximum length
10

shipping Object = OPTIONAL

Information on the shipping address including the contact details of the addressee.
Fixed value

address Object = OPTIONAL

The address to which the goods contained in this order are being shipped.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value

city String = OPTIONAL

The city portion of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

company String = OPTIONAL

The name of the company associated with this address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

country String = OPTIONAL

The 3 letter ISO standard alpha country code of the address.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

postcodeZip String = OPTIONAL

The post code or zip code of the address.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
minimum length
1
maximum length
10

stateProvince String = OPTIONAL

The state or province of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

street String = OPTIONAL

The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

street2 String = OPTIONAL

The second line of the address (if provided).
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

contact Object = OPTIONAL

Details of the contact person at the address the goods will be shipped to.
Fixed value

email String = 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.
Fixed value
Validation Rules
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses

firstName String = OPTIONAL

The first name of the person to whom the order is being shipped.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

lastName String = OPTIONAL

The last name or surname of the person to whom the order is being shipped.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

mobilePhone String = OPTIONAL

The contact person's mobile phone or cell phone number.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

phone String = OPTIONAL

The phone number of the person to whom the order is being shipped.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

method String = OPTIONAL

The shipping method code to indicate the time frame and the priority of the order.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
ELECTRONIC
Electronic delivery.
GROUND
Ground (4 or more days).
OVERNIGHT
Overnight (next day).
PRIORITY
Priority (2-3 days).
SAME_DAY
Same day.

transaction Object = OPTIONAL

Information about this transaction.
Fixed value

acquirer Object = OPTIONAL

Additional information to be passed to acquirer.
Fixed value

customData String = OPTIONAL

Additional information requested by the acquirer which cannot be passed using other available data fields.
This field must not contain sensitive data.
Fixed value
Validation Rules
Data can consist of any characters, but sensitive data will be rejected
minimum length
1
maximum length
2048

transactionId String = OPTIONAL

This is the value provided to the acquirer to identify the order.
Ideally this will be the order.id, however if that value cannot be used directly, it will be transformed by the gateway to a unique value that the acquirer will accept. If that behavior is not suitable, you can directly provide the value in this field and it will be passed to the acquirer. You then take responsibility for its correctness. (Note: contact your payment provider to see if this is supported for your acquirer).
Fixed value
Validation Rules
Data can consist of any characters, but sensitive data will be rejected
minimum length
1
maximum length
100

frequency String = OPTIONAL

Indicates the frequency of the transaction offered to the payer.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
INSTALLMENT
Indicates an installment transaction where the payer authorizes you to deduct multiple payments over an agreed period of time for a single purchase.
RECURRING
Indicates a recurring transaction where the payer authorizes you to automatically debit their accounts for bill or invoice payments.
SINGLE
Indicates a single transaction where a single payment is used to complete the order.

merchantNote String = OPTIONAL

Your note about this transaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
250

reference String = OPTIONAL

An optional identifier for this transaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40

userId String = OPTIONAL

The person who initiated this transaction.
For Merchant Administration, the person is identified by their logon name.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
256

Return Value

None

Copyright © 2023 MasterCard