Checkout configure()

configure()

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


Usage Copied to clipboard

Checkout.configure(configuration);


Example Copied to clipboard

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

Arguments Copied to clipboard

configuration Copied to clipboard Object

The configuration object describes the merchant, customer, payment, and checkout appearance and behaviour. Fields in the object can contain literal values or a function that returns the value. Functions will be invoked before showing the payment interface.

Validation problems with the configuration object will be delivered to the error callback.

agreement Copied to clipboard Object

A series of related orders that execute one commercial agreement.

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

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

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

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

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

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

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

Information about agreements for recurring payments.

amountVariability Copied to clipboard String

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

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

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

A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Min value:1
Max value:999
numberOfPayments Copied to clipboard Number

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

A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Min value:1
Max value:9999
type Copied to clipboard String

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

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

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

Airline industry specific data.

bookingReference Copied to clipboard String

The record locator used to access a specific Passenger Name Record (PNR).

PNR is a record in the database of a booking system that contains the itinerary for a passenger, or a group of passengers traveling together.
Data may consist of the characters 0-9, a-z, A-Z
Min length:6
Max length:15
documentType Copied to clipboard String

The type of charge associated with the transaction.

Document Type Code
Value must be a member of the following list. The values are case sensitive.
ADDITIONAL_COLLECTIONAdditional Collection
AGENCY_EXCHANGE_ORDERAgency Exchange Order
AGENCY_GROUP_TICKETAgency Group Ticket
AGENCY_MISCELLANEOUS_CHARGE_ORDERAgency Misc. Charge Order (MCO)
AGENCY_PASSENGER_TICKETAgency Passenger Ticket
AGENCY_TOUR_ORDER_OR_VOUCHERAgency Tour Order/Voucher
AIR_FREIGHTSPD/Air Freight
ANIMAL_TRANSPORTATION_CHARGEAnimal Transportation Charge
CATALOGUE_MERCHANDISE_ORDEREDCatalogue Merchandise Ordered
CLUB_MEMBERSHIP_FEEClub Membership Fee
COUPON_BOOKCoupon Book
CREDIT_CLASS_SERVICE_ADJUSTMENTCredit Class of Service Adjustment
CREDIT_DENIED_BOARDINGCredit Denied Boarding
CREDIT_EXCHANGE_REFUNDCredit Exchange Refund
CREDIT_LOST_TICKET_REFUNDCredit Lost Ticket Refund
CREDIT_MISCELLANEOUS_REFUNDCredit Misc. Refund
CREDIT_MULTIPLE_UNUSED_TICKETSCredit Multiple Unused Tickets
CREDIT_OVERCHARGE_ADJUSTMENTCredit Overcharge Adjustment
CREDIT_UNUSED_TRANSPORTATIONCredit Unused Transportation
DEBT_ADJUSTMENT_DUPLICATE_REFUND_OR_USEDebt Adjustment Duplicate Refund/Use
DUTY_FREE_SALEDuty Free Sale
EXCESS_BAGGAGEExcess Baggage
EXCHANGE_ADJUSTMENTExchange Adjustment
EXCHANGE_ORDERExchange Order
FIREARMS_CASEFirearms Case
FREQUENT_FLYER_FEE_OR_PURCHASEFrequent Flyer Fee/Purchase
FREQUENT_FLYER_FULFILLMENTFrequent Flyer Fulfillment
FREQUENT_FLYER_OVERNIGHT_DELIVERY_CHARGEFrequent Flyer Overnight Delivery Charge
GROUP_TICKETGroup Ticket
IN_FLIGHT_ADJUSTMENTIn-flight Adjustment
IN_FLIGHT_CHARGESIn-flight Charges
IN_FLIGHT_DUTY_FREE_PURCHASEIn-flight Duty Free Purchase
IN_FLIGHT_MERCHANDISE_ORDEREDIn-flight Merchandise Ordered
IN_FLIGHT_PHONE_CHARGESIn-flight Phone Charges
KENNEL_CHARGEKennel Charge
LOST_TICKET_APPLICATIONLost Ticket Application
MISCELLANEOUS_CHARGE_ORDER_OR_PREPAID_TICKET_ADVICEMisc. Charge Order (MCO) / Prepaid Ticket Auth.
MISCELLANEOUS_TAXES_FEESMiscellaneous Tax(es) Fee(s)
PASSENGER_TICKETPassenger Ticket
SELF_SERVICE_TICKETSSelf-Service Ticket(s)
SENIOR_CITIZEN_DISCOUNT_BOOKLETSSenior Citizen Discount Booklets
SMALL_PACKAGE_DELIVERYSmall Package Delivery
SPECIAL_SERVICE_TICKETSpecial Service Ticket
SUPPORTED_REFUNDSupported Refund
TICKET_BY_MAILTicket by Mail
TOUR_DEPOSITTour Deposit
TOUR_ORDER_VOUCHERTour Order Voucher
UNDERCHARGE_ADJUSTMENTUndercharge Adjustment
UNSUPPORTED_REFUNDUnsupported Refund
UPGRADE_CHARGEUpgrade Charge
VENDOR_REFUND_CREDITVendor Refund Credit
VENDOR_SALEVendor Sale
itinerary Copied to clipboard Object

