Session updateSession()

updateSession()

Sends a request to store the input from the hosted field into the session.

Usage

PaymentSession.updateSession(updateSessionCallback)

Example 

PaymentSession.updateSession(function (updateSessionResponse) {
    // handle response
});

JSON Example for Session Update Response 

 // status can be one of the following: ok, fields_in_error, system_error, request_timeout

// An error response (fields_in_error)
{
    "status": "fields_in_error",
    "session": {
        "id": "SESSION000218450948092491657986"
    },
    "errors": {
        "cardNumber": "invalid",
        "securityCode": "invalid"
    },
    version: "36"
}

// An error response (system_error)
{
    "status": "system_error",
    "session": {
        "id": "SESSION000218450948092491657986"
    },
    "errors": {
        "message": "System error message."
    },
    "version": "36"
}

// An error response (request_timeout)
{
    "status" : "request_timeout",
    "session": {
        "id": "SESSION000218450948092491657986"
    },
    "errors": {
        "message": "Request timeout error message."
    },
    "version": "36"
}

// An ok response
{
    "status":"ok",
    "merchant": "TESTMERCHANT",
    "session": {
        "id": "SESSION000218450948092491657986"
        "updateStatus":"SUCCESS",
        "version":"e3f144ce02"
    },
    "sourceOfFunds": {
        "provided": {
            "card": {
                "brand": "MASTERCARD",
                "expiry": {
                    "month": "1",
                    "year": "39"
                },
                "fundingMethod": "DEBIT",
                "nameOnCard": "John Smith",
                "number": "512345xxxxxx8769",
                "scheme": "MASTERCARD"
            }
        },
        "type": "CARD"
    },
    "version": "36"
}

Arguments

updateSessionCallback Function

The function to handle the response from PaymentSession.updateSession( ) call. Defined as updateSessionCallback = function(updateSessionResponse).

status String REQUIRED

The overall status of the PaymentSession.updateSession( ) request. Possible values are:

ok
fields_in_error
system_error
request_timeout
version String REQUIRED

The version of the <<webServicesIntegration>> used to retrieve the session details.

errors Object

The errors object returned if the PaymentSession.updateSession( ) request failed to update the session successfully.

errorField String

Indicates the name of the field that failed validation, returned only if the response status is fields_in_error.

cause String

Cause of the error. Possible values are:

missing
invalid

Example 

// An error response (fields_in_error)
    "errors": {
        "cardNumber": "invalid",
        "securityCode": "invalid"
    },
message String

The error message returned if the response status is system_error or request_timeout.

Example 

// An error response (request_timeout)
    "errors": {
        "message": "Request timeout error message."
    },
// An error response (system_error)
    "errors": {
        "message": "System error message."
    },
3DSecure Object

Information on 3DSecure fields.

acsEci Number

The Electronic Commerce Indicator returned by the card issuer in the authentication response message.

It indicates the level of security and authentication of the transaction.
Data is a string that consists of the characters 0-9.
Min length:1
Max length:2
authenticationRedirect Object

A collection of parameters required to build the HTML form that is redirected to the ACS.

There are two options to generate the redirect page used to transfer the cardholder to the card Issuer's Access Control Server (ACS) for authentication:

1. Simple: submit the form generated by the gateway. In this case, only the htmlBodyContent parameter is required.
2. Customized: for those merchants who wish to customise the submission. In this case, the acsURL and paReq parameters will be required to formulate the submission.
Note: This field will only be returned in the event of a successful directory server lookup.
pageGenerationMode String

Indicates the option (Simple or Customized) used to generate the page that redirects the cardholder to the card Issuer's Access Control Server (ACS) for authentication.

The response to the Check 3DS Enrollment operation will include the information required for the selected option. By default, the Simple option is used.
An enumeration to allow a user to specify if they wish to adopt a customized solution or a simple solution.
Value must be a member of the following list. The values are case sensitive.
CUSTOMIZEDA strategy to indicate that the user wishes to customize the response
SIMPLEA simple interaction model where the response is complete and no user intervention is required.
responseUrl

The URL to which you want to redirect the payer after completing the payer authentication process.

Typically, this will be the merchant's website URL, which must be URL encoded for special characters such spaces, hyphens, etc.
Ensure that the URL begins with 'https' and is longer than 11 characters.
simple Object

The details required by the system to generate the HTML page as specified in the Simple option.

expectedHtmlEncoding String

The encoding required for the HTML returned in the response, through htmlBodyContent parameter.

The available HTML Encoding options that a client may request.
Value must be a member of the following list. The values are case sensitive.
ASCII
ISO_8859_1Latin1
UTF_8
redirectDisplayBackgroundColor String

Background color of the page, encoded in HEX, rendered in the cardholder's browser while the browser is waiting for the authentication to commence.

By default, the color is set to #FFFFFF.
Data may consist of the characters 0-9, a-z, A-Z, '#'
Min length:4
Max length:7
redirectDisplayContinueButtonText String

