Retrieve Session

Request to obtain the request fields contained in the session

POST https://na.gateway.spring.citi.com/api/nvp/version/19

Authentication

This operation requires authentication via one of the following methods:


  • Certificate authentication.
  • To authenticate to the API two additional NVP parameters must be supplied in the request. Provide 'merchant.<your gateway merchant ID>' in the apiUsername field and your API password in the apiPassword field.

Request

Fields

apiOperation String = RETRIEVE_SESSION FIXED

Any sequence of zero or more unicode characters.

correlationId String OPTIONAL

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
merchant Alphanumeric + additional characters 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
responseControls OPTIONAL

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

responseControls.sensitiveData String OPTIONAL

Indicates how sensitive data is returned in the response.

Data can consist of any characters

Min length: 1 Max length: 50
session.id ASCII Text REQUIRED

The identifier of the payment session

Data consists of ASCII characters

Min length: 31 Max length: 35

Response

Fields

3DSecure CONDITIONAL

Information on 3DSecure fields.

3DSecure.acsEci Digits CONDITIONAL

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
3DSecure.authenticationRedirect CONDITIONAL

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.

3DSecure.authenticationRedirect.pageGenerationMode Enumeration CONDITIONAL

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.

CUSTOMIZED

A strategy to indicate that the user wishes to customize the response

SIMPLE

A simple interaction model where the response is complete and no user intervention is required.

3DSecure.authenticationRedirect.responseUrl Url CONDITIONAL

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.

3DSecure.authenticationRedirect.simple CONDITIONAL

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

3DSecure.authenticationRedirect.simple.expectedHtmlEncoding Enumeration CONDITIONAL

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_1

Latin1

UTF_8
3DSecure.authenticationRedirect.simple.redirectDisplayBackgroundColor Alphanumeric + additional characters CONDITIONAL

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
3DSecure.authenticationRedirect.simple.redirectDisplayContinueButtonText String CONDITIONAL

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
3DSecure.authenticationRedirect.simple.redirectDisplayTitle String CONDITIONAL

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
3DSecure.authenticationStatus Enumeration CONDITIONAL

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_ATTEMPTED

Authentication was attempted but the card issuer did not perform the authentication.

AUTHENTICATION_NOT_AVAILABLE

An internal error occurred and Authentication is not currently available.

AUTHENTICATION_SUCCESSFUL

The cardholder was successfully authenticated.

3DSecure.authenticationToken Base64 CONDITIONAL

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 lengths 28 or 32
3DSecure.enrollmentStatus Enumeration CONDITIONAL

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.

ENROLLED

The card is enrolled for 3DS authentication.

ENROLLMENT_STATUS_UNDETERMINED

The Issuer's ACS was unable to process the request to check enrollment or the card is ineligible.

NOT_ENROLLED

The card is not enrolled for 3DS authentication.

3DSecure.goodsDescription String CONDITIONAL

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
3DSecure.xid Base64 CONDITIONAL

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 length 28
3DSecureId ASCII Text CONDITIONAL

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 CONDITIONAL

Information about any actions which apply to this transaction.

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

action.bypassMerchantRiskRules Enumeration CONDITIONAL

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

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

billing.address CONDITIONAL

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.

billing.address.city String CONDITIONAL

The city portion of the address.

Data can consist of any characters

Min length: 1 Max length: 100
billing.address.country Upper case alphabetic text CONDITIONAL

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
billing.address.postcodeZip Alphanumeric + additional characters CONDITIONAL

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
billing.address.stateProvince String CONDITIONAL

The state or province of the address.

Data can consist of any characters

Min length: 1 Max length: 20
billing.address.street String CONDITIONAL

The first line of the address.

For example, this may be the street name and number, or the Post Office Box details.

Note: The transaction response will contain a concatenation of street and street2 data. If the concatenated value is more than the maximum field length, street2 data will be truncated.

Data can consist of any characters

Min length: 1 Max length: 100
billing.address.street2 String CONDITIONAL

