configure()

The configure function is used to prepare the Checkout library for a payment. It must be called before either showLightbox() or showPaymentPage() to store payment details.

Usage

Checkout.configure(configuration);

Example

Checkout.configure({
    merchant: '<your_merchant_id>',
    order: {
        amount: function() {
            //Dynamic calculation of amount
            return 100.00;
        },
        currency: 'USD',
        description: 'Ordered goods'
    },
    interaction: {
        merchant: {
            name: 'My Merchant Name'
        }
    }
});

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

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.
Fixed value

amountVariability String = OPTIONAL

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.

expiryDate String = OPTIONAL

Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

id String = OPTIONAL

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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

maximumAmountPerPayment Number = OPTIONAL

Amount will be specified in DE 49 (Currency Code, Transaction). Example: 1800.00 as 180000, with leading zeros.
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

minimumDaysBetweenPayments Number = OPTIONAL

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

numberOfPayments Number = OPTIONAL

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

paymentFrequency String = OPTIONAL

Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
AD_HOC
The agreement if for payments on an ah-hoc basis.
DAILY
The agreement if for a daily payment.
FORTNIGHTLY
The agreement if for a fortnightly payment.
MONTHLY
The agreement if for a monthly payment.
OTHER
The agreement is for payments according to a schedule other than the ones listed in the other enumeration values for this field.
QUARTERLY
The agreement if for a quarterly payment.
TWICE_YEARLY
The agreement if for a payment twice a year.
WEEKLY
The agreement if for a weekly payment.
YEARLY
The agreement if for a yearly payment.

type String = OPTIONAL

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

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

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

Fixed value
Validation Rules
Data must match regex
regex
\w{2}|\d{3}|\w{2}/\d{3}
message
Carrier code must be 2 characters, 3 digits or a combination of both in the format: ZZ/999

conjunctionTicketNumber String = OPTIONAL

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

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

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

departureDate String = OPTIONAL

Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

departureTax Number = OPTIONAL

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

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

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

destinationArrivalDate String = OPTIONAL

Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

destinationArrivalTime String = OPTIONAL

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

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

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

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

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

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

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

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

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

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

Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
minimum length
1
maximum length
3

originCountry String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

frequentFlyerNumber String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

lastName String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

middleName String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

specificInformation String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

planNumber String = OPTIONAL

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

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

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
16

carrierCode = OPTIONAL

Fixed value
Validation Rules
Data must match regex
regex
\w{2}|\d{3}|\w{2}/\d{3}
message
Carrier code must be 2 characters, 3 digits or a combination of both in the format: ZZ/999

carrierName String = OPTIONAL

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

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

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

date String = OPTIONAL

Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

travelAgentCode String = OPTIONAL

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

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

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

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

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

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

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

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

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

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

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.
Fixed value

3ds Object = OPTIONAL

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.
Fixed value

acsEci String = OPTIONAL

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 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.
Fixed value
Validation Rules
Data is Base64 encoded
allowable lengths
28 or 32

transactionId String = OPTIONAL

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.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

3ds1 Object = OPTIONAL

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

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

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™.
Fixed value
Validation Rules
Data may consist of the characters a-z, A-Z
minimum length
1
maximum length
1

3ds2 Object = OPTIONAL

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

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

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

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.
Fixed value
Validation Rules
Data may consist of the characters a-z, A-Z
minimum length
1
maximum length
1

psd2 Object = OPTIONAL

It provides details about SCA exemptions under PSD2.
Fixed value

exemption String = OPTIONAL

Note:
  • For recurring payments, provide the MERCHANT_INITIATED_TRANSACTION value only if the amount is the same. If the amount is variable, provide RECURRING_PAYMENT instead.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
AUTO
If either a LOW_RISK or LOW_VALUE_PAYMENT exemption applies to the transaction, it is automatically claimed by the gateway on behalf of the merchant.
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 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 variable 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

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

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

