Checkout configure()

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 Copied to clipboard

Checkout.configure(configuration);


Example Copied to clipboard

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

Arguments Copied to clipboard

configuration Copied to clipboard Object

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 Copied to clipboard Object

Airline industry specific data

bookingReference Copied to clipboard String

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.
Data may consist of the characters 0-9, a-z, A-Z
Min length:6
Max length:15
documentType Copied to clipboard String

The type of charge associated with the transaction.

Document Type Code
Value must be a member of the following list. The values are case sensitive.
ADDITIONAL_COLLECTIONAdditional Collection
AGENCY_EXCHANGE_ORDERAgency Exchange Order
AGENCY_GROUP_TICKETAgency Group Ticket
AGENCY_MISCELLANEOUS_CHARGE_ORDERAgency Misc. Charge Order (MCO)
AGENCY_PASSENGER_TICKETAgency Passenger Ticket
AGENCY_TOUR_ORDER_OR_VOUCHERAgency Tour Order/Voucher
AIR_FREIGHTSPD/Air Freight
ANIMAL_TRANSPORTATION_CHARGEAnimal Transportation Charge
CATALOGUE_MERCHANDISE_ORDEREDCatalogue Merchandise Ordered
CLUB_MEMBERSHIP_FEEClub Membership Fee
COUPON_BOOKCoupon Book
CREDIT_CLASS_SERVICE_ADJUSTMENTCredit Class of Service Adjustment
CREDIT_DENIED_BOARDINGCredit Denied Boarding
CREDIT_EXCHANGE_REFUNDCredit Exchange Refund
CREDIT_LOST_TICKET_REFUNDCredit Lost Ticket Refund
CREDIT_MISCELLANEOUS_REFUNDCredit Misc. Refund
CREDIT_MULTIPLE_UNUSED_TICKETSCredit Multiple Unused Tickets
CREDIT_OVERCHARGE_ADJUSTMENTCredit Overcharge Adjustment
CREDIT_UNUSED_TRANSPORTATIONCredit Unused Transportation
DEBT_ADJUSTMENT_DUPLICATE_REFUND_OR_USEDebt Adjustment Duplicate Refund/Use
DUTY_FREE_SALEDuty Free Sale
EXCESS_BAGGAGEExcess Baggage
EXCHANGE_ADJUSTMENTExchange Adjustment
EXCHANGE_ORDERExchange Order
FIREARMS_CASEFirearms Case
FREQUENT_FLYER_FEE_OR_PURCHASEFrequent Flyer Fee/Purchase
FREQUENT_FLYER_FULFILLMENTFrequent Flyer Fulfillment
FREQUENT_FLYER_OVERNIGHT_DELIVERY_CHARGEFrequent Flyer Overnight Delivery Charge
GROUP_TICKETGroup Ticket
IN_FLIGHT_ADJUSTMENTIn-flight Adjustment
IN_FLIGHT_CHARGESIn-flight Charges
IN_FLIGHT_DUTY_FREE_PURCHASEIn-flight Duty Free Purchase
IN_FLIGHT_MERCHANDISE_ORDEREDIn-flight Merchandise Ordered
IN_FLIGHT_PHONE_CHARGESIn-flight Phone Charges
KENNEL_CHARGEKennel Charge
LOST_TICKET_APPLICATIONLost Ticket Application
MISCELLANEOUS_CHARGE_ORDER_OR_PREPAID_TICKET_ADVICEMisc. Charge Order (MCO) / Prepaid Ticket Auth.
MISCELLANEOUS_TAXES_FEESMiscellaneous Tax(es) Fee(s)
PASSENGER_TICKETPassenger Ticket
SELF_SERVICE_TICKETSSelf-Service Ticket(s)
SENIOR_CITIZEN_DISCOUNT_BOOKLETSSenior Citizen Discount Booklets
SMALL_PACKAGE_DELIVERYSmall Package Delivery
SPECIAL_SERVICE_TICKETSpecial Service Ticket
SUPPORTED_REFUNDSupported Refund
TICKET_BY_MAILTicket by Mail
TOUR_DEPOSITTour Deposit
TOUR_ORDER_VOUCHERTour Order Voucher
UNDERCHARGE_ADJUSTMENTUndercharge Adjustment
UNSUPPORTED_REFUNDUnsupported Refund
UPGRADE_CHARGEUpgrade Charge
VENDOR_REFUND_CREDITVendor Refund Credit
VENDOR_SALEVendor Sale
itinerary Copied to clipboard Object

