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

Checkout.configure(configuration);

Example 

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

Arguments

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.

agreement Object

A series of related orders that execute one commercial agreement.

For example, linking the orders for a series of recurring payments (a mobile phone subscription), split tenders (one payment using two cards), or when the merchant offers to take payments by a series of installments (hire purchase).

You must provide this data for some types of payments (such as recurring), but you can provide it for any cases where you want to link orders together.
expiryDate String

Date at which your agreement with the payer to process payments expires.

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

Your identifier for the agreement you have with the payer to process payments.

When you collect cards from your payers and store them for later use, you must provide an agreement ID when you use the stored values for:

  • Recurring payments: you have an agreement with the payer that authorizes you to automatically debit their account at agreed intervals for fixed or variable amounts. For example, gym membership, phone bills, or magazine subscriptions.
  • Installment payments: you have an agreement with the payer that authorizes you to process multiple payments over an agreed period of time for a single purchase. For example, the payer purchases an item for $1000 and pays for it in four monthly installments.
  • Unscheduled: you have an agreement with the payer that authorizes you to process future payments when required. For example, the payer authorizes you to process an account top-up transaction for a transit card when the account balance drops below a certain threshold.
When you first establish an agreement with the payer you should also specify the type of agreement in agreement.type.
Data can consist of any characters
Min length:1
Max length:100
recurring Object

Information about agreements for recurring payments.

amountVariability String

Indicates if all the payments within the agreement use the same amount or if the amount differs between the payments.

Value must be a member of the following list. The values are case sensitive.
FIXEDAll payments in the recurring payment agreement have the same amount. Examples include magazine subscriptions or gym memberships.
VARIABLEThe amount for the payments within the recurring payment agreement differs between payments. Examples include usage-based charges like utility or phone bills.
daysBetweenPayments Number

The minimum number of days between payments agreed with the payer under your agreement with them.

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:999
numberOfPayments Number

The number of merchant-initiated payments within the recurring payment agreement.

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:9999
type String

The type of commercial agreement that the payer has with you.

Specify the agreement type when you have provided a value for agreement.id and this payment is the first in a series of payments. The default value is OTHER.

The gateway will use the value you specify for subsequent payments in the series.
Value must be a member of the following list. The values are case sensitive.
INSTALLMENTAn agreement where the payer authorizes the payment for a single purchase to be split into a number of payments processed at agreed intervals. For example, pay for a purchase in six monthly installments.
OTHERAn agreement where the merchant wants to link related payments for any purpose other than processing recurring, installment, or unscheduled payments. For example, split tender payments.
RECURRINGAn agreement where the payer authorizes the merchant to process payments for recurring bills or invoices at agreed intervals (for example, weekly, monthly). The amount might be fixed or variable.
UNSCHEDULEDAn agreement where the payer authorizes the merchant to automatically deduct funds for a payment for an agreed purchase when required (unscheduled). For example, auto top-ups when the account value falls below a threshold.
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
stateProvinceCode String

The three character ISO 3166-2 country subdivision code for the state or province of the address.

Providing this field might improve your payer experience for 3-D Secure payer authentication.
Data can consist of any characters
Min length:1
Max length:3
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
debtRepayment Object

Details about debt repayment transactions.

If your Merchant Category Code is 6012 (Merchandise and Services—Customer Financial Institutions) or 6051 ( (Non-Financial Institutions – Foreign Currency, Non-Fiat Currency)) you may be required to provide some or all the details in this parameter group when submitting a debt repayment transaction.
indicator Boolean

Use this field to indicate if the transaction is for a debt repayment.

If your Merchant Category Code is 6012 (Merchandise and Services—Customer Financial Institutions) or 6051 ( (Non-Financial Institutions – Foreign Currency, Non-Fiat Currency)) you must provide this field when submitting a debt repayment transaction.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
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
country String

The ISO 3166 alpha-3 country code of the payer's country, to be used to present country-specific content to the payer during the interaction.

