NTRSCreateTokenReqType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

NTRSCreateTokenReqType

All

Block1 NTRSCreateTokenReqBlock1Type Complex Type

Contains a series of required and optional elements

All

CardData CardDataType Complex Type

A common element used in several different transactions for supplying payment method information.

This includes a choice of typical payment representations like track data, manually entered data, and token information. It also includes options for specifying how the supplied data has been encrypted or to request a multi-use token be supplied in the response.

Sequence

Choice

TrackData CardDataTypeTrackData Complex Type

Track data is the full magnetic stripe data.

Note: TrackData is unique in that it has an attribute "method" that is used to indicate how the associated data was obtained.

ManualEntry

This is typically manually entered card data, but can be used in any case where only the card number is used rather than the full track.

TokenData

This is used when the card number from a previous transaction has been tokenized. This supports both multi-use and single-use tokens.

EncryptionData optional EncryptionDataType Complex Type

If the supplied card data was encrypted, this must be supplied.

TokenRequest optional booleanType Simple Type

This is used to request the gateway to return a multi-use token for the supplied card data. If a token is provided in the card data and this flag is set, it will be echoed in the response.

TokenParameters optional TokenParametersType Complex Type

Parameters allowing the client to control aspects of how a requested multi-use token is generated.

Not Applicable for Reward Cash transactions.

ConsumerId optional Restriction of xs:string

Unique token requestor specific consumer identifier (e.g. wallet account ID).

NTRSDeviceData NTRSDeviceDataType Complex Type

Data related to the user's browser or mobile device.

All

NTRSDeviceType optional Restriction of xs:string

The type of the user's browser or mobile device. It has pre-defined values.

Valid values PHONE, TABLET, PHONE_TABLET, PC, WATCH, TV, WEARABLE_DEVICE, AUTOMOBILE_DEVICE, SERVER, CARD, STICKER, DEVICE_PERIPHERAL, TAG, JEWELRY, FASHION_ACCESSORY, GARMENT, DOMESTIC_APPLIANCE, MEDIA_GAMING_DEVICE, OTHER

NTRSDevicePlatform optional Restriction of xs:string

The operating system of the user's browser or mobile device

Valid values ANDROID, IOS, WINDOWS, BLACKBERRY, TIZEN, WEB, PAGARE_EMBEDDED_OS, ANDROID_WEAR, EMBEDDED_OS, OTHER

OsVersion optional Restriction of xs:string

The version of the operating system of the user's browser or mobile device.

NTRSDeviceLanguage optional Restriction of xs:string

The language that the application communicates with the cardholder.

NTRSDeviceLocale Restriction of xs:string

The language that the application communicates with the cardholder. It is based on BCP 47 standard. The language must be lowercase and the country must be uppercase. The language and country should be separated using a hyphen (-)

NTRSDeviceName optional Restriction of xs:string

The name of the target provisioned device

NTRSDeviceLocation optional Restriction of xs:string

The latitude and longitude coordinates of the user's browser or mobile device location (no decimals provided)

NTRSDeviceLocationExtended optional Restriction of xs:string

The latitude and longitude coordinates of the target device location including up to two decimal places

NTRSDevicePhoneNumber optional Restriction of xs:string

The telephone number or the last few digits of the telephone number

NTRSDeviceIp optional Restriction of xs:string

The IP address of the user's browser or mobile device

Brand optional Restriction of xs:string

The brand of the user's browser or mobile device

Manufacturer optional Restriction of xs:string

The version of the operating system of the user's browser or mobile device

Model optional Restriction of xs:string

The model of the user's browser or mobile device

NetworkType optional Restriction of xs:string

The type of network

Vald values WIFI, CELLULAR, GPS, OTHER, DSL

ImeiNumber optional Restriction of xs:string

The IMEI number of the device

NTRSDeviceTimeZone optional Restriction of xs:string

The time zone of the user's browser or mobile device

WalletAccountEmail Restriction of xs:string

The email address of the client that is linked to his wallet account login

NTRSRiskData optional NTRSRiskDataType Complex Type

Risk related data. It SHOULD NOT be sent if the CardPresent = False.

All

NTRSWalletData optional NTRSWalletDataType Complex Type

Risk data of the wallet.

NTRSCardData optional NTRSCardDataDataType Complex Type

Risk data of the card.

NTRSDeviceData optional NTRSDeviceDataDataType Complex Type

NTRS device risk data.

NTRSUserData optional NTRSUserDataDataType Complex Type

Risk data of the user.

CardHolderData optional CardHolderDataDataType Complex Type

Cardholder-related data.

All

CardHolderFirstName optional Restriction of xs:string

The firstname of the cardholder.

CardHolderLastName optional Restriction of xs:string

The lastname of the cardholder.

CardHolderAddr optional Restriction of xs:string

Billing address of the cardholder.

CardHolderCity optional Restriction of xs:string

City.

CardHolderState optional Restriction of xs:string

State.

CardHolderZip optional Restriction of xs:string

Postal Code.

CardHolderCountryCode optional Restriction of xs:string

Country Code.

Used By

NTRSCreateToken Element

Source

<xs:complexType name="NTRSCreateTokenReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="Block1" type="NTRSCreateTokenReqBlock1Type">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains a series of required and optional elements</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:all>
</xs:complexType>