Text on the button that the cardholder can use to redirect the browser to the card Issuer's Access Control Server (ACS) if JavaScript is disabled for their browser.

By default, the button text is set to "Click here to continue".
Data can consist of any characters
Min length:1
Max length:40
redirectDisplayTitle String

Title of the page rendered in the cardholder's browser while the browser is waiting for the authentication to commence.

By default, the title is set to "Process secure Payment".
Data can consist of any characters
Min length:1
Max length:200
authenticationStatus String

Indicates if the cardholder verification was successful.

Included only if payment authentication was attempted and a PARes (Payer Authentication Response) was received by the MPI.

The PARes message is the response received from the card Issuer's Access Control Server (ACS) after the cardholder has completed the authentication process.
Value must be a member of the following list. The values are case sensitive.
AUTHENTICATION_ATTEMPTEDAuthentication was attempted but the card issuer did not perform the authentication.
AUTHENTICATION_NOT_AVAILABLEAn internal error occurred and Authentication is not currently available.
AUTHENTICATION_SUCCESSFULThe cardholder was successfully authenticated.
authenticationToken

The base64 encoded value generated by the card issuer.

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.
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.
Data is Base64 encoded
allowable lengths28 or 32
enrollmentStatus String

Indicates if the cardholder is enrolled for 3-D Secure authentication.

Value must be a member of the following list. The values are case sensitive.
ENROLLEDThe card is enrolled for 3DS authentication.
ENROLLMENT_STATUS_UNDETERMINEDThe Issuer's ACS was unable to process the request to check enrollment or the card is ineligible.
NOT_ENROLLEDThe card is not enrolled for 3DS authentication.
goodsDescription String

An optional field that the merchant may supply in the Transaction Request as a description of the transaction.

If supported by the ACS, this description will be displayed on the authentication page where the cardholder types in their secret password.
Data can consist of any characters
Min length:0
Max length:30
xid

A unique transaction identifier generated by the Payment Gateway on behalf of the merchant to identify the 3DS transaction.

This field is mandatory for Verified By Visa transactions if authentication was available. The XID should be used in operation requests unaltered.
Data is Base64 encoded
allowable length28
3DSecureId String

A unique identifier supplied by the merchant for the authentication.

It is first defined in the check3DSEnrollment operation, and then included in subsequent operations.It is not used when the authentication is performed externally.
Data consists of ASCII characters
Min length:1
Max length:64
airline Object

Airline industry specific data.

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

Itinerary details

leg Object

Travel leg details.

carrierCode

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

Date of departure for the trip leg.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd
departureTax 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 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 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 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 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 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 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 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 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 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 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 Boolean

Indicates if a stopover is permitted for the trip leg.

JSON boolean values 'true' or 'false'.
taxes 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 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 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 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 Object

Passenger details

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

Frequent Flyer or Loyalty Program number for this passenger.

Data can consist of any characters
Min length:1
Max length:20
lastName 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 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 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 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 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 Object

Ticket details

conjunctionTicketIndicator 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.
JSON boolean values 'true' or 'false'.
eTicket Boolean

Indicates if an electronic ticket was issued.

JSON boolean values 'true' or 'false'.
exchangedTicketNumber 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 Object

Ticket issue information.

address String

The address where the ticket was issued.

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

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

The date the ticket was issued.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd
travelAgentCode 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 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 Boolean

Indicates if the issued ticket is refundable.

JSON boolean values 'true' or 'false'.
ticketNumber 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 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 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 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 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
authorizationResponse Object

Authorisation response fields for a standalone capture request.

avsCode String

The acquirer AVS response code generated by the card issuing institution.

Data consists of ASCII characters
Min length:1
Max length:100
cardLevelIndicator String

Indicates the card level result returned by the issuer.

Data can consist of any characters
Min length:1
Max length:2
cardSecurityCodeError String

CSC Incorrect Indicator.

An indicator, provided by the Issuer in the authorization response, to identify the presence of an invalid card security code (CSC). If there is an error, the Issuer will respond with the 1-byte CSC Error Code (Y).
Data can consist of any characters
Min length:1
Max length:1
commercialCard String

Indicates if the card used is a commercial card.

Data can consist of any characters
Min length:1
Max length:3
commercialCardIndicator String

Indicates the type of commercial card as returned by the card issuer.

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

Indicates the code of the financial network that was used to process the transaction with the issuer.

Data can consist of any characters
Min length:1
Max length:3
financialNetworkDate String

The date for the Authorization as returned by the financial network.

For transactions processed via the MasterCard Network this is the MasterCard Network Reference Date.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
marketSpecificData String

Indicates the market or the industry associated with the payment.

For example, B may indicate "bill payment" depending on the acquirer.
Data can consist of any characters
Min length:1
Max length:1
returnAci String

The ACI (Authorization Characteristics Indicator) returned by the issuer.

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

The unique identifier for the transaction returned by the issuer.

Data can consist of any characters
Min length:1
Max length:15
validationCode String

The validation code returned by the issuer.