Itinerary details

leg Copied to clipboard Object

Travel leg details.

carrierCode Copied to clipboard

The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier for the trip leg.

Data must match regex
regex\w{2}|\d{3}|\w{2}/\d{3}
messageCarrier code must be 2 characters, 3 digits or a combination of both in the format: ZZ/999
conjunctionTicketNumber Copied to clipboard String

The ticket containing the coupon for this leg for an itinerary with more than four trip legs.

Data may consist of the characters 0-9, a-z, A-Z
Min length:11
Max length:16
couponNumber Copied to clipboard String

The coupon number on the ticket for the trip leg.

Each trip leg requires a separate coupon. The coupon within the series is identified by the coupon number.
Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:1
departureAirport Copied to clipboard String

The 3 character IATA airport code of the departure airport for the trip leg.

Data must consist of the characters A-Z
Min length:3
Max length:3
departureDate Copied to clipboard String

Date of departure for the trip leg.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd
departureTax Copied to clipboard Number

Tax payable on departure for the trip leg.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
departureTime Copied to clipboard String

Departure time in local time for the departure airport for this trip leg.

Data must comply with ISO 8601 extended time formats, hh:mm[:ss]Z or hh:mm[:ss](+/-)hh[:mm]
destinationAirport Copied to clipboard String

The 3 character IATA airport code for the destination airport for the trip leg.

Data must consist of the characters A-Z
Min length:3
Max length:3
destinationArrivalDate Copied to clipboard String

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

Data must comply with ISO 8601 extended date format, yyyy-mm-dd
destinationArrivalTime Copied to clipboard String

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

Data must comply with ISO 8601 extended time formats, hh:mm[:ss]Z or hh:mm[:ss](+/-)hh[:mm]
endorsementsRestrictions Copied to clipboard String

Restrictions (e.g. non-refundable) or endorsements applicable to the trip leg.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:20
exchangeTicketNumber Copied to clipboard String

New ticket number issued when a ticket is exchanged for the trip leg.

Data may consist of the characters 0-9, a-z, A-Z
Min length:11
Max length:16
fare Copied to clipboard Number

Total fare payable for the trip leg.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
fareBasis Copied to clipboard String

Code defining the rules forming the basis of the fare (type of fare, class entitlement, etc.)

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:24
fees Copied to clipboard Number

Total fees payable for the trip leg.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
flightNumber Copied to clipboard String

The flight number for the trip leg.

Data may consist of the characters 0-9, a-z, A-Z
Min length:4
Max length:6
stopoverPermitted Copied to clipboard Boolean

Indicates if a stopover is permitted for the trip leg.

The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
taxes Copied to clipboard Number

Total taxes payable for the trip leg.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
travelClass Copied to clipboard String

The industry code indicating the class of service (e.g. Business, Coach) for the leg.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:3
numberInParty Copied to clipboard Number

Number of passengers associated with this booking.

Data is a string that consists of the characters 0-9.
Min length:1
Max length:3
originCountry Copied to clipboard String

The 3 character ISO 3166-1 alpha-3 country code of the country of origin for the itinerary.

Data must consist of the characters A-Z
Min length:3
Max length:3
passenger Copied to clipboard Object

Passenger details

firstName Copied to clipboard String

First name of the passenger to whom the ticket is being issued.

Data can consist of any characters
Min length:1
Max length:50
frequentFlyerNumber Copied to clipboard String

Frequent Flyer or Loyalty Program number for this passenger.

Data can consist of any characters
Min length:1
Max length:20
lastName Copied to clipboard String