The second line of the address (if provided).

Note: This field will be empty in the transaction response, as street2 data will be concatenated into the street field.

Data can consist of any characters

Min length: 1 Max length: 100
billing.phone String CONDITIONAL

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

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.

constraints.paymentPlans CONDITIONAL

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.

constraints.paymentPlans.numberOfDeferrals Integer CONDITIONAL

The allowable number of deferral months for the payment plan.

A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)

Min value: 0 Max value: 99
constraints.paymentPlans.numberOfPayments Integer CONDITIONAL

The allowable number of installments for the payment plan.

A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)

Min value: 1 Max value: 99
constraints.paymentPlans.supported[n] String CONDITIONAL

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 CONDITIONAL

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 CONDITIONAL

Information associated with the customer's source of transaction.

customer.ani String CONDITIONAL

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
customer.aniCallType String CONDITIONAL

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
customer.browser String CONDITIONAL

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
customer.email Email CONDITIONAL

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

customer.hostname String CONDITIONAL

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

Data can consist of any characters

Min length: 1 Max length: 60
customer.ipAddress String CONDITIONAL

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
merchant Alphanumeric + additional characters ALWAYS PROVIDED

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 CONDITIONAL

Information about the order associated with this transaction.

order.amount Decimal CONDITIONAL

The total amount for the order.

If you supply this value then you must provide order.currency to filter the response values.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.

Min length: 1 Max length: 14
order.currency Upper case alphabetic text CONDITIONAL

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
order.custom String CONDITIONAL

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
order.customerNote String CONDITIONAL

A note from the payer about this order.

Data can consist of any characters

Min length: 1 Max length: 250
order.customerOrderDate Date CONDITIONAL

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.

order.customerReference ASCII Text CONDITIONAL

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
order.description String CONDITIONAL

Short textual description of the contents of the order.

Data can consist of any characters

Min length: 1 Max length: 127
order.id String CONDITIONAL

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
order.item[n] CONDITIONAL

Information about the items the payer purchases with the order.

order.item[n].description String CONDITIONAL

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
order.item[n].name String CONDITIONAL

A short name describing the item.

Data can consist of any characters

Min length: 1 Max length: 127
order.item[n].quantity Digits CONDITIONAL

The quantity of the item.

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

order.item[n].sku String CONDITIONAL

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

Data can consist of any characters

Min length: 1 Max length: 127
order.item[n].unitPrice Decimal CONDITIONAL

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
order.item[n].unitTaxAmount Decimal CONDITIONAL

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
order.itemAmount Decimal CONDITIONAL

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
order.notificationUrl Url CONDITIONAL

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.

order.productSKU String CONDITIONAL

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
order.reference String CONDITIONAL

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
order.requestorName String CONDITIONAL

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
order.shippingAndHandlingAmount Decimal CONDITIONAL

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
order.taxAmount Decimal CONDITIONAL

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
order.taxRegistrationId String CONDITIONAL

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

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 CONDITIONAL

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.

paymentPlan.numberOfDeferrals Digits CONDITIONAL

The number of months for which the payment is deferred.

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

paymentPlan.numberOfPayments Digits CONDITIONAL

The number of monthly payments payable by the cardholder.

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

paymentPlan.planId String CONDITIONAL

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

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.

CREDIT
GIROPAY
PAYPAL
SOFORT
responseControls CONDITIONAL

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

responseControls.sensitiveData String CONDITIONAL

Indicates how sensitive data is returned in the response.

Data can consist of any characters

Min length: 1 Max length: 50
session ALWAYS PROVIDED

Session Information

session.id ASCII Text ALWAYS PROVIDED

The identifier of the session

Data consists of ASCII characters

Min length: 31 Max length: 35
session.status Enumeration ALWAYS PROVIDED

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.

CREATED

The session was successfully created using the Create Session operation.

INVALID

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

LOCKED

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

VALID

All the values for the request fields contained in the session are valid. You can successfully submit an operation request using this session.

shipping CONDITIONAL

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