Itinerary details

leg Copied to clipboard Object

Travel leg details.

carrierCode Copied to clipboard

The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier for the trip leg.

Data must match regex
regex\w{2}|\d{3}|\w{2}/\d{3}
messageCarrier code must be 2 characters, 3 digits or a combination of both in the format: ZZ/999
conjunctionTicketNumber Copied to clipboard String

The ticket containing the coupon for this leg for an itinerary with more than four trip legs.

Data may consist of the characters 0-9, a-z, A-Z
Min length:11
Max length:16
couponNumber Copied to clipboard String

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.
Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:1
departureAirport Copied to clipboard String

The 3 character IATA airport code of the departure airport for the trip leg.

Data must consist of the characters A-Z
Min length:3
Max length:3
departureDate Copied to clipboard String

Date of departure for the trip leg.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd
departureTax Copied to clipboard Number

Tax payable on departure for the trip leg.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
departureTime Copied to clipboard String

Departure time in local time for the departure airport for this trip leg.

Data must comply with ISO 8601 extended time formats, hh:mm[:ss]Z or hh:mm[:ss](+/-)hh[:mm]
destinationAirport Copied to clipboard String

The 3 character IATA airport code for the destination airport for the trip leg.

Data must consist of the characters A-Z
Min length:3
Max length:3
destinationArrivalTime Copied to clipboard String

Arrival time in local time for the destination airport for this trip leg.

Data must comply with ISO 8601 extended time formats, hh:mm[:ss]Z or hh:mm[:ss](+/-)hh[:mm]
endorsementsRestrictions Copied to clipboard String

Restrictions (e.g. non-refundable) or endorsements applicable to the trip leg.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:20
exchangeTicketNumber Copied to clipboard String

New ticket number issued when a ticket is exchanged for the trip leg.

Data may consist of the characters 0-9, a-z, A-Z
Min length:11
Max length:16
fare Copied to clipboard Number

Total fare payable for the trip leg.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
fareBasis Copied to clipboard String

Code defining the rules forming the basis of the fare (type of fare, class entitlement, etc.)

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:24
fees Copied to clipboard Number

Total fees payable for the trip leg.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
flightNumber Copied to clipboard String

The flight number for the trip leg.

Data may consist of the characters 0-9, a-z, A-Z
Min length:4
Max length:6
stopoverPermitted Copied to clipboard Boolean

Indicates if a stopover is permitted for the trip leg.

The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
taxes Copied to clipboard Number

Total taxes payable for the trip leg.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
travelClass Copied to clipboard String

The industry code indicating the class of service (e.g. Business, Coach) for the leg.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:3
numberInParty Copied to clipboard Number

Number of passengers associated with this booking.

Data is a string that consists of the characters 0-9.
Min length:1
Max length:3
originCountry Copied to clipboard String

The 3 character ISO 3166-1 alpha-3 country code of the country of origin for the itinerary.

Data must consist of the characters A-Z
Min length:3
Max length:3
passenger Copied to clipboard Object

Passenger details

firstName Copied to clipboard String

First name of the passenger to whom the ticket is being issued.

Data can consist of any characters
Min length:1
Max length:50
lastName Copied to clipboard String

Last name of the passenger to whom the ticket is being issued.

Data can consist of any characters
Min length:1
Max length:20
middleName Copied to clipboard String

Middle name of the passenger to whom the ticket is being issued.

Data can consist of any characters
Min length:1
Max length:50
specificInformation Copied to clipboard String

Passenger specific information recorded on the ticket.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:59
title Copied to clipboard String

Title of the passenger to whom the ticket is being issued.

Data can consist of any characters
Min length:1
Max length:20
planNumber Copied to clipboard String

Plan number supplied by the airline for this booking.

Data may consist of the characters 0-9, a-z, A-Z
Min length:2
Max length:2
ticket Copied to clipboard Object

Ticket details