Last name of the passenger to whom the ticket is being issued.

Data can consist of any characters
Min length:1
Max length:20
middleName Copied to clipboard String

Middle name of the passenger to whom the ticket is being issued.

Data can consist of any characters
Min length:1
Max length:50
specificInformation Copied to clipboard String

Passenger specific information recorded on the ticket.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:59
title Copied to clipboard String

Title of the passenger to whom the ticket is being issued.

Data can consist of any characters
Min length:1
Max length:20
planNumber Copied to clipboard String

Plan number supplied by the airline for this booking.

Data may consist of the characters 0-9, a-z, A-Z
Min length:2
Max length:2
ticket Copied to clipboard Object

Ticket details

conjunctionTicketIndicator Copied to clipboard Boolean

Indicates if a conjunction ticket with additional coupons was issued.

Conjunction ticket refers to two or more tickets concurrently issued to a passenger and which together constitute a single contract of carriage.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
eTicket Copied to clipboard Boolean

Indicates if an electronic ticket was issued.

The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
exchangedTicketNumber Copied to clipboard String

The original ticket number when this is a transaction for an exchanged ticket.

Data may consist of the characters 0-9, a-z, A-Z
Min length:11
Max length:16
issue Copied to clipboard Object

Ticket issue information.

address Copied to clipboard String

The address where the ticket was issued.

Data can consist of any characters
Min length:1
Max length:16
carrierCode Copied to clipboard

The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier issuing the ticket.

Data must match regex
regex\w{2}|\d{3}|\w{2}/\d{3}
messageCarrier code must be 2 characters, 3 digits or a combination of both in the format: ZZ/999
carrierName Copied to clipboard String

Name of airline carrier issuing the ticket.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:25
city Copied to clipboard String

The city/town where the ticket was issued.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:18
country Copied to clipboard String

The 3 character ISO 3166-1 alpha-3 country code of the country where the ticket was issued.

Data must consist of the characters A-Z
Min length:3
Max length:3
date Copied to clipboard String

The date the ticket was issued.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd
travelAgentCode Copied to clipboard String

Industry code of the travel agent issuing the ticket.

Data may consist of the characters 0-9, a-z, A-Z
Min length:8
Max length:9
travelAgentName Copied to clipboard String

Name of the travel agent issuing the ticket.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:30
restricted Copied to clipboard Boolean

Indicates if the issued ticket is refundable.

The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
taxOrFee Copied to clipboard Object

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

The total of the amounts in this group should equal the sum of the airline.ticket.totalFees and airline.ticket.totalTaxes fields.
amount Copied to clipboard Number

The tax, charge or fee amount payable.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
type Copied to clipboard String

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

For example, the IATA tax/ charge/ fee type for Passenger Movement Charge (PMC) in Australia is TT1.
Data may consist of the characters 0-9, a-z, A-Z
Min length:3
Max length:3
ticketNumber Copied to clipboard String

The airline ticket number associated with the transaction.

Data may consist of the characters 0-9, a-z, A-Z
Min length:11
Max length:16
totalFare Copied to clipboard Number

Total fare for all trip legs on the ticket.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
totalFees Copied to clipboard Number

Total fee for all trip legs on the ticket.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
totalTaxes Copied to clipboard Number

Total taxes for all trip legs on the ticket.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
transactionType Copied to clipboard String

The type of transaction performed against this airline booking.

Transaction Type
Value must be a member of the following list. The values are case sensitive.
EXCHANGE_TICKETExchange Ticket
MISCELLANEOUS_CHARGEMiscellaneous Charge
REFUNDRefund
REVERSALReversal
TICKET_PURCHASETicket Purchase
TOUR_ORDERTour Order
authentication Copied to clipboard Object

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.
3ds Copied to clipboard Object

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.
acsEci Copied to clipboard String

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.
Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:2
authenticationToken Copied to clipboard

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.
Data is Base64 encoded
allowable lengths28 or 32
transactionId Copied to clipboard String

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.
Data can consist of any characters
Min length:1
Max length:50
3ds1 Copied to clipboard Object

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.
paResStatus Copied to clipboard

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™.
Data may consist of the characters a-z, A-Z
Min length:1
Max length:1
veResEnrolled Copied to clipboard

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™.
Data may consist of the characters a-z, A-Z
Min length:1
Max length:1
3ds2 Copied to clipboard Object

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.
protocolVersion Copied to clipboard String

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
Data may consist of the characters 0-9, a-z, A-Z, '.'
Min length:1
Max length:20
statusReasonCode Copied to clipboard String