This value must be stored to be sent with the capture transaction.
Data can consist of any characters
Min length:1
Max length:4
billing Object

Details of the payer's billing address.

address Object

The payer's billing address.

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

The city portion of the address.

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

The name of the company associated with this address.

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

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

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

The post code or zip code of the address.

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

The state or province of the address.

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

The first line of the address.

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

The second line of the address (if provided).

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

Information about any constraints that apply to this transaction.

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

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

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

The allowable number of deferral months for the payment plan.

JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Min value:0
Max value:99
numberOfPayments Number

The allowable number of installments for the payment plan.

JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Min value:1
Max value:99
supported String

The identifiers for the payment plans supported for this transaction.

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

See Payment Plans for the supported payment plans and their identifiers.
Data can consist of any characters
Min length:1
Max length:40
correlationId String

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Data can consist of any characters
Min length:1
Max length:100
currencyConversion Object

Information specific to the use of dynamic currency conversion (DCC).

If you requested a rate quote via the gateway, provide the requestId as returned in the PAYMENT_OPTIONS_INQUIRY response. For rate quote requests performed outside the gateway, you must at least provide payer amount, payer currency, provider and payer exchange rate.

You can only provide DCC information on the initial transaction for an order. If provided on subsequent transactions or an order, DCC information will be ignored.
exchangeRateTime

The timestamp of when the conversion rate is effective.

The timestamp may need to be displayed to the payer on the merchant site to satisfy regulatory requirements.
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
marginPercentage Number

The foreign exchange markup applied as a percentage to the transaction amount for providing the conversion service.

The margin percentage may need to be displayed to the payer on the merchant site to satisfy regulatory requirements.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:8
payerAmount Number

The total amount of the transaction in the payer's currency.

You must include this field if the payer accepted the DCC offer you presented to them.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
payerCurrency String

The currency of the DCC rate quote provided by your DCC Service Provider.

The currency must be expressed as an ISO 4217 alpha code, e.g. USD and must be different to that provided for transaction currency. You must include this field if the payer accepted the DCC offer you presented to them.
Data must consist of the characters A-Z
Min length:3
Max length:3
payerExchangeRate Number

The exchange rate used to convert the transaction amount into the payer's currency.

The payer exchange rate includes the foreign exchange markup (marginPercentage). The payer exchange rate is displayed to the payer on the merchant site.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:19
provider String

This identifies the name of the provider of the DCC quote.

This data is for information purposes, and may be useful if you use multiple DCC providers.
Value must be a member of the following list. The values are case sensitive.
FEXCO
TRAVELEX_CURRENCY_SELECT
providerReceipt String

The quote provider's unique reference to the rate quote.

Data can consist of any characters
Min length:1
Max length:100
requestId String

The unique identifier for your DCC quote request as returned in the PAYMENT_OPTIONS_INQUIRY response.

Data can consist of any characters
Min length:1
Max length:100
uptake String

Indicates how DCC applies to the order.

If not provided, this value defaults to NOT_REQUIRED.
Value must be a member of the following list. The values are case sensitive.
ACCEPTEDThe payer accepted the DCC offer and pays in their own currency. The conditions of the rate quote are applied in the processing of this transaction.
DECLINEDThe payer declined the DCC offer and pays in your transaction currency.
NOT_AVAILABLEA rate quote was requested, but no DCC offer was provided. For rate quotes via the gateway the PAYMENT_OPTION_INQUIRY response contains a currencyConversion.gatewayCode other than QUOTE_PROVIDED.
NOT_REQUIREDDCC is not required for this transaction.
customer Object

Information associated with the customer's source of transaction.

email String

The email address of the customer.

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

The payer's first name.

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

The payer's last or surname.

Data can consist of any characters
Min length:1
Max length:50
mobilePhone String

The contact person's mobile phone or cell phone number.

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

The phone number of the person to whom the order is being billed.

Data can consist of any characters
Min length:1
Max length:20
device Object

Information associated with the device's source of transaction.

ani String

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

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

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

Data can consist of any characters
Min length:1
Max length:2
browser String

The User-Agent header of the browser the customer used to place the order.

For example, MOZILLA/4.0 (COMPATIBLE; MSIE 5.0; WINDOWS 95)
Data can consist of any characters
Min length:1
Max length:255
fingerprint String

Information collected about a remote computing device for the purpose of providing a unique identifier for the device.

For example, session ID, blackbox ID.
Data can consist of any characters
Min length:1
Max length:4000
hostname String

The name of the server to which the customer is connected.

Data can consist of any characters
Min length:1
Max length:60
ipAddress String

The IP address of the computer used by the customer, in nnn.nnn.nnn.nnn format.

Data can consist of any characters
Min length:7
Max length:15
externalTokenProvider Object

Additional information about the external token repository you are configured with.

These fields are MANDATORY for MerchantLink merchants and must not contain sensitive data.
customData String

Provide the site code required to save card details against a token.

For example: '{"siteCode":"BNE"}'.
Data can consist of any characters
Min length:1
Max length:4000
locale String

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

