configure()
The configure function is used to prepare the Checkout library for a payment. It must be called before either showEmbeddedPage() or showPaymentPage() to store payment details.
Usage
Checkout.configure(configuration);
Example
Checkout.configure({ session: { id: '<your_session_id>' } });
Arguments
configuration
Object
COMPULSORY
The configuration object describes the merchant, customer, payment, and checkout appearance and behaviour. Fields in the object can contain literal values or a function that returns the value. Functions will be invoked before showing the payment interface.
Validation problems with the configuration object will be delivered to the error callback.
agreement Object = OPTIONAL
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.
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.
Fixed value
expiryDate String = OPTIONAL
Date at which your agreement with the payer to process payments expires.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
id String = OPTIONAL
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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
recurring Object = OPTIONAL
Information about agreements for recurring payments.
Fixed value
amountVariability String = OPTIONAL
Indicates if all the payments within the agreement use the same amount or if the amount differs between the payments.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
FIXED
All payments in the recurring payment agreement have the same amount. Examples include magazine subscriptions or gym memberships.
VARIABLE
The amount for the payments within the recurring payment agreement differs between payments. Examples include usage-based charges like utility or phone bills.
daysBetweenPayments Number = OPTIONAL
The minimum number of days between payments agreed with the payer under your agreement with them.
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
minimum value
1
maximum value
999
numberOfPayments Number = OPTIONAL
The number of merchant-initiated payments within the recurring payment agreement.
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
minimum value
1
maximum value
9999
type String = OPTIONAL
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.
The gateway will use the value you specify for subsequent payments in the series.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
INSTALLMENT
An 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.
OTHER
An 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.
RECURRING
An 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.
UNSCHEDULED
An 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.
airline Object = OPTIONAL
Airline industry specific data.
Fixed value
bookingReference String = OPTIONAL
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.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
6
maximum length
15
documentType String = OPTIONAL
The type of charge associated with the transaction.
Fixed value
Validation Rules
Document Type Code
Value must be a member of the following list. The values are case sensitive.
ADDITIONAL_COLLECTION
Additional Collection
AGENCY_EXCHANGE_ORDER
Agency Exchange Order
AGENCY_GROUP_TICKET
Agency Group Ticket
AGENCY_MISCELLANEOUS_CHARGE_ORDER
Agency Misc. Charge Order (MCO)
AGENCY_PASSENGER_TICKET
Agency Passenger Ticket
AGENCY_TOUR_ORDER_OR_VOUCHER
Agency Tour Order/Voucher
AIR_FREIGHT
SPD/Air Freight
ANIMAL_TRANSPORTATION_CHARGE
Animal Transportation Charge
CATALOGUE_MERCHANDISE_ORDERED
Catalogue Merchandise Ordered
CLUB_MEMBERSHIP_FEE
Club Membership Fee
COUPON_BOOK
Coupon Book
CREDIT_CLASS_SERVICE_ADJUSTMENT
Credit Class of Service Adjustment
CREDIT_DENIED_BOARDING
Credit Denied Boarding
CREDIT_EXCHANGE_REFUND
Credit Exchange Refund
CREDIT_LOST_TICKET_REFUND
Credit Lost Ticket Refund
CREDIT_MISCELLANEOUS_REFUND
Credit Misc. Refund
CREDIT_MULTIPLE_UNUSED_TICKETS
Credit Multiple Unused Tickets
CREDIT_OVERCHARGE_ADJUSTMENT
Credit Overcharge Adjustment
CREDIT_UNUSED_TRANSPORTATION
Credit Unused Transportation
DEBT_ADJUSTMENT_DUPLICATE_REFUND_OR_USE
Debt Adjustment Duplicate Refund/Use
DUTY_FREE_SALE
Duty Free Sale
EXCESS_BAGGAGE
Excess Baggage
EXCHANGE_ADJUSTMENT
Exchange Adjustment
EXCHANGE_ORDER
Exchange Order
FIREARMS_CASE
Firearms Case
FREQUENT_FLYER_FEE_OR_PURCHASE
Frequent Flyer Fee/Purchase
FREQUENT_FLYER_FULFILLMENT
Frequent Flyer Fulfillment
FREQUENT_FLYER_OVERNIGHT_DELIVERY_CHARGE
Frequent Flyer Overnight Delivery Charge
GROUP_TICKET
Group Ticket
IN_FLIGHT_ADJUSTMENT
In-flight Adjustment
IN_FLIGHT_CHARGES
In-flight Charges
IN_FLIGHT_DUTY_FREE_PURCHASE
In-flight Duty Free Purchase
IN_FLIGHT_MERCHANDISE_ORDERED
In-flight Merchandise Ordered
IN_FLIGHT_PHONE_CHARGES
In-flight Phone Charges
KENNEL_CHARGE
Kennel Charge
LOST_TICKET_APPLICATION
Lost Ticket Application
MISCELLANEOUS_CHARGE_ORDER_OR_PREPAID_TICKET_ADVICE
Misc. Charge Order (MCO) / Prepaid Ticket Auth.
MISCELLANEOUS_TAXES_FEES
Miscellaneous Tax(es) Fee(s)
PASSENGER_TICKET
Passenger Ticket
SELF_SERVICE_TICKETS
Self-Service Ticket(s)
SENIOR_CITIZEN_DISCOUNT_BOOKLETS
Senior Citizen Discount Booklets
SMALL_PACKAGE_DELIVERY
Small Package Delivery
SPECIAL_SERVICE_TICKET
Special Service Ticket
SUPPORTED_REFUND
Supported Refund
TICKET_BY_MAIL
Ticket by Mail
TOUR_DEPOSIT
Tour Deposit
TOUR_ORDER_VOUCHER
Tour Order Voucher
UNDERCHARGE_ADJUSTMENT
Undercharge Adjustment
UNSUPPORTED_REFUND
Unsupported Refund
UPGRADE_CHARGE
Upgrade Charge
VENDOR_REFUND_CREDIT
Vendor Refund Credit
VENDOR_SALE
Vendor Sale
itinerary Object = OPTIONAL
Itinerary details
Fixed value
leg Object = OPTIONAL
Travel leg details.
Fixed value
carrierCode = OPTIONAL
The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier for the trip leg.
Fixed value
Validation Rules
Data must match regex
regex
\w{2}|\d{3}|\w{2}/\d{3}
conjunctionTicketNumber String = OPTIONAL
The ticket containing the coupon for this leg for an itinerary with more than four trip legs.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
11
maximum length
16
couponNumber String = OPTIONAL
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.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
1
departureAirport String = OPTIONAL
The 3 character IATA airport code of the departure airport for the trip leg.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3
departureDate String = OPTIONAL
Date of departure for the trip leg.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
departureTax Number = OPTIONAL
Tax payable on departure for the trip leg.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
departureTime String = OPTIONAL
Departure time in local time for the departure airport for this trip leg.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended time formats, hh:mm[:ss]Z or hh:mm[:ss](+/-)hh[:mm]
destinationAirport String = OPTIONAL
The 3 character IATA airport code for the destination airport for the trip leg.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3
destinationArrivalDate String = OPTIONAL
Arrival date in local time for the destination airport for this trip leg.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
destinationArrivalTime String = OPTIONAL
Arrival time in local time for the destination airport for this trip leg.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended time formats, hh:mm[:ss]Z or hh:mm[:ss](+/-)hh[:mm]
endorsementsRestrictions String = OPTIONAL
Restrictions (e.g. non-refundable) or endorsements applicable to the trip leg.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
20
exchangeTicketNumber String = OPTIONAL
New ticket number issued when a ticket is exchanged for the trip leg.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
11
maximum length
16
fare Number = OPTIONAL
Total fare payable for the trip leg.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
fareBasis String = OPTIONAL
Code defining the rules forming the basis of the fare (type of fare, class entitlement, etc.)
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
24
fees Number = OPTIONAL
Total fees payable for the trip leg.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
flightNumber String = OPTIONAL
The flight number for the trip leg.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
4
maximum length
6
stopoverPermitted Boolean = OPTIONAL
Indicates if a stopover is permitted for the trip leg.
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
taxes Number = OPTIONAL
Total taxes payable for the trip leg.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
travelClass String = OPTIONAL
The industry code indicating the class of service (e.g. Business, Coach) for the leg.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
3
numberInParty Number = OPTIONAL
Number of passengers associated with this booking.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
minimum length
1
maximum length
3
originCountry String = OPTIONAL
The 3 character ISO 3166-1 alpha-3 country code of the country of origin for the itinerary.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3
passenger Object = OPTIONAL
Passenger details
Fixed value
firstName String = OPTIONAL
First name of the passenger to whom the ticket is being issued.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
frequentFlyerNumber String = OPTIONAL
Frequent Flyer or Loyalty Program number for this passenger.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20
lastName String = OPTIONAL
Last name of the passenger to whom the ticket is being issued.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20
middleName String = OPTIONAL
Middle name of the passenger to whom the ticket is being issued.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
specificInformation String = OPTIONAL
Passenger specific information recorded on the ticket.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
59
title String = OPTIONAL
Title of the passenger to whom the ticket is being issued.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20
planNumber String = OPTIONAL
Plan number supplied by the airline for this booking.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
2
maximum length
2
ticket Object = OPTIONAL
Ticket details
Fixed value
conjunctionTicketIndicator Boolean = OPTIONAL
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.
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
eTicket Boolean = OPTIONAL
Indicates if an electronic ticket was issued.
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
exchangedTicketNumber String = OPTIONAL
The original ticket number when this is a transaction for an exchanged ticket.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
11
maximum length
16
issue Object = OPTIONAL
Ticket issue information.
Fixed value
address String = OPTIONAL
The address where the ticket was issued.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
16
carrierCode = OPTIONAL
The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier issuing the ticket.
Fixed value
Validation Rules
Data must match regex
regex
\w{2}|\d{3}|\w{2}/\d{3}
carrierName String = OPTIONAL
Name of airline carrier issuing the ticket.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
25
city String = OPTIONAL
The city/town where the ticket was issued.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
18
country String = OPTIONAL
The 3 character ISO 3166-1 alpha-3 country code of the country where the ticket was issued.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3
date String = OPTIONAL
The date the ticket was issued.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
travelAgentCode String = OPTIONAL
Industry code of the travel agent issuing the ticket.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
8
maximum length
9
travelAgentName String = OPTIONAL
Name of the travel agent issuing the ticket.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
30
restricted Boolean = OPTIONAL
Indicates if the issued ticket is refundable.
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
taxOrFee Object = OPTIONAL
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.
Fixed value
amount Number = OPTIONAL
The tax, charge or fee amount payable.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
type String = OPTIONAL
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.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
3
maximum length
3
ticketNumber String = OPTIONAL
The airline ticket number associated with the transaction.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
11
maximum length
16
totalFare Number = OPTIONAL
Total fare for all trip legs on the ticket.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
totalFees Number = OPTIONAL
Total fee for all trip legs on the ticket.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
totalTaxes Number = OPTIONAL
Total taxes for all trip legs on the ticket.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
transactionType String = OPTIONAL
The type of transaction performed against this airline booking.
Fixed value
Validation Rules
Transaction Type
Value must be a member of the following list. The values are case sensitive.
EXCHANGE_TICKET
Exchange Ticket
MISCELLANEOUS_CHARGE
Miscellaneous Charge
REFUND
Refund
REVERSAL
Reversal
TICKET_PURCHASE
Ticket Purchase
TOUR_ORDER
Tour Order
authentication Object = OPTIONAL
Information about how the payer's identity is verified.
For example, using 3-D Secure authentication.
This parameter group include payer authentication options available to you, parameters you need to perform payer authentication for an available method, and the results of payer authentication.
This parameter group include payer authentication options available to you, parameters you need to perform payer authentication for an available method, and the results of payer authentication.
Fixed value
3ds Object = OPTIONAL
Information about payer authentication using 3-D Secure authentication.
Only provide these fields if you authenticated the payer using a different 3-D Secure service provider. If you authenticated the payer using the gateway, then provide authentication.transactionId instead.
Parameters in this group apply to both 3-D Secure authentication version 1 and 3-D Secure Authentication version 2.
Depending on the 3-D Secure authentication version applicable you will also need additional parameters:
- 3-D Secure authentication version 1: see the authentication.3ds1 parameter group.
- 3-D Secure authentication version 2: see the authentication.3ds2 parameter group.
Parameters in this group apply to both 3-D Secure authentication version 1 and 3-D Secure Authentication version 2.
Depending on the 3-D Secure authentication version applicable you will also need additional parameters:
- 3-D Secure authentication version 1: see the authentication.3ds1 parameter group.
- 3-D Secure authentication version 2: see the authentication.3ds2 parameter group.
Fixed value
acsEci String = OPTIONAL
Indicates the security level of the transaction.
This is the Electronic Commerce Indicator (ECI) value provided by the issuer's Access Control Server (ACS) to indicate the results of the attempt to authenticate the payer.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
1
maximum length
2
authenticationToken = OPTIONAL
The base64 encoded value generated by the issuer.
The authentication token Included in subsequent transaction request messages and used by the card scheme to verify that the authentication occurred and the values provided are valid. The token should be used unaltered.
For 3DS version 1, this field corresponds to the Cardholder Authentication Verification Value (CAVV) for Visa, the Accountholder Authentication Value (AAV) for MasterCard and JCB, or the American Express Verification Value (AEVV) for American Express.
For 3DS version 2, this field corresponds to the Authentication Value.
For 3DS version 2, this field corresponds to the Authentication Value.
Fixed value
Validation Rules
Data is Base64 encoded
allowable lengths
28 or 32
transactionId String = OPTIONAL
A unique identifier for the 3-D Secure authentication transaction.
For 3DS version 1, this field corresponds to the XID. The XID is an identifier generated by the gateway on behalf of the merchant.
For 3DS version 2, this field corresponds to the identifier assigned by the scheme directory server.
This identifier should be used in subsequent operation requests unaltered.
An XID submitted in this field must be in base64 format.
For 3DS version 2, this field corresponds to the identifier assigned by the scheme directory server.
This identifier should be used in subsequent operation requests unaltered.
An XID submitted in this field must be in base64 format.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
3ds1 Object = OPTIONAL
Information about payer authentication using 3-D Secure authentication version 1.
Only provide these fields if you authenticated the payer using a different 3-D Secure service provider. If you authenticated the payer using the gateway, then provide authentication.transactionId instead.
Fixed value
paResStatus = OPTIONAL
Indicates the result of payer authentication with the issuer.
This is the value returned in the transaction status field of the Payer Authentication Response (PARes) message from the card Issuer's Access Control Server (ACS). For example, Y, N, A, or U.
Refer to the relevant documentation for Mastercard SecureCode™, Verified by Visa™, JCB J/Secure™, American Express SafeKey™, or Diners Club ProtectBuy™.
Fixed value
Validation Rules
Data may consist of the characters a-z, A-Z
minimum length
1
maximum length
1
veResEnrolled = OPTIONAL
Indicates whether or not payer authentication is available for the card number you provided.
This is for experts only - most users should use the response.gatewayRecommendation field.
This is the value returned in the 'enrolled' field of the Verify Enrollment Response (VERes) message from the card scheme's Directory Server. For example, Y, N, or U. Refer to the relevant documentation for Mastercard SecureCode™, Verified by Visa™, JCB J/Secure™, American Express SafeKey™, or Diners Club ProtectBuy™.
This is the value returned in the 'enrolled' field of the Verify Enrollment Response (VERes) message from the card scheme's Directory Server. For example, Y, N, or U. Refer to the relevant documentation for Mastercard SecureCode™, Verified by Visa™, JCB J/Secure™, American Express SafeKey™, or Diners Club ProtectBuy™.
Fixed value
Validation Rules
Data may consist of the characters a-z, A-Z
minimum length
1
maximum length
1
3ds2 Object = OPTIONAL
Information about payer authentication using 3-D Secure authentication version 2.
Only provide these fields if you authenticated the payer using a different 3-D Secure service provider. If you authenticated the payer using the gateway, then provide authentication.transactionId instead.
Fixed value
protocolVersion String = OPTIONAL
The version of the EMV 3-D Secure protocol used to perform 3-D Secure authentication, in the format specified by EMVCo.
For example, 2.1.0
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '.'
minimum length
1
maximum length
20
statusReasonCode String = OPTIONAL
A code indicating the reason for the transaction status returned in authentication.3ds2.transactionStatus.
Refer to the EMVCo specification for 3-D Secure.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
2
maximum length
2
transactionStatus = OPTIONAL
Indicates the result of payer authentication with the issuer.
This is the value returned in the transaction status field from the issuer's Access Control Server (ACS). For example, Y, N, U, A, R
Refer to the EMVCo specification for 3-D Secure.
Refer to the EMVCo specification for 3-D Secure.
Fixed value
Validation Rules
Data may consist of the characters a-z, A-Z
minimum length
1
maximum length
1
psd2 Object = OPTIONAL
This parameter group is only applicable if you are subject to the Regulatory Technical Standards (RTS) requirements for Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2) regulations in the European Economic Area.
It provides details about SCA exemptions under PSD2.
Fixed value
exemption String = OPTIONAL
Indicates why this payment qualifies for exemption from Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2).
Note:
- For recurring payments provide the RECURRING_PAYMENT value only if the amount is the same. If the amount varies, provide MERCHANT_INITIATED_TRANSACTION instead.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
LOW_RISK
Exemption is claimed because the acquirer has a low fraud rate.
LOW_VALUE_PAYMENT
Exemption is claimed as the amount is below 30 Euro.
MERCHANT_INITIATED_TRANSACTION
The transaction is excluded as it was initiated by the merchant based on an agreement with the payer. For example, a recurring payment (for a varied or fixed amount), installment payment, or account top-up. In these cases, the payer is not present and cannot participate in an authentication interaction. Merchant initiated transactions are only applicable to subsequent transactions on the order and are out of scope of the PSD2 RTS on Strong Customer Authentication (SCA). The payer must be authenticated during the first transaction that established the agreement.
NONE
An exemption is not claimed for this transaction. The merchant requires Strong Customer Authentication (SCA) be performed.
RECURRING_PAYMENT
The transaction is exempt as it was initiated by the merchant based on an agreement with the payer for a recurring payment for a fixed amount. This value is only applicable to subsequent transactions on the order. In this case, the payer is not present and cannot participate in an authentication interaction. The payer must be authenticated during the first transaction that established the agreement.
SECURE_CORPORATE_PAYMENT
The transaction is exempt as it is a corporate or Business-to-Business (B2B) payment performed using dedicated payment processes and protocols that are not available to consumers and offer at least equivalent security levels.
WHITELISTED_MERCHANT
The transaction is exempt because the payer has added you to the list of their trusted merchants (as maintained by the issuer).
transactionId String = OPTIONAL
The transactionId you used for the Initiate Authentication operation.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40
billing Object = OPTIONAL
Details of the payer's billing address.
Fixed value
address Object = OPTIONAL
The payer's billing address.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value
city String = OPTIONAL
The city portion of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
company String = OPTIONAL
The name of the company associated with this address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
country String = OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3
postcodeZip String = OPTIONAL
The post code or zip code of the address.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
minimum length
1
maximum length
10
stateProvince String = OPTIONAL
The state or province of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20
stateProvinceCode String = OPTIONAL
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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
3
street String = OPTIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
street2 String = OPTIONAL
The second line of the address (if provided).
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
constraints Object = OPTIONAL
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).
Fixed value
paymentPlans Object = OPTIONAL
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.
Fixed value
numberOfDeferrals Number = OPTIONAL
The allowable number of deferral months for the payment plan.
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
minimum value
0
maximum value
99
numberOfPayments Number = OPTIONAL
The allowable number of installments for the payment plan.
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
minimum value
1
maximum value
99
supported String = OPTIONAL
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.
See Payment Plans for the supported payment plans and their identifiers.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40
cruise Object = OPTIONAL
Cruise industry data.
Fixed value
bookingReference String = OPTIONAL
The cruise booking reference.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
12
company Object = OPTIONAL
Information about the cruise line.
Fixed value
address Object = OPTIONAL
Address of the cruise line.
Fixed value
city String = OPTIONAL
The city portion of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
country String = OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3
postCodeZip String = OPTIONAL
The post code or zip code of the address.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
minimum length
1
maximum length
10
stateProvince String = OPTIONAL
The state or province of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20
street String = OPTIONAL
The first line of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
street2 String = OPTIONAL
The second line of the address (if provided).
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
contact Object = OPTIONAL
Contact details of the cruise line.
Fixed value
companyPhone = OPTIONAL
The cruise line registered office telephone number in ITU-T E123 format.
Fixed value
Validation Rules
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
maximum total digits
15
customerServicePhone = OPTIONAL
The customer service phone number in ITU-T E123 format.
Fixed value
Validation Rules
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
maximum total digits
15
departureDate String = OPTIONAL
The cruise departure/ sail date.
This field is required when cruise industry data is provided.
This field is required when cruise industry data is provided.
The value entered must be equal to or earlier than cruise.returnDate.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
passenger Object = OPTIONAL
Cruise passenger details.
Fixed value
firstName String = OPTIONAL
The first name of the passenger.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
folioNumber String = OPTIONAL
The folio number assigned to the passenger.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
30
lastName String = OPTIONAL
The last name of the passenger.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
middleName String = OPTIONAL
The middle name of the passenger.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
title String = OPTIONAL
The title of the passenger.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
returnDate String = OPTIONAL
The cruise return/ sail end date.
This field is required when cruise.departureDate is provided and the value must be equal to or later than cruise.departureDate.
This field is required when cruise.departureDate is provided and the value must be equal to or later than cruise.departureDate.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
shipName String = OPTIONAL
The name of the cruise ship.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
travelAgentCode String = OPTIONAL
The industry code of the travel agent booking the cruise.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
minimum length
8
maximum length
9
travelAgentName String = OPTIONAL
The name of the travel agent booking the cruise.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
30
travelPackageItems = OPTIONAL
A comma separated list of the travel items that are included as part of a cruise travel package.
If the value CRUISE_ONLY is provided then other items are not permitted in the list.
If the value CRUISE_ONLY is provided then other items are not permitted in the list.
Fixed value
Validation Rules
Value must be one or more comma separated members of the following list. The values are case sensitive.
CAR_RENTAL
Car rental is included in the travel package.
CRUISE_ONLY
No additional items are included in the cruise travel package.
FLIGHT
Flights are included in the travel package.
customer Object = OPTIONAL
Information about the customer, including their contact details.
Fixed value
email String = OPTIONAL
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.
Fixed value
Validation Rules
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
firstName String = OPTIONAL
The payer's first name.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
lastName String = OPTIONAL
The payer's last or surname.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
mobilePhone = OPTIONAL
The payer's mobile phone or cell phone number in ITU-T E123 format, for example +1 607 1234 5678
The number consists of:
The number consists of:
- ‘+’
- country code (1, 2 or 3 digits)
- ‘space’
- national number ( which may embed single spaces characters for readability).
Fixed value
Validation Rules
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
maximum total digits
15
phone = OPTIONAL
The payer's phone number in ITU-T E123 format, for example +1 607 1234 456
The number consists of:
The number consists of:
- ‘+’
- country code (1, 2 or 3 digits)
- ‘space’
- national number ( which may embed single spaces characters for readability).
Fixed value
Validation Rules
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
maximum total digits
15
debtRepayment Object = OPTIONAL
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.
Fixed value
indicator Boolean = OPTIONAL
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.
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
device Object = OPTIONAL
Information about the device used by the payer for this transaction.
Fixed value
ani String = OPTIONAL
The telephone number captured by ANI (Automatic Number Identification) when the customer calls to place the order.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
10
aniCallType String = OPTIONAL
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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
2
mobilePhoneModel String = OPTIONAL
The mobile phone manufacturer's identifier for the model of the mobile device used to initiate the payment.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
255
interaction Object = COMPULSORY
Information that controls the payer's checkout interaction.
Fixed value
googleAnalytics Object = OPTIONAL
Fixed value
propertyId String = OPTIONAL
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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20
country String = OPTIONAL
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.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3
displayControl Object = OPTIONAL
A group of objects that control the visibility of, and payer-interaction with, displayed information.
Fixed value
billingAddress String = OPTIONAL
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.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Hides data fields from the payer.
MANDATORY
Displays data fields and allows the payer to enter data into these fields.
OPTIONAL
Displays data fields and allows the payer to opt out of data entry for these fields.
READ_ONLY
Data is displayed but cannot be modified.
confirmAchAccountNumber String = OPTIONAL
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.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Do not display confirm account number.
SHOW
Display confirm account number.
customerEmail String = OPTIONAL
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.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Hides data fields from the payer.
MANDATORY
Displays data fields and allows the payer to enter data into these fields.
OPTIONAL
Displays data fields and allows the payer to opt out of data entry for these fields.
READ_ONLY
Data is displayed but cannot be modified.
orderSummary String = OPTIONAL
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.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Do not display order summary.
SHOW
Display order summary, which may include payment details.
SHOW_PARTIAL
Display order summary which may not include payment details.
paymentConfirmation String = OPTIONAL
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.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Do not display payment confirmation.
SHOW
Display payment confirmation.
paymentTerms String = OPTIONAL
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.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Hides the payment terms from the payer. Note that offering Plan AMEX in some regions may require you to inform the payer of the payment terms before processing the payment.
SHOW_IF_SUPPORTED
Displays the payment terms, if available, to the payer.
shipping String = OPTIONAL
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.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HIDE
Hides data fields from the payer.
READ_ONLY
Data is displayed but cannot be modified.
locale String = OPTIONAL
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.
Fixed value
Validation Rules
Data must be a language identifier or IETF language tag
minimum length
2
maximum length
5
merchant Object = COMPULSORY
Information that allows you to display your brand and business details during the payment interaction.
Fixed value
address Object = OPTIONAL
Information on your business address.
Fixed value
line1 String = OPTIONAL
The first line of your business address for display to the payer during the payment interaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100
line2 String = OPTIONAL
The second line of your business address for display to the payer during the payment interaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100
line3 String = OPTIONAL
The third line of your business address for display to the payer during the payment interaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100
line4 String = OPTIONAL
The fourth line of your business address for display to the payer during the payment interaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100
email String = OPTIONAL
The email address of your business for display to the payer during the payment interaction (e.g. an email address for customer service).
Fixed value
Validation Rules
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
logo String = OPTIONAL
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).
Fixed value
Validation Rules
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 = COMPULSORY
The name of your business for display to the payer on the payment interaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40
phone String = OPTIONAL
The phone number of your business for display to the payer during the payment interaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
20
url String = OPTIONAL
The URL of your business for display to the payer during the payment interaction.
Fixed value
Validation Rules
Data must be an absolute URI conforming to the URI syntax published by IETF RFC 2396. The following schemes are forbidden : javascript
operation String = COMPULSORY
Indicates the operation that you wish to perform during the Hosted Checkout interaction.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
AUTHORIZE
Request for the Hosted checkout interaction to create Authorization transaction for the payment.
NONE
Hosted 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.
PURCHASE
Request for the Hosted checkout interaction to create Purchase transaction for the payment.
VERIFY
Request 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 = OPTIONAL
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.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
minimum length
1
maximum length
50
timeoutUrl String = OPTIONAL
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.
Fixed value
Validation Rules
Data must be an absolute URI conforming to the URI syntax published by IETF RFC 2396. The following schemes are forbidden : javascript
merchant String = COMPULSORY
The unique identifier issued to you by your payment provider.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
minimum length
1
maximum length
40
order Object = COMPULSORY
Information about the order associated with this transaction.
Fixed value
id String = OPTIONAL
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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40
amount Number = OPTIONAL
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.
The value of this field in the response may be zero if payer funds are not transferred.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
cashAdvance Boolean = OPTIONAL
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.
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
certainty String = OPTIONAL
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
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
ESTIMATED
The 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.
FINAL
The 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 = COMPULSORY
The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3
custom String = OPTIONAL
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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
250
customerNote String = OPTIONAL
A note from the payer about this order.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
250
customerOrderDate String = OPTIONAL
The date the payer placed the order.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd.
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
customerReference String = OPTIONAL
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.
Fixed value
Validation Rules
Data consists of ASCII characters
minimum length
0
maximum length
25
description String = OPTIONAL
Short textual description of the contents of the order.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
127
merchantCategoryCode Number = OPTIONAL
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.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
minimum length
4
maximum length
4
netAmount Number = OPTIONAL
The amount payable for the order before surcharging is applied.
If you specify a net amount the gateway will calculate the surcharge for you.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
owningEntity String = OPTIONAL
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
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40
reference String = OPTIONAL
The identifier of the order.
For example, a shopping cart number, an order number, or an invoice number.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40
requestorName String = OPTIONAL
The name of the person who requested the goods or services.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
shippingAndHandlingAmount Number = OPTIONAL
The total shipping and handling amount for the order.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
tax Object = OPTIONAL
Use this parameter group to provide a breakdown of tax types, amount per tax type, and rate per tax type included in order.taxAmount.
Fixed value
amount Number = OPTIONAL
The tax amount included in this order for the tax type.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
type String = OPTIONAL
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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
taxAmount Number = OPTIONAL
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.
If you provide both this value and line item data, then the order.taxAmount MUST equal the total tax amount.
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
minimum length
1
maximum length
14
taxRegistrationId String = OPTIONAL
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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
30
partnerSolutionId String = OPTIONAL
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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40
session Object = OPTIONAL
Fixed value
id String = OPTIONAL
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.
Fixed value
Validation Rules
Data consists of ASCII characters
minimum length
31
maximum length
35
version String = OPTIONAL
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.
To use optimistic locking, record session.version when you make your decisions, and then pass that value in session.version when you submit your request operation to the gateway.
If session.version provided by you does not match that stored against the session, the gateway will reject the operation with error.cause=INVALID_REQUEST.
See Making Business Decisions Based on Session Content.
Fixed value
Validation Rules
Data consists of ASCII characters
minimum length
10
maximum length
10
shipping Object = OPTIONAL
Shipping information for this order.
Fixed value
address Object = OPTIONAL
Fixed value
sameAsBilling String = OPTIONAL
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.
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.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
DIFFERENT
The shipping and billing addresses are different.
SAME
The shipping and billing addresses are the same.
UNKNOWN
It is not known if the shipping and billing addresses are the same.
address Object = OPTIONAL
The address to which this order will be shipped.
Fixed value
city String = OPTIONAL
The city portion of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
company String = OPTIONAL
The name of the company associated with this address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
country String = OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3
postcodeZip String = OPTIONAL
The post code or zip code of the address.
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
minimum length
1
maximum length
10
source String = OPTIONAL
How you obtained the shipping address.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
ADDRESS_ON_FILE
Order shipped to an address that you have on file.
NEW_ADDRESS
Order shipped to an address provided by the payer for this transaction.
stateProvince String = OPTIONAL
The state or province of the address.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20
stateProvinceCode String = OPTIONAL
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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
3
street String = OPTIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
street2 String = OPTIONAL
The second line of the address (if provided).
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100
contact Object = OPTIONAL
Details of the contact person at the address the goods will be shipped to.
Fixed value
email String = OPTIONAL
The 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.
Fixed value
Validation Rules
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
firstName String = OPTIONAL
The first name of the person to whom the order is being shipped.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
lastName String = OPTIONAL
The last name or surname of the person to whom the order is being shipped.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50
mobilePhone = OPTIONAL
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:
The number consists of:
- ‘+’
- country code (1, 2 or 3 digits)
- ‘space’
- national number ( which may embed single spaces characters for readability).
Fixed value
Validation Rules
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
maximum total digits
15
phone = OPTIONAL
The contact person's phone number in ITU-T E123 format, for example +1 607 1234 456
The number consists of:
The number consists of:
- ‘+’
- country code (1, 2 or 3 digits)
- ‘space’
- national number ( which may embed single spaces characters for readability).
Fixed value
Validation Rules
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
maximum total digits
15
method String = OPTIONAL
The shipping method used for delivery of this order.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
ELECTRONIC
Electronic delivery.
GROUND
Ground (4 or more days).
NOT_SHIPPED
Order for goods that are not shipped (for example, travel and event tickets)
OVERNIGHT
Overnight (next day).
PICKUP
Shipped to a local store for pick up.
PRIORITY
Priority (2-3 days).
SAME_DAY
Same day.
transaction Object = OPTIONAL
Information about this transaction.
Fixed value
acquirer Object = OPTIONAL
Additional information to be passed to acquirer.
Fixed value
customData String = OPTIONAL
Additional information requested by the acquirer which cannot be passed using other available data fields.
This field must not contain sensitive data.
Fixed value
Validation Rules
Data can consist of any characters, but sensitive data will be rejected
minimum length
1
maximum length
2048
traceId String = OPTIONAL
The unique identifier that allows the issuer to link related transactions.
For example, linking a Refund to an Authorization or linking merchant-initiated payments in a series.
For a subsequent Refund the gateway automatically submits the Trace ID of the Authorization to the acquirer (where supported).
However, you must provide this field for a standalone Refund.
For merchant-initiated payments in a series the gateway automatically submits the correct Trace ID to the acquirer (where supported).
However, you must provide this field, if you are submitting any of the payments in the series to the acquirer without using the gateway.
In this case you must follow the instructions in the Visa documentation for the 'transaction identifier' or the Mastercard documentation for the 'trace identifier' field.
If you provide the Trace ID for a payment in a series of merchant-initiated payments, the gateway will use this value in preference to the gateway's selected value.
Fixed value
Validation Rules
Data can consist of any characters, but sensitive data will be rejected
minimum length
1
maximum length
15
transactionId String = OPTIONAL
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).
Fixed value
Validation Rules
Data can consist of any characters, but sensitive data will be rejected
minimum length
1
maximum length
100
merchantNote String = OPTIONAL
Your note about this transaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
250
reference String = OPTIONAL
An optional identifier for this transaction.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40
userId String = OPTIONAL
The person who initiated this transaction.
For Merchant Administration, the person is identified by their logon name.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
256
Return Value
None