conjunctionTicketIndicator Copied to clipboard Boolean

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.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
customerReference Copied to clipboard String

Information supplied by the customer.

For example, Frequent Flyer number.
Data can consist of any characters
Min length:1
Max length:20
eTicket Copied to clipboard Boolean

Indicates if an electronic ticket was issued.

The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
exchangedTicketNumber Copied to clipboard String

The original ticket number when this is a transaction for an exchanged ticket.

Data may consist of the characters 0-9, a-z, A-Z
Min length:11
Max length:16
issue Copied to clipboard Object

Ticket issue information.

address Copied to clipboard String

The address where the ticket was issued.

Data can consist of any characters
Min length:1
Max length:16
carrierCode Copied to clipboard

The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier issuing the ticket.

Data must match regex
regex\w{2}|\d{3}|\w{2}/\d{3}
messageCarrier code must be 2 characters, 3 digits or a combination of both in the format: ZZ/999
carrierName Copied to clipboard String

Name of airline carrier issuing the ticket.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:25
city Copied to clipboard String

The city/town where the ticket was issued.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:18
country Copied to clipboard String

The 3 character ISO 3166-1 alpha-3 country code of the country where the ticket was issued.

Data must consist of the characters A-Z
Min length:3
Max length:3
date Copied to clipboard String

The date the ticket was issued.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd
travelAgentCode Copied to clipboard String

Industry code of the travel agent issuing the ticket.

Data may consist of the characters 0-9, a-z, A-Z
Min length:8
Max length:9
travelAgentName Copied to clipboard String

Name of the travel agent issuing the ticket.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:30
restricted Copied to clipboard Boolean

Indicates if the issued ticket is refundable.

The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
ticketNumber Copied to clipboard String

The airline ticket number associated with the transaction.

Data may consist of the characters 0-9, a-z, A-Z
Min length:11
Max length:16
totalFare Copied to clipboard Number

Total fare for all trip legs on the ticket.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
totalFees Copied to clipboard Number

Total fee for all trip legs on the ticket.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
totalTaxes Copied to clipboard Number

Total taxes for all trip legs on the ticket.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
transactionType Copied to clipboard String

The type of transaction performed against this airline booking.

Transaction Type
Value must be a member of the following list. The values are case sensitive.
EXCHANGE_TICKETExchange Ticket
MISCELLANEOUS_CHARGEMiscellaneous Charge
REFUNDRefund
REVERSALReversal
TICKET_PURCHASETicket Purchase
TOUR_ORDERTour Order
billing Copied to clipboard Object

Details of the payer's billing address.

address Copied to clipboard Object

The payer's billing address.

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
city Copied to clipboard String

The city portion of the address.

Data can consist of any characters
Min length:1
Max length:100
company Copied to clipboard String

The name of the company associated with this address.

Data can consist of any characters
Min length:1
Max length:100
country Copied to clipboard String

The 3 letter ISO standard alpha country code of the address.

Data must consist of the characters A-Z
Min length:3
Max length:3
postcodeZip Copied to clipboard String

The post code or zip code of the address.

Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
Min length:1
Max length:10
stateProvince Copied to clipboard String

The state or province of the address.

Data can consist of any characters
Min length:1
Max length:20
street Copied to clipboard String

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
Min length:1
Max length:100
street2 Copied to clipboard String

The second line of the address (if provided).

Data can consist of any characters
Min length:1
Max length:100
constraints Copied to clipboard Object

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).
paymentPlans Copied to clipboard Object

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.
numberOfDeferrals Copied to clipboard Number

The allowable number of deferral months for the payment plan.

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.)
Min value:0
Max value:99
numberOfPayments Copied to clipboard Number

The allowable number of installments for the payment plan.

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.)
Min value:1
Max value:99
supported Copied to clipboard String

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.
Data can consist of any characters
Min length:1
Max length:40
customer Copied to clipboard Object

Information associated with the customer's source of transaction.

email Copied to clipboard String

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
firstName Copied to clipboard String

The payer's first name.

Data can consist of any characters
Min length:1
Max length:50
lastName Copied to clipboard String

The payer's last or surname.

Data can consist of any characters
Min length:1
Max length:50
mobilePhone Copied to clipboard String