By default, the language is determined from your configuration. 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.

See Dynamic Currency Conversion for more detail.
Data must be a language identifier or IETF language tag
Min length:2
Max length:5
merchant String REQUIRED

The unique identifier issued to you by your payment provider.

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

Information about the order associated with this transaction.

acceptPartialAmount Boolean

Indicates whether you will accept a payment less than order.amount, e.g. when using a gift card.

If not set or set to FALSE, and the full amount is not available, the transaction will be rejected.
Unless you have been advised by your payment service provider that the gateway supports partial approvals for your acquirer, you can ignore this field.
If the gateway supports partial approvals for your acquirer you must set this field to TRUE else the transaction is rejected by the gateway.
JSON boolean values 'true' or 'false'.
amount Number

The total 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
currency String

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

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

Information about this order that is of interest to you.

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

A note from the payer about this order.

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

The date the payer placed the order.

Data must comply with ISO 8601 extended date format, yyyy-mm-dd. This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
customerReference String

The payer's own reference for the order (for example, the purchase order number).

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Data consists of ASCII characters
Min length:0
Max length:25
description String

Short textual description of the contents of the order.

Data can consist of any characters
Min length:1
Max length:127
discount Object

Information about a price reduction you have applied to the order.

For example, you may apply discounts for trade, employees, bulk purchase, or a sales promotion.
amount Number

The total amount of the discount you have applied to 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
code String

The code you use to identify the reason for the discount.

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

A description of your reason for the discount.

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

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

Use this identifier when referring to this order in subsequent transactions and in retrieval operations. This value must be unique for every order created by your merchant profile.
Data can consist of any characters
Min length:1
Max length:40
item Object

Information about the items the payer purchases with the order.

brand String

The brand of the item.

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

The category of the item.

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

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

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

A short name describing the item.

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

The quantity of the item.

Data is a number between 1 and 9999999999999999 represented as a string.
sku String

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

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

The cost price for the item.

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

The tax amount for the item.

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

The total item amount for the order.

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

The URL to which the gateway will send Webhook notifications when an order is created or updated.

To receive notifications at this URL, you must enable Webhook notifications in Merchant Administration. Ensure the URL is HTTPS
Ensure that the URL begins with 'https' and is longer than 11 characters.
productSKU String

Unique SKU (Stock Keeping Unit) for the single, most expensive product associated with this order.

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Data can consist of any characters
Min length:1
Max length:15
recurringPaymentAgreement String

Your reference to the contract or agreement you have with the payer to process recurring payments.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:30
reference String

The identifier of the order.

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

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

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Data can consist of any characters
Min length:1
Max length:100
shippingAndHandlingAmount Number

The total shipping and handling amount for the order.

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

Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.

These merchants are referred to as your sub-merchants. The sub-merchant's details you provide may be displayed on the payer's cardholder statement. Note that your acquirer may require you to register with the card scheme(s) before allowing you to submit sub-merchant details with a transaction. This data must be on the initial transaction of an order, subsequent transactions with sub-merchant will be rejected.
address Object

The sub-merchant's address.

city String

The city portion of the address.

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

The name of the company associated with this address.

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

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

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

The post code or zip code of the address.

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

The state or province of the address.

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

The first line of the address.

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

The second line of the address (if provided).

Data can consist of any characters
Min length:1
Max length:100
bankIndustryCode Number

Code used by acquirer to describe the business or industry the sub-merchant operates in.

Data is a string that consists of the characters 0-9.
Min length:4
Max length:4
email String

The sub-merchant's email address.

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

Your identifier for the sub-merchant.

You can use this identifier in searches and reports in the gateway.
Data can consist of any characters
Min length:1
Max length:100
phone String

The sub-merchant's phone number

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

The legal name of the sub-merchant.

Data can consist of any characters
Min length:1
Max length:100
tradingName String

The trading name of the sub merchant, also known as doing business as (DBA), operating as or trading as.

For MasterCard transactions the name must not exceed 21 characters. For American Express transactions the name must not exceed 27 characters (or 36 characters including the aggregator name). The trading name may be displayed on the payer's cardholder statement. Therefore if you need to shorten it, use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Min length:1
Max length:100
tax Object

Allows you to provide a breakdown of the types of taxes and amount per type of tax included in order.taxAmount.

amount Number

Provide the amount for this type of tax.

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

Provide the name for the type of tax for order.taxAmount.

Data can consist of any characters
Min length:1
Max length:50
taxAmount Number

The total tax amount for the order.

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

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

This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Data can consist of any characters
Min length:1
Max length:20
walletIndicator String

The wallet indicator as returned by the wallet provider.

Data can consist of any characters
Min length:3
Max length:3
walletProvider String

The wallet provider used to collect the customer's payment details used for this transaction.

Value must be a member of the following list. The values are case sensitive.
AMEX_EXPRESS_CHECKOUTAmex Express Checkout wallet provider.
MASTERPASS_ONLINEMasterPass Online wallet provider.
VISA_CHECKOUTVisa Checkout wallet provider.
partnerSolutionId String

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

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