A code indicating the reason for the transaction status returned in authentication.3ds2.transactionStatus.

Refer to the EMVCo specification for 3-D Secure.
Data can consist of any characters
Min length:2
Max length:2
transactionStatus Copied to clipboard

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.
Data may consist of the characters a-z, A-Z
Min length:1
Max length:1
psd2 Copied to clipboard Object

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.
exemption Copied to clipboard String

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.
Value must be a member of the following list. The values are case sensitive.
LOW_RISKExemption is claimed because the acquirer has a low fraud rate.
LOW_VALUE_PAYMENTExemption is claimed as the amount is below 30 Euro.
MERCHANT_INITIATED_TRANSACTIONThe 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.
NONEAn exemption is not claimed for this transaction. The merchant requires Strong Customer Authentication (SCA) be performed.
RECURRING_PAYMENTThe 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_PAYMENTThe 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.
transactionId Copied to clipboard String

The transactionId you used for the Initiate Authentication operation.

Data can consist of any characters
Min length:1
Max length:40
billing Copied to clipboard Object

Details of the payer's billing address.

address Copied to clipboard Object

The payer's billing address.

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

The city portion of the address.

Data can consist of any characters
Min length:1
Max length:100
company Copied to clipboard String

The name of the company associated with this address.

Data can consist of any characters
Min length:1
Max length:100
country Copied to clipboard String

The 3 letter ISO standard alpha country code of the address.

Data must consist of the characters A-Z
Min length:3
Max length:3
postcodeZip Copied to clipboard String

The post code or zip code of the address.

Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
Min length:1
Max length:10
stateProvince Copied to clipboard String

The state or province of the address.

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

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

Providing this field might improve your payer experience for 3-D Secure payer authentication.
Data can consist of any characters
Min length:1
Max length:3
street Copied to clipboard String

The first line of the address.

For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
Min length:1
Max length:100
street2 Copied to clipboard String

The second line of the address (if provided).

Data can consist of any characters
Min length:1
Max length:100
constraints Copied to clipboard Object

Information about any constraints that apply to this transaction.

Specify constraints to ensure that the transaction conforms to predefined criteria. This is useful if your integration does not directly collect all the transaction values (e.g. a session-based integration or a checkout integration).
paymentPlans Copied to clipboard Object

Information about the payment plan constraints which apply for this transaction.

Specify payment plan constraints to restrict the available payment plan options for this transaction.
numberOfDeferrals Copied to clipboard Number

The allowable number of deferral months for the payment plan.

A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Min value:0
Max value:99
numberOfPayments Copied to clipboard Number

The allowable number of installments for the payment plan.

A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Min value:1
Max value:99
supported Copied to clipboard String

The identifiers for the payment plans supported for this transaction.

If you wish to offer any payment plans to the payer, provide the plan identifiers in this field else pass it as empty.

See Payment Plans for the supported payment plans and their identifiers.
Data can consist of any characters
Min length:1
Max length:40
cruise Copied to clipboard Object

Cruise industry data.

bookingReference Copied to clipboard String

The cruise booking reference.

Data can consist of any characters
Min length:1
Max length:12
company Copied to clipboard Object

Information about the cruise line.

address Copied to clipboard Object

Address of the cruise line.

city Copied to clipboard String

The city portion of the address.

Data can consist of any characters
Min length:1
Max length:100
country Copied to clipboard String

The 3 letter ISO standard alpha country code of the address.

Data must consist of the characters A-Z
Min length:3
Max length:3
postCodeZip Copied to clipboard String

The post code or zip code of the address.

Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
Min length:1
Max length:10
stateProvince Copied to clipboard String

The state or province of the address.

Data can consist of any characters
Min length:1
Max length:20
street Copied to clipboard String

The first line of the address.

Data can consist of any characters
Min length:1
Max length:100
street2 Copied to clipboard String

The second line of the address (if provided).

Data can consist of any characters
Min length:1
Max length:100
contact Copied to clipboard Object

Contact details of the cruise line.

companyPhone Copied to clipboard

The cruise line registered office telephone number in ITU-T E123 format.

Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Mandatory country code:true
Max total digits:15
customerServicePhone Copied to clipboard

The customer service phone number in ITU-T E123 format.

Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Mandatory country code:true
Max total digits:15
departureDate Copied to clipboard String