The contact person's mobile phone or cell phone number.

Data can consist of any characters
Min length:1
Max length:20
phone Copied to clipboard String

The phone number of the person to whom the order is being billed.

Data can consist of any characters
Min length:1
Max length:20
device Copied to clipboard Object

Information associated with the device's source of transaction.

ani Copied to clipboard String

The telephone number captured by ANI (Automatic Number Identification) when the customer calls to place the order.

Data can consist of any characters
Min length:1
Max length:10
aniCallType Copied to clipboard String

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
Min length:1
Max length:2
interaction Copied to clipboard Object REQUIRED

Information that controls the payer's checkout interaction.

googleAnalytics Copied to clipboard Object
propertyId Copied to clipboard String

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.
Data can consist of any characters
Min length:1
Max length:20
displayControl Copied to clipboard Object

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

billingAddress Copied to clipboard String

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.
Value must be a member of the following list. The values are case sensitive.
HIDEHides data fields from the payer.
MANDATORYDisplays data fields and allows the payer to enter data into these fields.
OPTIONALDisplays data fields and allows the payer to opt out of data entry for these fields.
READ_ONLYData is displayed but cannot be modified.
customerEmail Copied to clipboard String

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 optional.
Value must be a member of the following list. The values are case sensitive.
HIDEHides data fields from the payer.
MANDATORYDisplays data fields and allows the payer to enter data into these fields.
OPTIONALDisplays data fields and allows the payer to opt out of data entry for these fields.
READ_ONLYData is displayed but cannot be modified.
orderSummary Copied to clipboard String

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 READ_ONLY.
Value must be a member of the following list. The values are case sensitive.
HIDEDo not display order summary.
READ_ONLYDisplay order summary, which may include payment details.
paymentTerms Copied to clipboard String

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.
Value must be a member of the following list. The values are case sensitive.
HIDEHides 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_SUPPORTEDDisplays the payment terms, if available, to the payer.
locale Copied to clipboard String

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.
Data must be a language identifier or IETF language tag
Min length:2
Max length:5
merchant Copied to clipboard Object REQUIRED

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

address Copied to clipboard Object

Information on your business address.

line1 Copied to clipboard String

The first line of your business address for display to the payer during the payment interaction.

Data can consist of any characters
Min length:0
Max length:100
line2 Copied to clipboard String

The second line of your business address for display to the payer during the payment interaction.

Data can consist of any characters
Min length:0
Max length:100
line3 Copied to clipboard String

The third line of your business address for display to the payer during the payment interaction.

Data can consist of any characters
Min length:0
Max length:100
line4 Copied to clipboard String

The fourth line of your business address for display to the payer during the payment interaction.

Data can consist of any characters
Min length:0
Max length:100
email Copied to clipboard String

The email address of your business for display to the payer during the payment interaction (e.g. an email address for customer service).

Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
name Copied to clipboard String REQUIRED

The name of your business for display to the payer on the payment interaction.

Data can consist of any characters
Min length:1
Max length:40
phone Copied to clipboard String

The phone number of your business for display to the payer during the payment interaction.

Data can consist of any characters
Min length:0
Max length:20
theme Copied to clipboard String

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.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Min length:1
Max length:50
merchant Copied to clipboard String 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:40
order Copied to clipboard Object REQUIRED

Information about the order associated with this transaction.

id Copied to clipboard String

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.
Data can consist of any characters
Min length:1
Max length:40
amount Copied to clipboard Number REQUIRED

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.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
currency Copied to clipboard String REQUIRED

The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.

Data must consist of the characters A-Z
Min length:3
Max length:3
custom Copied to clipboard String

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
Min length:1
Max length:250
customerNote Copied to clipboard String

A note from the payer about this order.

Data can consist of any characters
Min length:1
Max length:250
customerOrderDate Copied to clipboard String

The date the payer placed the order.

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.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
customerReference Copied to clipboard String

The payer's own reference for the order (for example, the purchase order number).

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Data consists of ASCII characters
Min length:0
Max length:25
description Copied to clipboard String REQUIRED

Short textual description of the contents of the order.

Data can consist of any characters
Min length:1
Max length:127
productSKU Copied to clipboard String