Information about the payment plan selected by the cardholder.

Payment Plan is a payment option available to cardholders who wish to repay the purchase amount in a number of monthly installments with or without a deferral period.
numberOfDeferrals Number

The number of months for which the payment is deferred.

Data is a number between 0 and 99 represented as a string.
numberOfPayments Number

The number of monthly payments payable by the cardholder.

Data is a number between 1 and 99 represented as a string.
planId String

The identifier for the payment plan.

See Payment Plans for the supported payment plans and their identifiers.
Data can consist of any characters
Min length:1
Max length:40
paymentType String

The payment method the payer wishes to use to pay for this order.

Value must be a member of the following list. The values are case sensitive.
ACH
BANCANET
CARD
GIFT_CARD
GIROPAY
PAYPAL
SOFORT
responseControls Object

Container for fields that control the response returned for the request.

sensitiveData String

Indicates how sensitive data is returned in the response.

Data can consist of any characters
Min length:1
Max length:50
risk Object

Information relevant to risk assessment.

bypassMerchantRiskRules String

The risk rules you wish to bypass when performing risk assessment for an order.

Value must be a member of the following list. The values are case sensitive.
ALL
custom String

Additional data passed to third-party risk assessment providers.

This field is only relevant if you use a third-party risk assessment provider, and you have agreed with them the values to provide (maximum 100 characters in a field name from the set A-Z, a-z, 0-9, maximum 4kB in length of values across all custom risk fields). An example might be:
Field: risk.custom.headOfficeLocation
Value: London UK
Data can consist of any characters
Min length:1
Max length:4000
session Object REQUIRED

Session Information

id String REQUIRED

The identifier of the session

Data consists of ASCII characters
Min length:31
Max length:35
updateStatus String REQUIRED

A summary of the outcome of the last attempt to modify the session.

In order to perform an operation using this session this value must be SUCCESS.
Value must be a member of the following list. The values are case sensitive.
FAILUREThe last attempt to place data into the session was unsuccessful. The session may contain invalid data. A request operation using this session will be rejected by the payment gateway.
NO_UPDATENo attempt has been made to place data into the session. A request operation using this session will be rejected by the payment gateway.
SUCCESSThe last attempt to update the session was successful. You may submit a request operation using this session.
version String REQUIRED

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.

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

Information on the shipping address including the contact details of the addressee.

address Object

The address to which the goods contained in this order are being shipped.

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

The city portion of the address.

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

The name of the company associated with this address.

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

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

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

The post code or zip code of the address.

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

The state or province of the address.

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

The first line of the address.

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

The second line of the address (if provided).

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

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

email String

The contact person's email address.

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

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

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

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

Data can consist of any characters
Min length:1
Max length:50
mobilePhone String

The contact person's mobile phone or cell phone number.

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

The phone number of the person to whom the order is being shipped.

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

The shipping method code to indicate the time frame and the priority of the order.

Value must be a member of the following list. The values are case sensitive.
ELECTRONICElectronic delivery.
GROUNDGround (4 or more days).
OVERNIGHTOvernight (next day).
PRIORITYPriority (2-3 days).
SAME_DAYSame day.
sourceOfFunds Object

The details describing the source of the funds to be used.

For card payments these 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.
provided Object

Information about the source of funds when it is directly provided (as opposed to via a token or session).

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

For ACH payments (sourceOfFunds.type=ACH) you must provide values for all fields within this parameter group, including details about the payers bank account as well as the type of ACH payment.

It is your responsibility to authenticate the payer and obtain authorization from the payer in accordance with the NACHA Operating Rules and Guidelines for the Standard Entry Class (SEC) associated with this payment. For details please refer to https://www.nacha.org/.
accountType String

An indicator identifying the type of bank account.

  • Consumer (checking or savings), or
  • Business

For pre-arranged payments (sourceOfFunds.provided.ach.secCode=PPD) retrieve this information from the payer.

If payments were telephone-initiated (sourceOfFunds.provided.ach.secCode=TEL) or internet-initiated (sourceOfFunds.provided.ach.secCode=WEB) you may choose to limit the payer's options (e.g. only support consumer checking accounts), depending on your type of business (e.g. B2C online webshop).

Value must be a member of the following list. The values are case sensitive.
CONSUMER_CHECKING Consumer Checking Account
CONSUMER_SAVINGSConsumer Savings Account
CORPORATE_CHECKINGBusiness Checking Account
bankAccountHolder String

The name of the bank account holder, as it appears on the account at the receiving financial institution.

Retrieve this information from the payer.
Data can consist of any characters
Min length:1
Max length:28
bankAccountNumber String

The identifier of the bank account at the receiving financial institution.

Retrieve this information from the payer.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-', '/'
Min length:1
Max length:17
routingNumber Number

The identifier of the receiving financial institution.

Also known as:
  • Routing number,
  • Transit number, or
  • ABA number

Retrieve this information from the payer.