The cruise departure/ sail date.

This field is required when cruise industry data is provided.

The value entered must be equal to or earlier than cruise.returnDate.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
passenger Copied to clipboard Object

Cruise passenger details.

firstName Copied to clipboard String

The first name of the passenger.

Data can consist of any characters
Min length:1
Max length:50
folioNumber Copied to clipboard String

The folio number assigned to the passenger.

Data can consist of any characters
Min length:1
Max length:30
lastName Copied to clipboard String

The last name of the passenger.

Data can consist of any characters
Min length:1
Max length:50
middleName Copied to clipboard String

The middle name of the passenger.

Data can consist of any characters
Min length:1
Max length:50
title Copied to clipboard String

The title of the passenger.

Data can consist of any characters
Min length:1
Max length:50
returnDate Copied to clipboard String

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.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd
shipName Copied to clipboard String

The name of the cruise ship.

Data can consist of any characters
Min length:1
Max length:50
travelAgentCode Copied to clipboard String

The industry code of the travel agent booking the cruise.

Data may consist of the characters 0-9, a-z, A-Z
Min length:8
Max length:9
travelAgentName Copied to clipboard String

The name of the travel agent booking the cruise.

Data can consist of any characters
Min length:1
Max length:30
travelPackageItems Copied to clipboard

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.

Value must be one or more comma separated members of the following list. The values are case sensitive.
CAR_RENTALCar rental is included in the travel package.
CRUISE_ONLYNo additional items are included in the cruise travel package.
FLIGHTFlights are included in the travel package.
customer Copied to clipboard Object

Information about the customer, including their contact details.

email Copied to clipboard String

The email address of the customer.

The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
firstName Copied to clipboard String

The payer's first name.

Data can consist of any characters
Min length:1
Max length:50
lastName Copied to clipboard String

The payer's last or surname.

Data can consist of any characters
Min length:1
Max length:50
mobilePhone Copied to clipboard

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

The number consists of:

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

Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Mandatory country code:true
Max total digits:15
phone Copied to clipboard

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

The number consists of:

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

Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Mandatory country code:true
Max total digits:15
debtRepayment Copied to clipboard Object

Details about debt repayment transactions.

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

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

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

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

ani Copied to clipboard String

The telephone number captured by ANI (Automatic Number Identification) when the customer calls to place the order.

Data can consist of any characters
Min length:1
Max length:10
aniCallType Copied to clipboard String

The 2 digit ANI information identifier provided by the telephone company to indicate the call type, for example, cellular (61-63), toll free (24,25), etc.

Data can consist of any characters
Min length:1
Max length:2
mobilePhoneModel Copied to clipboard String

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

Data can consist of any characters
Min length:1
Max length:255
interaction Copied to clipboard Object REQUIRED

Information that controls the payer's checkout interaction.

googleAnalytics Copied to clipboard Object
propertyId Copied to clipboard String

The property ID for your shop site provided by Google Analytics in the form UA-XXXXX-Y.

Provide this ID if you want to track interactions with the checkout using Google Analytics. See www.google.com/analytics.
Data can consist of any characters
Min length:1
Max length:20
cancelUrl Copied to clipboard String REQUIRED

The URL to which you want to redirect the payer's browser if they cancel their payment.

This could be a link to the payer's shopping cart, or the home page of your website.
Data must be an absolute URI conforming to the URI syntax published by IETF RFC 2396. The following schemes are forbidden : javascript
displayControl Copied to clipboard Object

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

billingAddress Copied to clipboard String

Indicates if you require the payer to provide their billing address during the payment interaction.

If you do not provide this field, the billing address will be optional.
Value must be a member of the following list. The values are case sensitive.
HIDEHides data fields from the payer.
MANDATORYDisplays data fields and allows the payer to enter data into these fields.
OPTIONALDisplays data fields and allows the payer to opt out of data entry for these fields.
READ_ONLYData is displayed but cannot be modified.
confirmAchAccountNumber Copied to clipboard String

Indicates if you wish to display a 'Confirm Account Number' field for the ACH Account Number entry.

If the field is shown, the gateway enforces that the same value is entered in both the 'Account Number' and 'Confirm Account Number' fields.If you do not provide a value for this field, the gateway defaults the value to SHOW.
Value must be a member of the following list. The values are case sensitive.
HIDEDo not display confirm account number.
SHOWDisplay confirm account number.
customerEmail Copied to clipboard String