For a Secure Remote Commerce interaction, the payer's country is used to present country-specific content such as Terms and Conditions and you only need to provide it, if you wish to override the default payer country you have configured for Secure Remove Commerce interactions.

Note that all content, including country-specific content, will be presented in the language based on the payer's locale provided in the interaction.locale field.

Data must consist of the characters A-Z
Min length:3
Max length:3
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
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
url String

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

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

Indicates the operation that you wish to perform during the Hosted Checkout interaction.

Value must be a member of the following list. The values are case sensitive.
AUTHORIZERequest for the Hosted checkout interaction to create Authorization transaction for the payment.
NONEHosted Checkout will collect the payment details from the payer and securely store them against the Hosted Checkout session. No operation will be performed after the payer interaction.
PURCHASERequest for the Hosted checkout interaction to create Purchase transaction for the payment.
VERIFYRequest for the Hosted Checkout interaction to verify the payer's account. The payment details are verified using the verification method supported by the acquirer and the data provided in the request.
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
timeoutUrl String

The URL to which you want to return the payer if the payment is not completed in the allowed time.

This will either be the time you specified in interaction.timeout or the gateway default timeout value.
Data must be an absolute URI conforming to the URI syntax published by IETF RFC 2396. The following schemes are forbidden : javascript
lineOfBusiness String

Your payment service provider might have configured your merchant profile to support several lines of business.

Each line of business can have different payment parameters, such as bank account, supported cards or such.

For example, lineOfBusiness = TICKET_SALES can have a different bank account from lineOfBusiness = MERCHANDISING. One line of business on your profile might be "null". To use that, do not provide the lineOfBusiness field.
Data can consist of any characters except space
Min length:1
Max length:100
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 you create using 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
item Object

Information about the items the payer purchases with the order.

brand String

The brand of the item.

For example, Dell.
Data can consist of any characters
Min length:1
Max length:127
category String

Your category for the item.

Data can consist of any characters
Min length:1
Max length:127
description String

Description for the item with information such as size, color, etc.

For example, 'Color:Red, Size:M'
Data can consist of any characters
Min length:1
Max length:127
industryCategory String

Provide the industry category to send this line item to your acquirer for specialized processing as industry data.

Such processing might have legal obligations, which are your responsibility. Do not provide an industry category, unless you are certain it applies to you, and is accepted by your acquirer.

We support the following industry standard processing:

US health care processing using the IIAS standard.

The supported values for this field are:

HEALTHCARE_VISION, HEALTHCARE_DENTAL, HEALTHCARE_PRESCRIPTION, HEALTHCARE_OTHER

We formulate an IIAS message by summing the amounts of all the line items with the same industry category. The amount of a line item is computed as:

(order.item.unitPrice + order.item.tax) * order.item.quantity
Value must be a member of the following list. The values are case sensitive.
HEALTHCARE_DENTAL
HEALTHCARE_OTHER
HEALTHCARE_PRESCRIPTION
HEALTHCARE_VISION
name String REQUIRED

A short name describing the item.

Data can consist of any characters
Min length:1
Max length:127
quantity Number REQUIRED

The quantity of the item.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number greater than zero.
Min length:0
Max length:30
sku String

The SKU (Stock Keeping Unit) or the item identifier for this item.

Data can consist of any characters
Min length:1
Max length:127
unitPrice Number REQUIRED

The cost price for the item.

This amount is multiplied with the item quantity (item.quantity) to determine the total amount for this item (item.amount). This amount does not include the tax amount and/or discount amount applicable to this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Min length:1
Max length:14
unitTaxAmount Number

The tax amount for the item.

This amount is multiplied with the item quantity (item.quantity) to determine the total tax amount for this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Min length:1
Max length:14
itemAmount Number

The total item 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.unitPrice for all the line items (total item amount).
If you provide both this value and line item data, then the order.itemAmount MUST equal the total item 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
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
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
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
sameAsBilling String