See also http://en.wikipedia.org/wiki/Routing_transit_number.

Data is a string that consists of the characters 0-9.
Min length:9
Max length:9
secCode String

Identifies the Standard Entry Class (SEC) code to be sent to the issuer.

The SEC is defined by NACHA and describes the origin and intent of the payment. For details please refer to https://www.nacha.org/.
Value must be a member of the following list. The values are case sensitive.
PPDAn ACH debit or credit payment (B2C) that has been authorized by an authenticated customer in written form (signed or similarly authenticated). PPD is used for pre-arranged payments (e.g. employee payroll, mortgage payments, expense reimbursement).
TELAn ACH debit payment (B2C) that has been authorized by an authenticated customer via phone. TEL may only be used if a relationship already exists between you and the consumer, or, the consumer initiates the contact with you.
WEBAn ACH debit payment (B2C) that has been authorized by an authenticated customer via the internet or a wireless network.
card Object

Details as shown on the card.

accountType String

You can provide this field for card types that have a savings/checking option, such as Maestro cards.

If you do not provide a value, we will use the acquirer's default. You can use paymentTypes.card.cardTypes in the 'Retrieve Payment Options' operation response to determine the card type.
Value must be a member of the following list. The values are case sensitive.
CHECKING
SAVINGS
expiry Object

Expiry date, as shown on the card.

month Number

Month, as shown on the card.

Months are numbered January=1, through to December=12.
Data is a number between 1 and 12 represented as a string.
year Number

Year, as shown on the card.

The Common Era year is 2000 plus this value.
Data is a string that consists of the characters 0-9.
Min length:2
Max length:2
nameOnCard String

The cardholder's name as printed on the card.

Data can consist of any characters
Min length:1
Max length:256
number Number

Credit card number as printed on the card.

Data is a string that consists of the characters 0-9.
Min length:9
Max length:19
prefix Number

The first 6 digits of the card number up to a maximum of 9 digits, as printed on the card.

Data is a string that consists of the characters 0-9.
Min length:6
Max length:9
securityCode Number

Card verification code, as printed on the back or front of the card.

Data is a string that consists of the characters 0-9.
Min length:3
Max length:4
sequenceNumber Number

The card sequence number for transactions where the data is read through a chip on the EMV card.

Data is a number between 0 and 999 represented as a string.
giftCard Object

If the payer chose to pay using a gift card, you must submit sourceOfFunds.type=GIFT_CARD and provide the payer's gift card details in this parameter group.

expectedLocalBrand String

Do not provide this field in your request unless instructed to do so by your payment service provider.

The field is required, if your gift card numbers do not use ISO BIN rules and therefore not allowing the gateway to identify the local brand.
Data can consist of any characters
Min length:4
Max length:50
number Number

Card number as printed or embossed on the gift card.

Data is a string that consists of the characters 0-9.
Min length:9
Max length:19
pin Number

PIN number for the gift card.

Data is a string that consists of the characters 0-9.
Min length:4
Max length:8
token String

Uniquely identifies a card and associated details.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:40
type String

The payment method your payer has chosen for this payment.

Value must be a member of the following list. The values are case sensitive.
ACHThe payer chose to pay using an electronic fund transfer, to be processed via the Automated Clearing House (ACH) Network. You must provide the payer's bank account details and information about the type of ACH payment under the sourceOfFunds.provided.ach parameter group.
CARDThe payer selected to pay using a credit or debit card. The payer's card details must be provided.
GIFT_CARDThe payer chose to pay using gift card. The payer's gift card details must be provided under the sourceOfFunds.provided.giftCard parameter group.
token String

Uniquely identifies a card and associated details.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:40
transaction Object

Information about this transaction.

acquirer Object

Additional information to be passed to acquirer.

customData String

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

This field must not contain sensitive data.
Data can consist of any characters, but sensitive data will be rejected
Min length:1
Max length:2048
amount Number

Transaction Amount.

Expressed as a decimal number in the units of the currency. For example 12.34 in USD is the amount 12 dollars and 34 cents.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
authorizationCode String

Value generated by the issuing bank in response to a proposal to transfer funds.

Data may consist of the characters 0-9, a-z, A-Z
Min length:1
Max length:6
cashAdvance Boolean

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

JSON boolean values 'true' or 'false'.
currency String

The currency which should be used for acquirer card verification.

Not required for basic verification.
Data must consist of the characters A-Z
Min length:3
Max length:3
frequency String

Indicates the frequency of the transaction offered to the payer.

Value must be a member of the following list. The values are case sensitive.
INSTALLMENTIndicates an installment transaction where the payer authorizes you to deduct multiple payments over an agreed period of time for a single purchase.
RECURRINGIndicates a recurring transaction where the payer authorizes you to automatically debit their accounts for bill or invoice payments.
SINGLEIndicates a single transaction where a single payment is used to complete the order.
id String

Unique identifier for this transaction to distinguish it from any other transactions on the order.

Data can consist of any characters
Min length:1
Max length:40
item Object

Information about the items the payer purchases with the order.