shipping.address CONDITIONAL

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.

shipping.address.city String CONDITIONAL

The city portion of the address.

Data can consist of any characters

Min length: 1 Max length: 100
shipping.address.country Upper case alphabetic text CONDITIONAL

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
shipping.address.postcodeZip Alphanumeric + additional characters CONDITIONAL

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
shipping.address.stateProvince String CONDITIONAL

The state or province of the address.

Data can consist of any characters

Min length: 1 Max length: 20
shipping.address.street String CONDITIONAL

The first line of the address.

For example, this may be the street name and number, or the Post Office Box details.

Note: The transaction response will contain a concatenation of street and street2 data. If the concatenated value is more than the maximum field length, street2 data will be truncated.

Data can consist of any characters

Min length: 1 Max length: 100
shipping.address.street2 String CONDITIONAL

The second line of the address (if provided).

Note: This field will be empty in the transaction response, as street2 data will be concatenated into the street field.

Data can consist of any characters

Min length: 1 Max length: 100
shipping.firstName String CONDITIONAL

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
shipping.lastName String CONDITIONAL

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
shipping.method Enumeration CONDITIONAL

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.

ELECTRONIC

Electronic delivery.

GROUND

Ground (4 or more days).

OVERNIGHT

Overnight (next day).

PRIORITY

Priority (2-3 days).

SAME_DAY

Same day.

shipping.phone String CONDITIONAL

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

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.

sourceOfFunds.provided CONDITIONAL

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.

sourceOfFunds.provided.card CONDITIONAL

Details as shown on the card.

sourceOfFunds.provided.card.expiry CONDITIONAL

Expiry date, as shown on the card.

sourceOfFunds.provided.card.expiry.month Digits CONDITIONAL

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.

sourceOfFunds.provided.card.expiry.year Digits CONDITIONAL

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
sourceOfFunds.provided.card.holder CONDITIONAL

The payer's name, to whom the bill is being sent.

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

sourceOfFunds.provided.card.holder.firstName String CONDITIONAL

The payer's first name.

Data can consist of any characters

Min length: 1 Max length: 50
sourceOfFunds.provided.card.holder.lastName String CONDITIONAL

The payer's last or surname.

Data can consist of any characters

Min length: 1 Max length: 50
sourceOfFunds.provided.card.number Digits CONDITIONAL

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
sourceOfFunds.provided.card.provided.card.prefix Digits CONDITIONAL

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
sourceOfFunds.provided.card.securityCode Digits CONDITIONAL

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
sourceOfFunds.provided.card.sequenceNumber Digits CONDITIONAL

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.

sourceOfFunds.token Alphanumeric CONDITIONAL

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
sourceOfFunds.type Enumeration CONDITIONAL

The payment method your payer has chosen for this payment.

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

CARD

The customer selected to pay using a credit or debit card. The payer's card details must be provided.

token Alphanumeric CONDITIONAL

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 CONDITIONAL

Details of the transaction

transaction.acquirer CONDITIONAL

Additional information to be passed to acquirer.

transaction.acquirer.customData String CONDITIONAL

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
transaction.amount Decimal CONDITIONAL

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
transaction.authorizationCode Alphanumeric CONDITIONAL

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
transaction.cashAdvance Boolean CONDITIONAL

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

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

transaction.currency Upper case alphabetic text CONDITIONAL

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

Data must consist of the characters A-Z

Min length: 3 Max length: 3
transaction.frequency Enumeration CONDITIONAL

Indicates the frequency of the transaction offered to the payer.

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

INSTALLMENT

Indicates an installment transaction where the payer authorizes you to deduct multiple payments over an agreed period of time for a single purchase.

RECURRING

Indicates a recurring transaction where the payer authorizes you to automatically debit their accounts for bill or invoice payments.

SINGLE

Indicates a single transaction where a single payment is used to complete the order.

transaction.id String CONDITIONAL

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
transaction.item[n] CONDITIONAL

Information about the items the payer purchases with the order.