Indicates if you require the payer to provide their email address on the payment interaction.

If you do not provide this field, the payer's email address will be hidden.
Value must be a member of the following list. The values are case sensitive.
HIDEHides data fields from the payer.
MANDATORYDisplays data fields and allows the payer to enter data into these fields.
OPTIONALDisplays data fields and allows the payer to opt out of data entry for these fields.
READ_ONLYData is displayed but cannot be modified.
orderSummary Copied to clipboard String

Indicates if you wish to display a summary of the order before the payer submits their payment.

If you do not provide a value for this field, the gateway defaults the value to SHOW.
Value must be a member of the following list. The values are case sensitive.
HIDEDo not display order summary.
SHOWDisplay order summary, which may include payment details.
SHOW_PARTIALDisplay order summary which may not include payment details.
paymentConfirmation Copied to clipboard String

Indicates if you want the payer to confirm the payment details before they submit the payment.

If you do not provide a value for this field, the gateway defaults the value to HIDE.
Value must be a member of the following list. The values are case sensitive.
HIDEDo not display payment confirmation.
SHOWDisplay payment confirmation.
paymentTerms Copied to clipboard String

Indicates whether you wish to hide payment terms for a payment plan during the payment interaction.

If you do not provide this field the payment terms for a payment plan will be displayed.
Value must be a member of the following list. The values are case sensitive.
HIDEHides the payment terms from the payer. Note that offering Plan AMEX in some regions may require you to inform the payer of the payment terms before processing the payment.
SHOW_IF_SUPPORTEDDisplays the payment terms, if available, to the payer.
shipping Copied to clipboard String

Indicates if you wish to hide the shipping details on the payment interaction.

If you don't provide this field, shipping details will be displayed to the payer.
Value must be a member of the following list. The values are case sensitive.
HIDEHides data fields from the payer.
READ_ONLYData is displayed but cannot be modified.
locale Copied to clipboard String

A language identifier or IETF language tag to control the language of the payment interaction with the payer (e.g. en_US, es, fr-CA).

By default, the language is determined from the payer's browser. Supply a value for this field only if you wish to override the default behavior. If the language you specify is not supported by the gateway, the payment is displayed in the best matching language.
Data must be a language identifier or IETF language tag
Min length:2
Max length:5
merchant Copied to clipboard Object REQUIRED

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

address Copied to clipboard Object

Information on your business address.

line1 Copied to clipboard String

The first line of your business address for display to the payer during the payment interaction.

Data can consist of any characters
Min length:0
Max length:100
line2 Copied to clipboard String

The second line of your business address for display to the payer during the payment interaction.

Data can consist of any characters
Min length:0
Max length:100
line3 Copied to clipboard String

The third line of your business address for display to the payer during the payment interaction.

Data can consist of any characters
Min length:0
Max length:100
line4 Copied to clipboard String

The fourth line of your business address for display to the payer during the payment interaction.

Data can consist of any characters
Min length:0
Max length:100
email Copied to clipboard String

The email address of your business for display to the payer during the payment interaction (e.g. an email address for customer service).

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

The name of your business for display to the payer on the payment interaction.

Data can consist of any characters
Min length:1
Max length:40
phone Copied to clipboard String

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

Data can consist of any characters
Min length:0
Max length:20
url Copied to clipboard String

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

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

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

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

The theme used to control the look and feel of your checkout interaction.

If you do not provide this field the default theme is will be used.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Min length:1
Max length:50
timeoutUrl Copied to clipboard String

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

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

The unique identifier issued to you by your payment provider.

This identifier can be up to 12 characters in length.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Min length:1
Max length:40
order Copied to clipboard Object REQUIRED

Information about the order associated with this transaction.

id Copied to clipboard String

A unique identifier for this order to distinguish it from any other order you create.

Use this identifier when referring to this order in subsequent transactions and in retrieval operations. This value must be unique for every order you create using your merchant profile.
Data can consist of any characters
Min length:1
Max length:40
amount Copied to clipboard Number

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

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

The value of this field in the response may be zero if payer funds are not transferred.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
cashAdvance Copied to clipboard Boolean

Set this flag if the transaction is a manual cash disbursement transaction, i.e. cash is disbursed upon the acceptance of a card by a financial institution teller.

The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
certainty Copied to clipboard String

Indicates if you expect to capture the full order amount for which you are requesting authorization.