brand String

The brand of the item.

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

The category of the item.

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

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

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

A short name describing the item.

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

The quantity of the item.

Data is a number between 1 and 9999999999999999 represented as a string.
sku String

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

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

The cost price for the item.

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

The tax amount for the item.

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

Your note about this transaction.

Data can consist of any characters
Min length:1
Max length:250
priorApproval String

Indicates that a transaction requires approval to proceed with the order.

Value must be a member of the following list. The values are case sensitive.
REQUESTEDRequested
reference String

An optional identifier for this transaction.

Data can consist of any characters
Min length:1
Max length:40
source String

Indicates the source through which you received the transaction.

Value must be a member of the following list. The values are case sensitive.
CALL_CENTRETransaction conducted via a call centre.
CARD_PRESENTTransaction where the card is presented to the merchant.
INTERNETTransaction conducted over the Internet.
MAIL_ORDERTransaction received by mail.
MOTOTransaction received by mail or telephone.
TELEPHONE_ORDERTransaction received by telephone.
VOICE_RESPONSETransaction conducted by a voice/DTMF recognition system.
targetTransactionId String

The identifier for the transaction you wish to refund.

That is the {transactionId} URL field for REST and the transaction.id field for NVP.

If you do not provide a target transaction ID the gateway will try to identify a transaction. If no transaction can be found or more than one transaction is identified, the request is rejected.
Data can consist of any characters
Min length:1
Max length:40
tax Object

Allows you to provide a breakdown of the types of taxes and amount per type of tax included in transaction.taxAmount.

amount Number

Provide the amount for this type of tax.

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

Provide the name for the type of tax for transaction.taxAmount.

Data can consist of any characters
Min length:1
Max length:50
taxAmount Number

The amount of tax included in this transaction, if different to the default value.

The default value for a full capture is the Order.taxAmount. The default value for a full refund is the total tax captured on the order. Expressed as a decimal number in the units of the currency. For example 12.34 in USD is the amount 12 dollars and 34 cents. This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Min length:1
Max length:14
transactionSource String

The source through which the order has been received.

For example, INTERNET, MOTO.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRETransaction conducted via a call centre.
CARD_PRESENTTransaction where the card is presented to the merchant.
INTERNETTransaction conducted over the Internet.
MAIL_ORDERTransaction received by mail.
MOTOTransaction received by mail or telephone.
TELEPHONE_ORDERTransaction received by telephone.
VOICE_RESPONSETransaction conducted by a voice/DTMF recognition system.
userId String

The person who initiated this transaction.

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

The strategy used to verify the payment instrument details before they are stored.

You only need to specify the verification strategy if you want to override the default value configured for your merchant profile. When the verification strategy is BASIC or ACQUIRER you must also provide the card expiry date in the sourceOfFunds.provided.card.expiry parameter group.
Used to nominate which type of Verification to use when payment instrument details are stored in the token repository. This setting overrides the default settings in Merchant Manager.
Value must be a member of the following list. The values are case sensitive.
ACQUIRERThe gateway performs a Web Services API Verify request. Depending on the payment type, you may need to provide additional details to enable the submission of a Verify request.
BASICThe gateway verifies the syntax and supported ranges of the payment instrument details provided, .e.g for a card it validates the card number format and checks if the card number falls within a valid BIN range.
NONEThe gateway does not perform any validation or verification of the payment instrument details provided.
wallet Object
amexExpressCheckout Object

Provide the details for the Amex Express Checkout Wallet.

wallet Object
amexExpressCheckout Object
authCode String

An Amex Express Checkout authorization code.

You need this to get the customer details from Amex Express Checkout.Get this value from the Amex Express Checkout Success callback, after the Amex Express Checkout interaction is completed.
Data can consist of any characters
Min length:1
Max length:100
wallet Object
amexExpressCheckout Object
selectedCardType String

The type of card the payer selects for the payment.

Get this value from the Amex Express Checkout Success callback, after the Amex Express Checkout interaction is completed..
Data can consist of any characters
Min length:1
Max length:10
wallet Object
amexExpressCheckout Object
transactionId String

A unique identifier provided for end to end tracking of an Amex Express Checkout interaction.

Get this value from the Amex Express Checkout Success callback, after the Amex Express Checkout interaction is completed.
Data can consist of any characters
Min length:1
Max length:36
wallet Object
amexExpressCheckout Object
walletId String

The identifier of the wallet from which the payer selects their card.

Get this value from the Amex Express Checkout Success callback, after the Amex Express Checkout interaction is completed.
Data can consist of any characters
Min length:1
Max length:2
masterpass Object

Response fields from MasterPass operations.

wallet Object
masterpass Object
allowedCardTypes String

The card types supported for the merchant.

You provide this value when you initiate a MasterPass interaction to limit the card types that the payer can select to those supported by the merchant.
Data can consist of any characters
Min length:1
Max length:255
wallet Object
masterpass Object
checkoutUrl

The MasterPass URL the gateway will use to retrieve the cardholder's payment details into the session.