transaction.item[n].description String CONDITIONAL

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
transaction.item[n].name String CONDITIONAL

A short name describing the item.

Data can consist of any characters

Min length: 1 Max length: 127
transaction.item[n].quantity Digits CONDITIONAL

The quantity of the item.

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

transaction.item[n].sku String CONDITIONAL

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

Data can consist of any characters

Min length: 1 Max length: 127
transaction.item[n].unitPrice Decimal CONDITIONAL

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
transaction.item[n].unitTaxAmount Decimal CONDITIONAL

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
transaction.merchantNote String CONDITIONAL

Your note about this transaction.

Data can consist of any characters

Min length: 1 Max length: 250
transaction.reference String CONDITIONAL

An optional identifier for this transaction.

Data can consist of any characters

Min length: 1 Max length: 40
transaction.source Enumeration CONDITIONAL

Indicates the source through which you received the transaction.

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

CALL_CENTRE

Transaction conducted via a call centre.

CARD_PRESENT

Transaction where the card is presented to the merchant.

INTERNET

Transaction conducted over the Internet.

MAIL_ORDER

Transaction received by mail.

MOTO

Transaction received by mail or telephone.

TELEPHONE_ORDER

Transaction received by telephone.

VOICE_RESPONSE

Transaction conducted by a voice/DTMF recognition system.

transaction.targetTransactionId String CONDITIONAL

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
transaction.taxAmount Decimal CONDITIONAL

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

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_CENTRE

Transaction conducted via a call centre.

CARD_PRESENT

Transaction where the card is presented to the merchant.

INTERNET

Transaction conducted over the Internet.

MAIL_ORDER

Transaction received by mail.

MOTO

Transaction received by mail or telephone.

TELEPHONE_ORDER

Transaction received by telephone.

VOICE_RESPONSE

Transaction conducted by a voice/DTMF recognition system.

userId String CONDITIONAL

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
wallet.cancelURL Url CONDITIONAL

The URL to which you want the payer's browser to be redirected if the payer cancels the interaction on the wallet provider's website.

Ensure that the URL begins with 'https' and is longer than 11 characters.

wallet.returnURL Url CONDITIONAL

The URL to which you want the payer's browser to be redirected after completing the interaction on the wallet provider's website.

To check the success or otherwise of the interaction use the Retrieve Session operation.

Ensure that the URL begins with 'https' and is longer than 11 characters.

Errors

error

Information on possible error conditions that may occur while processing an operation using the API.

error.cause Enumeration

Broadly categorizes the cause of the error.

For example, errors may occur due to invalid requests or internal system failures.

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

CONSTRAINT_VIOLATION

The request was rejected due to the request parameters violating the constraints.

INVALID_REQUEST

The request was rejected because it did not conform to the API protocol.

REQUEST_REJECTED

The request was rejected due to security reasons such as firewall rules, expired certificate, etc.

SERVER_BUSY

The server did not have enough resources to process the request at the moment.

SERVER_FAILED

There was an internal system failure.

error.explanation String

Textual description of the error based on the cause.

This field is returned only if the cause is INVALID_REQUEST, SERVER_BUSY or CONSTRAINT_VIOLATION.

Data can consist of any characters

Min length: 1 Max length: 1000
error.field String

Indicates the name of the field that failed validation or has violated the payment constraints.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered; or if the cause is CONSTRAINT_VIOLATION and a field level constraint was violated.

Data can consist of any characters

Min length: 1 Max length: 100
error.supportCode String

Indicates the code that helps the support team to quickly identify the exact cause of the error.

This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.

Data can consist of any characters

Min length: 1 Max length: 100
error.validationType Enumeration

Indicates the type of field validation error.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

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

INVALID

The request contained a field with a value that did not pass validation.

MISSING

The request was missing a mandatory field.

UNSUPPORTED

The request contained a field that is unsupported.

result Enumeration

A system-generated high level overall result of the operation.

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

ERROR

The operation resulted in an error and hence cannot be processed.