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 API 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
action Object

Information about any actions which apply to this transaction.

Specify actions if you wish to change the default behaviour of the transaction.
billing Object

Information on the billing address including the contact details of the payer.

address Object

The address of the payer to whom the order is being billed.

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

The strategy that should be used to verify the card details on the request.

If not provided the verification strategy on the merchant profile will be used to verify the card details on the request.
Used to nominate which type of Card Verification to use when card 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.
ACQUIRERVerifies that the card is valid by performing an Authorize transaction for an nominal amount (e.g.$1.00)
BASICVerifies the card number is valid and that the card number falls within a valid BIN range
NONENo verification of the card details are performed
constraints Object

Information about any constraints which apply to this transaction.

Specify constraints to ensure the transaction conforms to pre-defined criteria. This is useful when your integration does not directly collect all the transaction values. For example, a session based integration or a hosted payment page integration.
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
customer Object

Information associated with the customer'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
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
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
partnerSolutionId String

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

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

Session Information

id String REQUIRED

The identifier of the session

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

Status of the session based on the success or otherwise of the last interaction with the session.

Status of the session based on the success or otherwise of the last interaction with the session.
Value must be a member of the following list. The values are case sensitive.
CREATEDThe session was successfully created using the Create Session operation.
INVALIDOne or more values for the request fields contained in the session are invalid. An operation request using this session will be rejected by the payment gateway.
LOCKEDThe session has been locked for updates because you have submitted an operation request using the session. The card security code has been deleted from the session.
VALIDAll the values for the request fields contained in the session are valid. You can successfully submit an operation request using this session.
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
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
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
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.
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
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
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.

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
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.
CARD_PRESENTTransaction where the card is presented to the merchant.
INTERNETTransaction conducted over the Internet.
MOTOTransaction received by mail or telephone.
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
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.
CARD_PRESENTTransaction where the card is presented to the merchant.
INTERNETTransaction conducted over the Internet.
MOTOTransaction received by mail or telephone.
userId String

The person who initiated this transaction.

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

Return Value

None