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

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

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

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

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

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

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

departureDate String = OPTIONAL

Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

departureTax Number = OPTIONAL

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

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

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

destinationArrivalDate String = OPTIONAL

Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

destinationArrivalTime String = OPTIONAL

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

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

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

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

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

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

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

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

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

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

Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
minimum length
1
maximum length
3

originCountry String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

frequentFlyerNumber String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

lastName String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

middleName String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

specificInformation String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

planNumber String = OPTIONAL

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

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

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
16

carrierCode = OPTIONAL

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

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

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

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

date String = OPTIONAL

Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

travelAgentCode String = OPTIONAL

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

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

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

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

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

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

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

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

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value

city String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

company String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

country String = OPTIONAL

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

postcodeZip String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

street String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

constraints Object = OPTIONAL

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

Specify payment plan constraints to restrict the available payment plan options for this transaction.
Fixed value

numberOfDeferrals Number = OPTIONAL

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

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

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 associated with the customer's source of transaction.
Fixed value

email String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

lastName String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

mobilePhone String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

phone String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
10

aniCallType String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
2

interaction Object = COMPULSORY

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

googleAnalytics Object = OPTIONAL

Fixed value

propertyId String = OPTIONAL

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

displayControl Object = OPTIONAL

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

billingAddress String = OPTIONAL

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.

customerEmail String = OPTIONAL

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

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

paymentTerms String = OPTIONAL

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

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100

line2 String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100

line3 String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100

line4 String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100

email String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40

phone String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
20

theme String = OPTIONAL

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

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

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

acceptPartialAmount Boolean = OPTIONAL

If not set or set to FALSE, and the full amount is not available, the transaction will be rejected.
Unless you have been advised by your payment service provider that the gateway supports partial approvals for your acquirer, you can ignore this field.
If the gateway supports partial approvals for your acquirer you must set this field to TRUE else the transaction is rejected by the gateway.
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)

amount Number = OPTIONAL

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

currency String = COMPULSORY

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

custom String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
250

customerOrderDate String = OPTIONAL

Data must comply with ISO 8601 extended date format, yyyy-mm-dd. This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

customerReference String = OPTIONAL

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value
Validation Rules
Data consists of ASCII characters
minimum length
0
maximum length
25

description String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
127

productSKU String = OPTIONAL

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
15

recurringPaymentAgreement String = OPTIONAL

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

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

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

shippingAndHandlingAmount Number = OPTIONAL

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

company String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

country String = OPTIONAL

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

postcodeZip String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

street String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

bankIndustryCode Number = OPTIONAL

Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
minimum length
4
maximum length
4

email String = OPTIONAL

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

registeredName String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

tradingName String = OPTIONAL

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

Allows you to provide a breakdown of the types of taxes and amount per type of tax included in order.taxAmount.
Fixed value

amount Number = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

taxAmount Number = OPTIONAL

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.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
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

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

partnerSolutionId String = OPTIONAL

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

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

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

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value

city String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

company String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

country String = OPTIONAL

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

postcodeZip String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

street String = OPTIONAL

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

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 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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

lastName String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

mobilePhone String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

phone String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

method String = OPTIONAL

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

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

cashAdvance Boolean = OPTIONAL

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

frequency String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
250

reference String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40

userId String = OPTIONAL

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