Unique SKU (Stock Keeping Unit) for the single, most expensive product associated with this order.

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Data can consist of any characters
Min length:1
Max length:15
recurringPaymentAgreement Copied to clipboard String

Your reference to the contract or agreement you have with the payer to process recurring payments.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:30
reference Copied to clipboard String

The identifier of the order.

For example, a shopping cart number, an order number, or an invoice number.
Data can consist of any characters
Min length:1
Max length:40
requestorName Copied to clipboard String

The name of the person who requested the goods or services.

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Data can consist of any characters
Min length:1
Max length:100
shippingAndHandlingAmount Copied to clipboard Number

The total shipping and handling amount for the order.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
taxAmount Copied to clipboard Number

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.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
taxRegistrationId Copied to clipboard String

Your tax registration identifier provided by the tax authority (for example, federal tax identification number, ABN).

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Data can consist of any characters
Min length:1
Max length:20
partnerSolutionId Copied to clipboard String

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
Min length:1
Max length:40
session Copied to clipboard Object
id Copied to clipboard String

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.
Data consists of ASCII characters
Min length:31
Max length:35
version Copied to clipboard String

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
Min length:10
Max length:10
shipping Copied to clipboard Object

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

address Copied to clipboard Object

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.
city Copied to clipboard String

The city portion of the address.

Data can consist of any characters
Min length:1
Max length:100
company Copied to clipboard String

The name of the company associated with this address.

Data can consist of any characters
Min length:1
Max length:100
country Copied to clipboard String

The 3 letter ISO standard alpha country code of the address.

Data must consist of the characters A-Z
Min length:3
Max length:3
postcodeZip Copied to clipboard String

The post code or zip code of the address.

Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
Min length:1
Max length:10
stateProvince Copied to clipboard String

The state or province of the address.

Data can consist of any characters
Min length:1
Max length:20
street Copied to clipboard String

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
Min length:1
Max length:100
street2 Copied to clipboard String

The second line of the address (if provided).

Data can consist of any characters
Min length:1
Max length:100
contact Copied to clipboard Object

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

email Copied to clipboard String

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
firstName Copied to clipboard String

The first name of the person to whom the order is being shipped.

Data can consist of any characters
Min length:1
Max length:50
lastName Copied to clipboard String

The last name or surname of the person to whom the order is being shipped.

Data can consist of any characters
Min length:1
Max length:50
mobilePhone Copied to clipboard String

The contact person's mobile phone or cell phone number.

Data can consist of any characters
Min length:1
Max length:20
phone Copied to clipboard String

The phone number of the person to whom the order is being shipped.

Data can consist of any characters
Min length:1
Max length:20
method Copied to clipboard String

The shipping method code to indicate the time frame and the priority of the order.

Value must be a member of the following list. The values are case sensitive.
ELECTRONICElectronic delivery.
GROUNDGround (4 or more days).
OVERNIGHTOvernight (next day).
PRIORITYPriority (2-3 days).
SAME_DAYSame day.
transaction Copied to clipboard Object

Information about this transaction.

acquirer Copied to clipboard Object

Additional information to be passed to acquirer.

customData Copied to clipboard String

Additional information requested by the acquirer 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
Min length:1
Max length:2048
cashAdvance Copied to clipboard Boolean

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.

The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
frequency Copied to clipboard String

Indicates the frequency of the transaction offered to the payer.

Value must be a member of the following list. The values are case sensitive.
INSTALLMENTIndicates an installment transaction where the payer authorizes you to deduct multiple payments over an agreed period of time for a single purchase.
RECURRINGIndicates a recurring transaction where the payer authorizes you to automatically debit their accounts for bill or invoice payments.
SINGLEIndicates a single transaction where a single payment is used to complete the order.
merchantNote Copied to clipboard String

Your note about this transaction.

Data can consist of any characters
Min length:1
Max length:250
reference Copied to clipboard String

An optional identifier for this transaction.

Data can consist of any characters
Min length:1
Max length:40
userId Copied to clipboard String

The person who initiated this transaction.

For Merchant Administration, the person is identified by their logon name.
Data can consist of any characters
Min length:1
Max length:256

Return Value Copied to clipboard

None