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

Airline industry specific data.

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

Itinerary details

leg Object

Travel leg details.

carrierCode

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

Date of departure for the trip leg.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd

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

destinationArrivalDate String

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

Data must comply with ISO 8601 extended date format, yyyy-mm-dd

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

Passenger details

firstName 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

frequentFlyerNumber String

Frequent Flyer or Loyalty Program number for this passenger.

Data can consist of any characters

Min length:1

Max length:20

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

Ticket details

conjunctionTicketIndicator 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.)

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

Ticket issue information.

address String

The address where the ticket was issued.

Data can consist of any characters

Min length:1

Max length:16

carrierCode

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

The date the ticket was issued.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd

travelAgentCode 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 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 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.)

taxOrFee Object

Breakdown of the ticket taxes, airport taxes, charges and fees for an airline ticket purchase.

The total of the amounts in this group should equal the sum of the airline.ticket.totalFees and airline.ticket.totalTaxes fields.

amount Number

The tax, charge or fee amount payable.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.

Min length:1

Max length:14

type String

The tax, charge or fee type code as assigned by IATA.

For example, the IATA tax/ charge/ fee type for Passenger Movement Charge (PMC) in Australia is TT1.

Data may consist of the characters 0-9, a-z, A-Z

Min length:3

Max length:3

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

Details of the payer's billing address.

address Object

The payer's billing address.

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

city String

The city portion of the address.

Data can consist of any characters

Min length:1

Max length:100

company String

The name of the company associated with this address.

Data can consist of any characters

Min length:1

Max length:100

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

The state or province of the address.

Data can consist of any characters

Min length:1

Max length:20

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

The second line of the address (if provided).

Data can consist of any characters

Min length:1

Max length:100

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

Information about the customer, including their contact details.

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

The payer's first name.

Data can consist of any characters

Min length:1

Max length:50

lastName String

The payer's last or surname.

Data can consist of any characters

Min length:1

Max length:50

mobilePhone

The payer's mobile phone or cell phone number in ITU-T E123 format, for example +1 607 1234 5678

The number consists of:

'+'
country code (1, 2 or 3 digits)
'space'
national number ( which may embed single spaces characters for readability).

Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)

Mandatory country code:true

Max total digits:15

phone

The payer's phone number in ITU-T E123 format, for example +1 607 1234 456

The number consists of:

'+'
country code (1, 2 or 3 digits)
'space'
national number ( which may embed single spaces characters for readability).

Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)

Mandatory country code:true

Max total digits:15

device Object

Information about the device used by the payer for this transaction.

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

mobilePhoneModel String

The mobile phone manufacturer's identifier for the model of the mobile device used to initiate the payment.

Data can consist of any characters

Min length:1

Max length:255

interaction Object REQUIRED

Information that controls the payer's checkout interaction.

googleAnalytics Object

propertyId 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

cancelUrl String REQUIRED

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.

Data must be an absolute URI conforming to the URI syntax published by IETF RFC 2396. The following schemes are forbidden : javascript

displayControl Object

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

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

confirmAchAccountNumber String

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.

Value must be a member of the following list. The values are case sensitive.

HIDEDo not display confirm account number.

SHOWDisplay confirm account number.

customerEmail 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 hidden.

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

Value must be a member of the following list. The values are case sensitive.

HIDEDo not display order summary.

SHOWDisplay order summary, which may include payment details.

SHOW_PARTIALDisplay order summary which may not include payment details.

paymentConfirmation String

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.

Value must be a member of the following list. The values are case sensitive.

HIDEDo not display payment confirmation.

SHOWDisplay payment confirmation.

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

shipping String

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.

Value must be a member of the following list. The values are case sensitive.

HIDEHides data fields from the payer.

READ_ONLYData is displayed but cannot be modified.

locale 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 Object REQUIRED

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

address Object

Information on your business address.

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

logo String

The URL of your business logo for display to the payer during the payment interaction.

The URL must be secure (e.g. https://yoursite.com/images/logo.gif). You can resize the image.However, the height must not exceed 140 pixels else it will be cropped. For best results, use images in JPEG or PNG formats with dimensions 140 width × 140 height (pixels).

Data must be an absolute URI conforming to the URI syntax published by IETF RFC 2396. The URI must be one of the following schemes : https

name 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 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 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 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 Object REQUIRED

Information about the order associated with this transaction.

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

The total amount for the order. This is the net amount plus any surcharge.

If you provide any sub-total amounts, then the sum of these amounts (order.itemAmount, order.taxAmount, order.shippingAndHandlingAmount, order.cashbackAmount, order.gratuityAmount), minus the order.discountAmount must equal the net amount.

The value of this field in the response may be zero if payer funds are not transferred.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.

Min length:1

Max length:14

cashAdvance 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.)

certainty String

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

Value must be a member of the following list. The values are case sensitive.

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

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

A note from the payer about this order.

Data can consist of any characters

Min length:1

Max length:250

customerOrderDate String

The date the payer placed the order.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd

customerReference String

The payer's own reference for the order.

