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
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 industry specific data.
The record locator used to access a specific Passenger Name Record (PNR).
The type of charge associated with the transaction.
ADDITIONAL_COLLECTION
Additional CollectionAGENCY_EXCHANGE_ORDER
Agency Exchange OrderAGENCY_GROUP_TICKET
Agency Group TicketAGENCY_MISCELLANEOUS_CHARGE_ORDER
Agency Misc. Charge Order (MCO)AGENCY_PASSENGER_TICKET
Agency Passenger TicketAGENCY_TOUR_ORDER_OR_VOUCHER
Agency Tour Order/VoucherAIR_FREIGHT
SPD/Air FreightANIMAL_TRANSPORTATION_CHARGE
Animal Transportation ChargeCATALOGUE_MERCHANDISE_ORDERED
Catalogue Merchandise OrderedCLUB_MEMBERSHIP_FEE
Club Membership FeeCOUPON_BOOK
Coupon BookCREDIT_CLASS_SERVICE_ADJUSTMENT
Credit Class of Service AdjustmentCREDIT_DENIED_BOARDING
Credit Denied BoardingCREDIT_EXCHANGE_REFUND
Credit Exchange RefundCREDIT_LOST_TICKET_REFUND
Credit Lost Ticket RefundCREDIT_MISCELLANEOUS_REFUND
Credit Misc. RefundCREDIT_MULTIPLE_UNUSED_TICKETS
Credit Multiple Unused TicketsCREDIT_OVERCHARGE_ADJUSTMENT
Credit Overcharge AdjustmentCREDIT_UNUSED_TRANSPORTATION
Credit Unused TransportationDEBT_ADJUSTMENT_DUPLICATE_REFUND_OR_USE
Debt Adjustment Duplicate Refund/UseDUTY_FREE_SALE
Duty Free SaleEXCESS_BAGGAGE
Excess BaggageEXCHANGE_ADJUSTMENT
Exchange AdjustmentEXCHANGE_ORDER
Exchange OrderFIREARMS_CASE
Firearms CaseFREQUENT_FLYER_FEE_OR_PURCHASE
Frequent Flyer Fee/PurchaseFREQUENT_FLYER_FULFILLMENT
Frequent Flyer FulfillmentFREQUENT_FLYER_OVERNIGHT_DELIVERY_CHARGE
Frequent Flyer Overnight Delivery ChargeGROUP_TICKET
Group TicketIN_FLIGHT_ADJUSTMENT
In-flight AdjustmentIN_FLIGHT_CHARGES
In-flight ChargesIN_FLIGHT_DUTY_FREE_PURCHASE
In-flight Duty Free PurchaseIN_FLIGHT_MERCHANDISE_ORDERED
In-flight Merchandise OrderedIN_FLIGHT_PHONE_CHARGES
In-flight Phone ChargesKENNEL_CHARGE
Kennel ChargeLOST_TICKET_APPLICATION
Lost Ticket ApplicationMISCELLANEOUS_CHARGE_ORDER_OR_PREPAID_TICKET_ADVICE
Misc. Charge Order (MCO) / Prepaid Ticket Auth.MISCELLANEOUS_TAXES_FEES
Miscellaneous Tax(es) Fee(s)PASSENGER_TICKET
Passenger TicketSELF_SERVICE_TICKETS
Self-Service Ticket(s)SENIOR_CITIZEN_DISCOUNT_BOOKLETS
Senior Citizen Discount BookletsSMALL_PACKAGE_DELIVERY
Small Package DeliverySPECIAL_SERVICE_TICKET
Special Service TicketSUPPORTED_REFUND
Supported RefundTICKET_BY_MAIL
Ticket by MailTOUR_DEPOSIT
Tour DepositTOUR_ORDER_VOUCHER
Tour Order VoucherUNDERCHARGE_ADJUSTMENT
Undercharge AdjustmentUNSUPPORTED_REFUND
Unsupported RefundUPGRADE_CHARGE
Upgrade ChargeVENDOR_REFUND_CREDIT
Vendor Refund CreditVENDOR_SALE
Vendor SaleItinerary details
Travel leg details.
The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier for the trip leg.
The ticket containing the coupon for this leg for an itinerary with more than four trip legs.
The coupon number on the ticket for the trip leg.
The 3 character IATA airport code of the departure airport for the trip leg.
Date of departure for the trip leg.
Tax payable on departure for the trip leg.
Departure time in local time for the departure airport for this trip leg.
The 3 character IATA airport code for the destination airport for the trip leg.
Arrival date in local time for the destination airport for this trip leg.
Arrival time in local time for the destination airport for this trip leg.
Restrictions (e.g. non-refundable) or endorsements applicable to the trip leg.
New ticket number issued when a ticket is exchanged for the trip leg.
Total fare payable for the trip leg.
Code defining the rules forming the basis of the fare (type of fare, class entitlement, etc.)
Total fees payable for the trip leg.
The flight number for the trip leg.
Indicates if a stopover is permitted for the trip leg.
Total taxes payable for the trip leg.
The industry code indicating the class of service (e.g. Business, Coach) for the leg.
Number of passengers associated with this booking.
The 3 character ISO 3166-1 alpha-3 country code of the country of origin for the itinerary.
Passenger details
First name of the passenger to whom the ticket is being issued.
Frequent Flyer or Loyalty Program number for this passenger.
Last name of the passenger to whom the ticket is being issued.
Middle name of the passenger to whom the ticket is being issued.
Passenger specific information recorded on the ticket.
Title of the passenger to whom the ticket is being issued.
Plan number supplied by the airline for this booking.
Ticket details
Indicates if a conjunction ticket with additional coupons was issued.
Indicates if an electronic ticket was issued.
The original ticket number when this is a transaction for an exchanged ticket.
Ticket issue information.
The address where the ticket was issued.
The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier issuing the ticket.
Name of airline carrier issuing the ticket.
The city/town where the ticket was issued.
The 3 character ISO 3166-1 alpha-3 country code of the country where the ticket was issued.
The date the ticket was issued.
Industry code of the travel agent issuing the ticket.
Name of the travel agent issuing the ticket.
Indicates if the issued ticket is refundable.
The airline ticket number associated with the transaction.
Total fare for all trip legs on the ticket.
Total fee for all trip legs on the ticket.
Total taxes for all trip legs on the ticket.
The type of transaction performed against this airline booking.
EXCHANGE_TICKET
Exchange TicketMISCELLANEOUS_CHARGE
Miscellaneous ChargeREFUND
RefundREVERSAL
ReversalTICKET_PURCHASE
Ticket PurchaseTOUR_ORDER
Tour OrderDetails of the payer's billing address.
The payer's billing address.
The city portion of the address.
The name of the company associated with this address.
The 3 letter ISO standard alpha country code of the address.
The post code or zip code of the address.
The state or province of the address.
The first line of the address.
The second line of the address (if provided).
Information about any constraints that apply to this transaction.
Information about the payment plan constraints which apply for this transaction.
The allowable number of deferral months for the payment plan.
The allowable number of installments for the payment plan.
The identifiers for the payment plans supported for this transaction.
See Payment Plans for the supported payment plans and their identifiers.
Information associated with the customer's source of transaction.
The email address of the customer.
The payer's first name.
The payer's last or surname.
The contact person's mobile phone or cell phone number.
The phone number of the person to whom the order is being billed.
Information associated with the device's source of transaction.
The telephone number captured by ANI (Automatic Number Identification) when the customer calls to place the order.
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.
The mobile phone manufacturer's identifier for the model of the mobile device used to initiate the payment.
Information that controls the payer's checkout interaction.
The property ID for your shop site provided by Google Analytics in the form UA-XXXXX-Y.
A group of objects that control the visibility of, and payer-interaction with, displayed information.
Indicates if you require the payer to provide their billing address during the payment interaction.
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.Indicates if you wish to display a 'Confirm Account Number' field for the ACH Account Number entry.
HIDE
Do not display confirm account number.SHOW
Display confirm account number.Indicates if you require the payer to provide their email address on the payment interaction.
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.Indicates if you wish to display a summary of the order before the payer submits their payment.
HIDE
Do not display order summary.READ_ONLY
Display order summary, which may include payment details.Indicates whether you wish to hide payment terms for a payment plan during the payment interaction.
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.Indicates if you wish to hide the shipping details on the payment interaction.
HIDE
Hides data fields from the payer.READ_ONLY
Data is displayed but cannot be modified.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).
Information that allows you to display your brand and business details during the payment interaction.
Information on your business address.
The first line of your business address for display to the payer during the payment interaction.
The second line of your business address for display to the payer during the payment interaction.
The third line of your business address for display to the payer during the payment interaction.
The fourth line of your business address for display to the payer during the payment interaction.
The email address of your business for display to the payer during the payment interaction (e.g. an email address for customer service).
The URL of your business logo for display to the payer during the payment interaction.
The name of your business for display to the payer on the payment interaction.
The phone number of your business for display to the payer during the payment interaction.
The theme used to control the look and feel of your checkout interaction.
The unique identifier issued to you by your payment provider.
Information about the order associated with this transaction.
A unique identifier for this order to distinguish it from any other order you create.
Indicates whether you will accept a payment less than order.amount, e.g. when using a gift card.
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.
The total amount for the order.
The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Information about this order that is of interest to you.
A note from the payer about this order.
The date the payer placed the order.
The payer's own reference for the order.
Short textual description of the contents of the order.
Your identifier for the part of your organization that is responsible for the order.
Your reference to the contract or agreement you have with the payer to process recurring payments.
The identifier of the order.
The name of the person who requested the goods or services.
The total shipping and handling amount for the order.
Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.
The sub-merchant's address.
The city portion of the address.
The name of the company associated with this address.
The 3 letter ISO standard alpha country code of the address.
The post code or zip code of the address.
The state or province of the address.
The first line of the address.
The second line of the address (if provided).
Code used by acquirer to describe the business or industry the sub-merchant operates in.
The sub-merchant's email address.
Your identifier for the sub-merchant.
The sub-merchant's phone number
The legal name of the sub-merchant.
The trading name of the sub merchant, also known as doing business as (DBA), operating as or trading as.
Use this parameter group to provide a breakdown of tax types, amount per tax type, and rate per tax type included in order.taxAmount.
The tax amount included in this order for the tax type.
The type of tax included in the order amount.
The total tax amount for the order.
If you provide both this value and line item data, then the order.taxAmount MUST equal the total tax amount.
Your tax registration identifier provided by the Federal/National tax authority (for example, federal tax identification number, ABN).
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.
Information relevant to risk assessment.
Details about the recipient of the payment and the destination account for the payment.
The account identifier for the payment recipient's account.
The date of birth of the primary payment recipient in yyyy-mm-dd format.
Last name of the primary payment recipient.
Postcode of the primary payment recipient.
Identifier of the payment session containing values for any of the request fields to be used in this operation.
Use this field to implement optimistic locking of the session content.
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.
Information on the shipping address including the contact details of the addressee.
The address to which the goods contained in this order are being shipped.
The city portion of the address.
The name of the company associated with this address.
The 3 letter ISO standard alpha country code of the address.
The post code or zip code of the address.
The state or province of the address.
The first line of the address.
The second line of the address (if provided).
Details of the contact person at the address the goods will be shipped to.
The contact person's email address.
The first name of the person to whom the order is being shipped.
The last name or surname of the person to whom the order is being shipped.
The contact person's mobile phone or cell phone number.
The phone number of the person to whom the order is being shipped.
The shipping method code to indicate the time frame and the priority of the order.
ELECTRONIC
Electronic delivery.GROUND
Ground (4 or more days).OVERNIGHT
Overnight (next day).PRIORITY
Priority (2-3 days).SAME_DAY
Same day.Information about this transaction.
Additional information to be passed to acquirer.
Additional information requested by the acquirer which cannot be passed using other available data fields.
This is the value provided to the acquirer to identify the order.
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.
Indicates the frequency of the transaction offered to the payer.
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.Your note about this transaction.
An optional identifier for this transaction.
The person who initiated this transaction.
Return Value Copied to clipboard
None