city String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

company String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

country String = OPTIONAL

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

postcodeZip String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

stateProvinceCode String = OPTIONAL

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

constraints Object = OPTIONAL

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

Specify payment plan constraints to restrict the available payment plan options for this transaction.
Fixed value

numberOfDeferrals Number = OPTIONAL

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

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

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

country String = OPTIONAL

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

postCodeZip String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

street String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

street2 String = OPTIONAL

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

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

folioNumber String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
30

lastName String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

middleName String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

title String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

returnDate String = OPTIONAL

Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

shipName String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

travelAgentCode String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
30

travelPackageItems = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

lastName String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

mobilePhone = OPTIONAL

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

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

device Object = OPTIONAL

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

ani String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
10

aniCallType String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
2

mobilePhoneModel String = OPTIONAL

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

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

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

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

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

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

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

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

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

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100

line2 String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100

line3 String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100

line4 String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
100

email String = OPTIONAL

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

name String = COMPULSORY

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40

phone String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
0
maximum length
20

url String = OPTIONAL

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

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.

timeoutUrl String = OPTIONAL

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

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

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

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

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

If you do not provide a value for order.certainty the default configured for you by your payment services 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

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

custom String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
250

customerOrderDate String = OPTIONAL

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
127

invoiceNumber String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
25

item Object = OPTIONAL

Information about the items the payer purchases with the order.
Fixed value

brand String = OPTIONAL

For example, Dell.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
127

category String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
127

description String = OPTIONAL

For example, 'Color:Red, Size:M'
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
127

industryCategory String = OPTIONAL

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
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
HEALTHCARE_DENTAL
HEALTHCARE_OTHER
HEALTHCARE_PRESCRIPTION
HEALTHCARE_VISION

name String = COMPULSORY

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
127

quantity Number = COMPULSORY

Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number greater than zero.
minimum length
0
maximum length
30

sku String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
127

unitPrice Number = COMPULSORY

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

unitTaxAmount Number = OPTIONAL

This amount is multiplied with the item quantity (item.quantity) to determine the total tax amount for this item.
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

itemAmount Number = OPTIONAL

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

marketplace Object = OPTIONAL

You should provide this identifier to your Payment Services Provider so that the gateway can automatically include it in all transaction messages to your acquirer.
Fixed value

retailerLocation String = OPTIONAL

Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
DOMESTIC_ONLY
The order only contains items from domestic retailers.
FOREIGN_AND_DOMESTIC
The order contains items from both foreign and domestic retailers.
FOREIGN_ONLY
The order only contains items from foreign retailers.

merchantCategoryCode Number = OPTIONAL

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

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

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

purchaseType String = OPTIONAL

You must provide a value for purchase type if your Merchant Category Code (MCC) is one of the following:

6051 (Quasi Cash – Merchant or Non-Financial Institutions – Foreign Currency, Non-Fiat Currency) and this transaction is for the purchase of cryptocurrency. Set the value to CRYPTOCURRENCY.

6211 (Securities – Brokers/Dealers) and this transaction is for the purchase of high-risk securities. Set the value to HIGH_RISK_SECURITIES.

6012 (Merchandise and Services—Customer Financial Institutions) or 6051 (Non-Financial Institutions – Foreign Currency, Non-Fiat Currency) and this transaction is for debt repayment. Set the value to DEBT_REPAYMENT.

You may set purchase type to OTHER for any other type of payment.
Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
CRYPTOCURRENCY
The transaction is for the purchase of a cryptocurrency.
DEBT_REPAYMENT
The transaction is for debt repayment.
HIGH_RISK_SECURITIES
The transaction is for the purchase of high-risk securities.
OTHER
The transaction does not involve the purchase of cryptocurrency, or high-risk securities and is not a debt repayment.

reference String = OPTIONAL

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