Indicates whether the shipping address provided is the same as the payer's billing address.

Provide this value if you are not providing the full shipping and billing addresses, but you can affirm that they are the same or different.

The default value for this field is:

SAME - if the shipping and billing address are supplied, and all fields are the same (ignoring non-alphanumerics).
DIFFERENT - if the shipping and billing address are supplied, and at least one field is different (ignoring non-alphanumerics).
UNKNOWN - either shipping address or billing address is absent.
Value must be a member of the following list. The values are case sensitive.
DIFFERENTThe shipping and billing addresses are different.
SAMEThe shipping and billing addresses are the same.
UNKNOWNIt is not known if the shipping and billing addresses are the same.
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
source String

How you obtained the shipping address.

Value must be a member of the following list. The values are case sensitive.
ADDRESS_ON_FILEOrder shipped to an address that you have on file.
NEW_ADDRESSOrder shipped to an address provided by the payer for this transaction.
stateProvince String

The state or province of the address.

Data can consist of any characters
Min length:1
Max length:20
stateProvinceCode String

The three character ISO 3166-2 country subdivision code for the state or province of the address.

Providing this field might improve your payer experience for 3-D Secure payer authentication.
Data can consist of any characters
Min length:1
Max length:3
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
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
transit Object

Only use the functionality provided in this parameter group if you are a merchant with a card scheme approved Merchant Category Code for Aggregated Transit Fare Collection functionality.

aggregationStartDate String

Provide this field if you are submitting an aggregated transit fare.

This is the start date of an aggregation and matches the date of the first travel or first tap within the aggregation period.This field is required when transaction.transit.fareCollection is set to AGGREGATION_ACROSS_TRIPS
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
fareCollection String REQUIRED

The Aggregated Transit Fare Collection functionality allows your payers to use their contactless card as both the method of payment as well as their travel ticket.

In this case you will be allowed to aggregate these contactless payments for transit fares within limitations (time periods, amounts) as specified by the card schemes.
Use the field to indicate the purpose of this transaction.
Value must be a member of the following list. The values are case sensitive.
AGGREGATION_ACROSS_TRIPSIndicates a payment where the fare for each journey may not be known at the point of entry into the transit network. Regardless of whether the fare is known or not, tap data is accumulated, and the total fare amount is calculated and charged at the end of the travel period. Also known as Mass Transit Transaction (MTT). When this value is used, transaction.transit.aggregationStartDate must also be supplied.
DEBT_RECOVERYIndicates that you have initiated a payment to collect an outstanding transit fare. The card schemes place limitations on when and how often you can attempt to clear a transit fare debt. transaction.source for this payment must be set to MERCHANT. Do not use this value for payments initiated by the payer to pay off fare debts.
transportationMode String REQUIRED

Provide the transport mode used by the payer for the first trip when fare collection is aggregated across one or more trips as well as on debt recovery transactions.

Value must be a member of the following list. The values are case sensitive.
CABLE_CARCable Car
COACHCoach
COMMUTER_TRAINCommuter Train
EXPRESS_COMMUTER_TRAINExpress Commuter Train
FUNICULAR_TRAINFunicular Train
HIGH_SPEED_TRAINHigh Speed Train
INTERURBAN_BUSInterurban Bus
INTER_CITYInter City
LIGHT_TRAIN_MASS_TRANSITLight Train Mass Transit
LOCOMOTIVELocomotive
OTHEROther
PARA_TRANSITPara Transit
PARKINGParking
POWERED_MOTOR_VEHICLEPowered Motor Vehicle
REGIONAL_TRAINRegional Train
RURAL_BUSRural Bus
SELF_DRIVE_VEHICLESelf Drive Vehicle
TAXITaxi
TOLLToll
TRAILERTrailer
TRAINTrain
URBAN_BUSUrban Bus
WATER_BORNE_VEHICLEWater Borne Vehicle
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

None