If you do not provide a value for order.certainty the default configured for you by your payment service provider will be used. The value provided in the response shows the value the gateway sent to the acquirer
Value must be a member of the following list. The values are case sensitive.
ESTIMATEDThe amount authorized is an estimate of the amount that will be captured. It is possible that the amount captured will be less, or might not be captured at all.
FINALThe full authorized amount is expected to be captured within the mandated time. The order will only be cancelled in exceptional circumstances (for example, the payer cancelled their purchase).
currency Copied to clipboard String REQUIRED

The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.

Data must consist of the characters A-Z
Min length:3
Max length:3
custom Copied to clipboard String

Information about this order that is of interest to you.

For example order.custom.X, where 'X' is defined by you and must be less than 100 characters from the set A-Z, a-z, 0-9. For example, order.custom.salesRegion. You can specify up to 50 such fields. They are not sent to acquirers.
Data can consist of any characters
Min length:1
Max length:250
customerNote Copied to clipboard String

A note from the payer about this order.

Data can consist of any characters
Min length:1
Max length:250
customerOrderDate Copied to clipboard String

The date the payer placed the order.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
customerReference Copied to clipboard String

The payer's own reference for the order.

This reference may assist the payer to identify the order in their system. For example, a purchase order number, project identifier, or cost center.
Data consists of ASCII characters
Min length:0
Max length:25
description Copied to clipboard String

Short textual description of the contents of the order.

Data can consist of any characters
Min length:1
Max length:127
merchantCategoryCode Copied to clipboard Number

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

You only need to provide the MCC if you want to override the default value configured for your acquirer link.The value you provide must match one of those configured by your payment service provider.
Data is a string that consists of the characters 0-9.
Min length:4
Max length:4
netAmount Copied to clipboard Number

The amount payable for the order before surcharging is applied.

If you specify a net amount the gateway will calculate the surcharge for you.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
owningEntity Copied to clipboard String

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

You might provide this data when you want to track the accountability for the order. For example, store number, sales region, branch, or profit center
Data can consist of any characters
Min length:1
Max length:40
reference Copied to clipboard String

The identifier of the order.

For example, a shopping cart number, an order number, or an invoice number.
Data can consist of any characters
Min length:1
Max length:40
requestorName Copied to clipboard String

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

Data can consist of any characters
Min length:1
Max length:100
shippingAndHandlingAmount Copied to clipboard Number

The total shipping and handling amount for the order.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
tax Copied to clipboard Object

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

amount Copied to clipboard Number

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

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
type Copied to clipboard String

The type of tax included in the order amount.

The correct value as used by your acquirer may have to be provided. Contact your payment service provider for details.
Data can consist of any characters
Min length:1
Max length:50
taxAmount Copied to clipboard Number

The total tax amount for the order.

If you do not provide this value but provide line item data, then this amount is calculated as the sum of the item.quantity times the item.unitTaxAmount for all the line items (total tax amount).
If you provide both this value and line item data, then the order.taxAmount MUST equal the total tax amount.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
taxRegistrationId Copied to clipboard String

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

If you are a Canadian merchant, use this field to provide your Tax Registration ID for paying Harmonized Sales Tax (HST) or Goods and Services Tax (GST) collected by the Canada Revenue Agency.
Data can consist of any characters
Min length:1
Max length:30
partnerSolutionId Copied to clipboard String

If, when integrating with the gateway, you are using a solution (e.g. a shopping cart or e-commerce solution) provided, supported or certified by your payment service provider, enter the solution ID issued by your payment service provider here.

If your payment service provider has not provided you with a solution ID, you should ignore this field.
Data can consist of any characters
Min length:1
Max length:40
session Copied to clipboard Object
id Copied to clipboard String

Identifier of the payment session containing values for any of the request fields to be used in this operation.

Values contained in the session will override values provided by the request.
Data consists of ASCII characters
Min length:31
Max length:35
version Copied to clipboard String

Use this field to implement optimistic locking of the session content.

Do this if you make business decisions based on data from the session and wish to ensure that the same data is being used for the request operation.

To use optimistic locking, record session.version when you make your decisions, and then pass that value in session.version when you submit your request operation to the gateway.

If session.version provided by you does not match that stored against the session, the gateway will reject the operation with error.cause=INVALID_REQUEST.

See Making Business Decisions Based on Session Content.
Data consists of ASCII characters
Min length:10
Max length:10
shipping Copied to clipboard Object