This reference may assist the payer to identify the order in their system. For example, a purchase order number, project identifier, or cost center.

Data consists of ASCII characters

Min length:0

Max length:25

description String

Short textual description of the contents of the order.

Data can consist of any characters

Min length:1

Max length:127

merchantCategoryCode Number

A 4-digit code used to classify your business by the type of goods or services it offers.This is also known as the Merchant Category Code (MCC).

You only need to provide the MCC if you want to override the default value configured for your acquirer link.The value you provide must match one of those configured by your payment service provider.

Data is a string that consists of the characters 0-9.

Min length:4

Max length:4

netAmount Number

The amount payable for the order before surcharging is applied.

If you specify a net amount the gateway will calculate the surcharge for you.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.

Min length:1

Max length:14

owningEntity String

Your identifier for the part of your organization that is responsible for the order.

You might provide this data when you want to track the accountability for the order. For example, store number, sales region, branch, or profit center

Data can consist of any characters

Min length:1

Max length:40

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

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

Data can consist of any characters

Min length:1

Max length:100

shippingAndHandlingAmount 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

subMerchant Object

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.

address Object

The sub-merchant's address.

city String

The city portion of the address.

Data can consist of any characters

Min length:1

Max length:100

company String

The name of the company associated with this address.

Data can consist of any characters

Min length:1

Max length:100

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

The state or province of the address.

Data can consist of any characters

Min length:1

Max length:20

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

The second line of the address (if provided).

Data can consist of any characters

Min length:1

Max length:100

bankIndustryCode Number

Code used by acquirer to describe the business or industry the sub-merchant operates in.

Data is a string that consists of the characters 0-9.

Min length:4

Max length:4

email String

The sub-merchant's email address.

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

identifier String

Your identifier for the sub-merchant.

You can use this identifier in searches and reports in the gateway.

Data can consist of any characters

Min length:1

Max length:100

phone String

The sub-merchant's phone number

Data can consist of any characters

Min length:1

Max length:20

registeredName String

The legal name of the sub-merchant.

Data can consist of any characters

Min length:1

Max length:100

tradingName String

The trading name of the sub merchant, also known as doing business as (DBA), operating as or trading as.

For MasterCard transactions the name must not exceed 21 characters. For American Express transactions the name must not exceed 27 characters (or 36 characters including the aggregator name). The trading name may be displayed on the payer's cardholder statement. Therefore if you need to shorten it, use an abbreviation that will be meaningful to the payer when displayed on their statement.

Data can consist of any characters

Min length:1

Max length:100

tax Object

Use this parameter group to provide a breakdown of tax types, amount per tax type, and rate per tax type included in order.taxAmount.

amount Number

The tax amount included in this order for the tax type.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.

Min length:1

Max length:14

type String

The type of tax included in the order amount.

The correct value as used by your acquirer may have to be provided. Contact your payment service provider for details.

Data can consist of any characters

Min length:1

Max length:50

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

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 String

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

If you are a Canadian merchant, use this field to provide your Tax Registration ID for paying Harmonized Sales Tax (HST) or Goods and Services Tax (GST) collected by the Canada Revenue Agency.

Data can consist of any characters

Min length:1

Max length:30

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

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

Shipping information for this order.

address Object

The address to which this order will be shipped.

city String

The city portion of the address.

Data can consist of any characters

Min length:1

Max length:100

company String

The name of the company associated with this address.

Data can consist of any characters

Min length:1

Max length:100

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

The state or province of the address.

Data can consist of any characters

Min length:1

Max length:20

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

The second line of the address (if provided).

Data can consist of any characters

Min length:1

Max length:100

contact Object

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

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

The contact person's mobile phone or cell phone number in ITU-T E123 format, for example +1 607 1234 5678

The number consists of:

'+'
country code (1, 2 or 3 digits)
'space'
national number ( which may embed single spaces characters for readability).

Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)

Mandatory country code:true

Max total digits:15

phone

The contact person's phone number in ITU-T E123 format, for example +1 607 1234 456

The number consists of:

'+'
country code (1, 2 or 3 digits)
'space'
national number ( which may embed single spaces characters for readability).

Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)

Mandatory country code:true

Max total digits:15

method String

The shipping method used for delivery of this order.

Value must be a member of the following list. The values are case sensitive.

ELECTRONICElectronic delivery.

GROUNDGround (4 or more days).

NOT_SHIPPEDOrder for goods that are not shipped (for example, travel and event tickets)

OVERNIGHTOvernight (next day).

PICKUPShipped to a local store for pick up.

PRIORITYPriority (2-3 days).

SAME_DAYSame day.

transaction Object

Information about this transaction.

acquirer Object

Additional information to be passed to acquirer.

customData 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

transactionId String

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

Data can consist of any characters, but sensitive data will be rejected

Min length:1

Max length:100

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

Your note about this transaction.

Data can consist of any characters

Min length:1

Max length:250

reference String

An optional identifier for this transaction.

Data can consist of any characters

Min length:1

Max length:40

userId 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