PosSendFundsReqType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

PosSendFundsReqType

All

Block1 SendFundsReqBlock1Type Complex Type

contains a series of required and optional elements

All

GatewayTxnId optional txnIdType Simple Type

Gateway-generated transaction identifier returned in the response of the original transaction. This indicates the transaction from which card data will be reused.

Note: When using a prior transaction id, card data should not be sent and original transaction reference data will be required.

x_global_transaction_id optional x_global_transaction_idType Simple Type

Client generated transaction identifier sent in the request of the original transaction.

Note: This is for internal use only.

CardData optional SendFundCardDataType 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.

EncryptionData optional EncryptionDataType Complex Type

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

Amt amtTypeGlobal Simple Type

The amount requested for authorization; this includes all other "Info" amounts provided as part of this request.

AmountIndicator optional amountIndicatorType Simple Type

Valid values include:

'E' indicates that Amt is an estimated amount
'F' indicates the Amt is final

Note: In the case of 'F', the Amt should not be manipulated and no CreditIncrementalAuth should be ran.

CardHolderData optional CardHolderDataType Complex Type

Card holder data

All

CardHolderFirstName optional firstNameType Simple Type

First name

CardHolderLastName optional lastNameType Simple Type

Last name

CardHolderAddr optional addrType Simple Type

Address

CardHolderCity optional cityType Simple Type

City

CardHolderState optional stateType Simple Type

State

CardHolderZip optional zipType Simple Type

Zip or postal code; see the associated Type pattern for restrictions.

Note: Canadian postal codes should be sent in the format "A0A0A0".

CardHolderPhone optional phoneType Simple Type

Phone number; see the associated Type pattern for restrictions.

CardHolderEmail optional emailType Simple Type

Email address

CardHolderLanguage optional languageIndicatorType Simple Type

CardHolder preferred language.

Note:This field is required for Canadian merchants.

AllowDup optional booleanType Simple Type

This is important in cases where the client processes a large number of similar transactions in a very short period of time; sending "Y" will skip duplicate checking on this transaction

Ecommerce optional eCommerceType Simple Type

Identifies this transaction as eCommerce or mail order/telephone order; see the associated Type enumerations for specific values supported.

TxnDescriptor optional TxnDescriptorType Simple Type

Transaction description that is concatenated to a configurable merchant DBA name. The resulting string is sent to the card issuer as the Merchant Name.

Note: Updates to the device are required to utilize this feature. See your Heartland representative for more details.

SurchargeAmtInfo optional amtTypeGlobal Simple Type

Surcharge amount information; this defines the portion of the total amount provided as part of this request that was specifically for a surcharge. This is informational only and will not alter the amount processed as part of the transaction.

Note: This field is limited to 8 digits with implied decimal.

EMVData optional EMVDataType Complex Type

When processing with an EMV capable client, this element may need to be provided. It consists of certain online authentication data or the reason for not utilizing the EMV capabilities. EMV tag data should be sent in the separate TagData field.

All

EMVTagData optional emvTagDataType Simple Type

EMV tag data in TLV format.

Note: This field has been obsoleted.See the TagData field for the alternative.

EMVChipCondition optional emvChipConditionType Simple Type

This must be provided when the POS was not able to successfully communicate to the chip card and was required to fall back to a magnetic stripe read on an EMV capable terminal.

The values can indicate multiple factors:

The EMV chip read failed
Did the previous attempt fail

See enumerations for specific values supported

PINBlock optional pinBlockType Simple Type

Chip card PIN block for online authentication

TagData optional TagDataType Complex Type

EMV or Non-EMV tag data in TLV format

All

TagValues optional Extension of xs:string

This field holds the tag data values.

WalletData optional WalletDataType Complex Type

Allows for sending Wallet Authentication data associated with the transaction.

All

PaymentSource PaymentDataSourceType Simple Type

Payment Source is the API or source of the cryptogram.

Cryptogram optional Extension of cryptogramType Simple Type

Cryptogram received from wallet payment. Supported formats are DSRP, TokenBlocks and TAVV cryptograms. Must be encoded using base16 (Hex encoding) or base64 encoding.

ECI optional eciType Simple Type

Electronic Commerce Indicator associated with the Cryptogram. This is an optional field.

DigitalPaymentToken optional xs:string

Payment payload used to send encrypted apple or google pay data.

TokenRequestorId optional tokenRequestorIdType Simple Type

FOR FUTURE USE

Value associated with a specific network token that uniquely identifies the pairing of a token requestor with a token domain.

NetworkToken optional cryptogramTypeType Simple Type

FOR FUTURE USE

For use with NetworkToken only. If type is not provided, and a cryptogram is sent, Portico will use the default cryptogram type for the card brand.

SendFundsData optional SendFundsDataType Complex Type

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

All

FundsTransferType FundsTransferType Simple Type

Indicates the type of funds transfer.

Valid values are:

VisaOCT
MCMoneySend

VisaTransferType optional VisaTransferType Simple Type

Contains type of money transfer being performed

Valid values include:

'BB' indicates Business to business
'BP' indicates Non-card bill payment
'FD' indicates Funds disbursement (general)
'GD' indicates Government disbursement
'GP' indicates Gambling payout (other than online gambling)
'OG' indicates Online gambling payout
'PP' indicates Person to person
'WT' indicates Wallet transfer

FundingSource optional FundingSourceType Simple Type

Indicates the method used by the sender to fund an OCT.

The tag is required in all domestic and cross-border money trans-fer OCTs destined to U.S. recipient issuers.

Valid values include:

01 = Visa credit
02 = Visa debit
03 = Visa prepaid
04 = Cash
05 = Debit/deposit access accounts other than those linked to a Visa card (includes checking/savings accounts and proprietary debit/Automated Teller Machine (ATM) cards)
06 = Credit accounts other than those linked to a Visa card (includes credit cards and proprietary credit lines)

Note: Prepaid cards must be reloadable

PaymentPurpose optional PaymentPurposeType Simple Type

LLVAR. Contains the purpose of payment code valid for the recipient country.

RefNbr optional SendfundrefNbrType Simple Type

Contains the code that denotes whether the customer identification data belongs to the sender or the recipient.

Valid values include:

'05' (Payer (sender))
'06' Payee (recipient))

If present, the following must also be present:

Identification Type Code
Identification Value

MCTransferType optional MCTransferType Simple Type

Indicates the type of additional transaction purpose.

Valid values are:

C04 - Gaming Re-pay
C07 - General Person-to-Person
C55 - Business Disbursement
C56 - Government/Non-Profit Disbursement
C65 - General Business to Business Transfer

ParticipantData optional ParticipantDataType Complex Type

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.

Used By

SendFunds Element

Source

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