Shipping information for this order.

address Copied to clipboard Object
sameAsBilling Copied to clipboard String

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

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

The default value for this field is:

SAME - if the shipping and billing address are supplied, and all fields are the same (ignoring non-alphanumerics).
DIFFERENT - if the shipping and billing address are supplied, and at least one field is different (ignoring non-alphanumerics).
UNKNOWN - either shipping address or billing address is absent.
Value must be a member of the following list. The values are case sensitive.
DIFFERENTThe shipping and billing addresses are different.
SAMEThe shipping and billing addresses are the same.
UNKNOWNIt is not known if the shipping and billing addresses are the same.
address Copied to clipboard Object

The address to which this order will be shipped.

city Copied to clipboard String

The city portion of the address.

Data can consist of any characters
Min length:1
Max length:100
company Copied to clipboard String

The name of the company associated with this address.

Data can consist of any characters
Min length:1
Max length:100
country Copied to clipboard String

The 3 letter ISO standard alpha country code of the address.

Data must consist of the characters A-Z
Min length:3
Max length:3
postcodeZip Copied to clipboard String

The post code or zip code of the address.

Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
Min length:1
Max length:10
source Copied to clipboard String

How you obtained the shipping address.

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

The state or province of the address.

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

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

Providing this field might improve your payer experience for 3-D Secure payer authentication.
Data can consist of any characters
Min length:1
Max length:3
street Copied to clipboard String

The first line of the address.

For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
Min length:1
Max length:100
street2 Copied to clipboard String

The second line of the address (if provided).

Data can consist of any characters
Min length:1
Max length:100
contact Copied to clipboard Object

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

email Copied to clipboard String

The contact person's email address.

The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
firstName Copied to clipboard String

The first name of the person to whom the order is being shipped.

Data can consist of any characters
Min length:1
Max length:50
lastName Copied to clipboard String

The last name or surname of the person to whom the order is being shipped.

Data can consist of any characters
Min length:1
Max length:50
mobilePhone Copied to clipboard

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

The number consists of:

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

Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Mandatory country code:true
Max total digits:15
phone Copied to clipboard

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

The number consists of:

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

Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Mandatory country code:true
Max total digits:15
method Copied to clipboard String

The shipping method used for delivery of this order.

Value must be a member of the following list. The values are case sensitive.
ELECTRONICElectronic delivery.
GROUNDGround (4 or more days).
NOT_SHIPPEDOrder for goods that are not shipped (for example, travel and event tickets)
OVERNIGHTOvernight (next day).
PICKUPShipped to a local store for pick up.
PRIORITYPriority (2-3 days).
SAME_DAYSame day.
transaction Copied to clipboard Object

Information about this transaction.

acquirer Copied to clipboard Object

Additional information to be passed to acquirer.

customData Copied to clipboard String

Additional information requested by the acquirer which cannot be passed using other available data fields.

This field must not contain sensitive data.
Data can consist of any characters, but sensitive data will be rejected
Min length:1
Max length:2048
traceId Copied to clipboard String

The unique identifier that allows the issuer to link related transactions (for example, Merchant Initiated Transactions).

It is only applicable if you want to link transactions across multiple payment gateways.If you want to do this, then its usage is described in Visa documentation for 'transaction identifier' or the Mastercard documentation for 'trace identifier' field.
If you provide this value in the request, gateway will use this value in preference to the gateway's selected value.
Data can consist of any characters, but sensitive data will be rejected
Min length:1
Max length:15
transactionId Copied to clipboard String

This is the value provided to the acquirer to identify the order.

Ideally this will be the order.id, however if that value cannot be used directly, it will be transformed by the gateway to a unique value that the acquirer will accept. If that behavior is not suitable, you can directly provide the value in this field and it will be passed to the acquirer. You then take responsibility for its correctness. (Note: contact your payment provider to see if this is supported for your acquirer).
Data can consist of any characters, but sensitive data will be rejected
Min length:1
Max length:100
merchantNote Copied to clipboard String

Your note about this transaction.

Data can consist of any characters
Min length:1
Max length:250
reference Copied to clipboard String

An optional identifier for this transaction.

Data can consist of any characters
Min length:1
Max length:40
userId Copied to clipboard String

The person who initiated this transaction.

For Merchant Administration, the person is identified by their logon name.
Data can consist of any characters
Min length:1
Max length:256

Return Value Copied to clipboard

None