Ensure that the URL begins with 'https' and is longer than 11 characters.
wallet Object
masterpass Object
longAccessToken String

A wallet token provided by the gateway for Masterpass paired accounts.

Save this token and use it in the Retrieve Wallet Options request to obtain pre-checkout data from the payer's wallet for future interactions.
Data can consist of any characters
Min length:1
Max length:255
wallet Object
masterpass Object
merchantCheckoutId String

The merchant's MasterPass Checkout Identifier required to initiate a MasterPass wallet interaction.

You provide this value on order to initiate a MasterPass interaction.
Data can consist of any characters
Min length:1
Max length:255
wallet Object
masterpass Object
oauthToken String

Provide the value of the field oauthToken as returned by the MasterPass lightbox.

The gateway will use this, to retrieve the payer's payment details for the respective interaction from MasterPass and store them against the payment session (identified in field session.id). Mandatory for the MASTERPASS_ONLINE Wallet Provider.
Data can consist of any characters
Min length:1
Max length:255
wallet Object
masterpass Object
oauthVerifier String

Provide the value of the field oauthVerifier as returned by the MasterPass lightbox.

The gateway will use this, to retrieve the payer's payment details for the respective interaction from MasterPass and store them against the payment session (identified in field session.id). Mandatory for the MASTERPASS_ONLINE Wallet Provider.
Data can consist of any characters
Min length:1
Max length:255
wallet Object
masterpass Object
originUrl

The URL of the page that will initialize the MasterPass lightbox.

Ensure that the URL begins with 'https' and is longer than 11 characters.
wallet Object
masterpass Object
payerAuthentication String

Indicates whether payer authentication is required for the MasterPass Express Checkout interaction.

Value must be a member of the following list. The values are case sensitive.
NOT_REQUIREDThis operation does not require further payer authentication.
REQUIREDThis operation requires further payer authentication.
wallet Object
masterpass Object
requestToken String

The MasterPass request token required to initiate a MasterPass wallet interaction.

You provide this value in order to initiate a MasterPass interaction.
Data can consist of any characters
Min length:1
Max length:255
wallet Object
masterpass Object
secondaryOriginUrl

The URL of the outer or parent page that will initialize the MasterPass lightbox.

Provide this field only when the Lightbox will be invoked from a frame that's on a merchant site, and when that frame has a different domain than the merchant site.
Ensure that the URL begins with 'https' and is longer than 11 characters.
masterpassExpressCheckout Object

Parameters used to obtain wallet details from MasterPass for an Express Checkout interaction.

The wallet details are added to the session.
wallet Object
masterpassExpressCheckout Object
longAccessToken String

A wallet token provided by the gateway for Masterpass paired accounts.

Provide this token to obtain pre-checkout data from the payer's wallet for future interactions.
Data can consist of any characters
Min length:1
Max length:255
wallet Object
masterpassExpressCheckout Object
masterpassCardId String

The MasterPass identifier for the card.

Provide this value to MasterPass in the cardId parameter when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Data can consist of any characters
Min length:1
Max length:255
wallet Object
masterpassExpressCheckout Object
masterpassShippingId String

The MasterPass identifier for the shipping address.

Provide this value to MasterPass in the shippingId parameter when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Data can consist of any characters
Min length:1
Max length:255
wallet Object
masterpassExpressCheckout Object
originUrl

The URL of the page that will initialize the MasterPass lightbox.

Ensure that the URL begins with 'https' and is longer than 11 characters.
wallet Object
masterpassExpressCheckout Object
precheckoutTransactionId String

A MasterPass transaction identifier.

Provide this value to MasterPass when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Data can consist of any characters
Min length:1
Max length:50
wallet Object
masterpassExpressCheckout Object
secondaryOriginUrl

The URL of the outer or parent page that will initialize the MasterPass lightbox.

Provide this field only when the Lightbox will be invoked from a frame that's on a merchant site, and when that frame has a different domain than the merchant site.
Ensure that the URL begins with 'https' and is longer than 11 characters.
visaCheckout Object

Response fields from Visa Checkout Open Wallet operation.

wallet Object
visaCheckout Object
callId String

Provide the value of the field callId as returned by the Visa Checkout lightbox.

The gateway will use this, to retrieve the payer's payment details for the respective interaction from Visa Checkout and store them against the payment session (identified in field session.id). Mandatory for the VISA_CHECKOUT Wallet Provider.
Data can consist of any characters
Min length:1
Max length:48
wallet Object
visaCheckout Object
cardArts String

Card artwork details as returned by Visa Checkout, including the URL of the card art, and height and width of the card art in pixels, for example {"cardArt":[{"baseImageFileName":"<Image URL>","height":50,"width":77}]}.

Data can consist of any characters
Min length:1
Max length:200
wallet Object
visaCheckout Object
cardBrand String

Card brand returned by Visa Checkout indicating the card brand selected by the payer at Visa Checkout.

Data can consist of any characters
Min length:1
Max length:50

Return Value

None