shippingAndHandlingAmount Number = OPTIONAL

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

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 correct value as used by your acquirer may have to be provided. Contact your payment services provider for details.
Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

taxAmount Number = OPTIONAL

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

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

transactionFiltering Object = OPTIONAL

Information relevant for Transaction Filtering.
Fixed value

avsResponseCodeRules Object = OPTIONAL

If provided, these rules override the AVS Response Code Transaction Filtering rules you have configured in Merchant Administration.
Fixed value

action String = COMPULSORY

Fixed value
Validation Rules
The action to be performed for the Address Verification Service (AVS) Response Code.
Value must be a member of the following list. The values are case sensitive.
NO_ACTION
No action should be taken by the gateway.
REJECT
The gateway must reject the transaction.
REVIEW
The gateway must mark this transaction as requiring a review.

avsResponseCode String = COMPULSORY

Fixed value
Validation Rules
The Address Verification Service (AVS) Response Code for which you are defining the rule.
Value must be a member of the following list. The values are case sensitive.
ADDRESS_MATCH
Street address matched
ADDRESS_ZIP_MATCH
Street address and zip/postcode were matched
NAME_ADDRESS_MATCH
Card holder name and street address matched
NAME_MATCH
Card holder name matched
NAME_ZIP_MATCH
Card holder name and zip/postcode matched
NOT_AVAILABLE
No data available from issuer or AVS data not supported for transaction
NOT_REQUESTED
AVS not requested
NOT_VERIFIED
AVS could not be verified for an international transaction
NO_MATCH
No match
SERVICE_NOT_AVAILABLE_RETRY
Issuer system is unavailable. Retry can be attempted
SERVICE_NOT_SUPPORTED
Service currently not supported by acquirer or merchant
ZIP_MATCH
Zip/postcode matched. Street address not matched

partnerSolutionId String = OPTIONAL

If your Payment Services 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

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

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

company String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
100

country String = OPTIONAL

Fixed value
Validation Rules
Data must consist of the characters A-Z
minimum length
3
maximum length
3

postcodeZip String = OPTIONAL

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
20

stateProvinceCode String = OPTIONAL

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

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

lastName String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
50

mobilePhone = OPTIONAL

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

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

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.

sourceOfFunds Object = OPTIONAL

Depending on the payment type the source of the funds can be a debit or credit card, bank account, or account with a browser payment provider (such as PayPal).

For card payments the source of funds information may be represented by combining one or more of the following: explicitly provided card details, a session identifier which the gateway will use to look up the card details and/or a card token. Precedence rules will be applied in that explicitly provided card details will override session card details which will override card token details. Each of these may represent partial card details, however the combination must result in a full and complete set of card details. See Using Multiple Sources of Card Details for examples.
Fixed value

provided Object = OPTIONAL

For browser payments, the source of funds details are usually collected from the payer on the payment provider's website and provided to you when you retrieve the transaction details (for a successful transaction). However, for some payment types (such as giropay), you must collect the information from the payer and supply it here.
Fixed value

boletoBancario Object = OPTIONAL

If the payer chose to pay using a Boleto Bancario as a payment method, you must submit sourceOfFunds.type=BOLETO_BANCARIO and provide the additional details in this parameter group.
Fixed value

actionType String = OPTIONAL

Fixed value
Validation Rules
Value must be a member of the following list. The values are case sensitive.
WRITE_OFF
Write off the Boleto.

daysBeforeAction Number = OPTIONAL

Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
minimum length
1
maximum length
2

dueDate String = COMPULSORY

Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd

transaction Object = OPTIONAL

Information about this transaction.
Fixed value

acquirer Object = OPTIONAL

Additional information to be passed to acquirer.
Fixed value

customData String = OPTIONAL

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

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

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

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
250

reference String = OPTIONAL

Fixed value
Validation Rules
Data can consist of any characters
minimum length
1
maximum length
40

userId String = OPTIONAL

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

Copyright © 2021 MasterCard