CheckSaleReqBlock1Type Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

CheckSaleReqBlock1Type

All

CheckAction checkActionType Simple Type

A modifier that determines the backend functionality to perform; see the associated Type enumerations for specific values supported.

Note: Return and Override are only supported when processing with GETI.

Note: This sets the PACKET_ID sent to GETI.

AccountInfo optional AccountInfoType Complex Type

Account information to use as the payment method

Note: The check processor may allow MICR data to be sent in place of account and route or it may require both. This can be determined during certification.

All

RoutingNumber optional xs:string

Check routing number; manually entered or parsed from MICR data.

AccountNumber optional Restriction of xs:string

Check account number; manually entered or parsed from MICR data.

CheckNumber optional xs:string

The physical check number; manually entered or parsed from MICR data.

MICRData optional Restriction of xs:string

Magnetic ink character recognition (MICR) data obtained from a check reader.

AccountType optional accountTypeType Simple Type

Indicates the type of account provided; see the associated Type enumerations for specific values supported.

Note: If processing with Colonnade, AccountType must be specified.

DataEntryMode optional dataEntryModeType Simple Type

Indicates whether the provided data was entered manually or retrieved from a reader; see the associated Type enumerations for specific values supported.

Note: This sets the CONTROL_CHAR sent to GETI.

CheckType optional checkTypeType Simple Type

Indicates the type of check being processed; see the associated Type enumerations for specific values supported.

Note: This sets the IDENTIFIER sent to GETI.

VerifyInfo optional VerifyInfoType Complex Type

Verification only options

Note: If eBronze is selected as the SEC code for GETI during boarding, all requests will be verification only and this element is not required.

All

CheckVerify optional booleanType Simple Type

Indicates that the transaction should be processed for check verification only. If not sent, false is assumed.

ACHVerify optional booleanType Simple Type

Indicates that the transaction should have the ACH funds verified. If not sent, false is assumed.

Note: This was for Transmodus only and is no longer supported.

Amt optional amtTypeGlobal Simple Type

The amount of the check to be processed

SECCode optional xs:string

NACHA Standard Entry Class Code for processing.

Valid values include:

"PPD" (Prearranged Payment and Deposit)
"CCD" (Cash Concentration or Disbursement)
"POP" (GETI only, Point of Purchase Entry)
"WEB" (Internet Initiated Entry)
"TEL" (Telephone Initiated Entry)
"EBRONZE" (GETI only)

Note: SECCode is a required field when the check processor is Colonnade.

Note: For GETI, this will be used to validate information returned from GETI during the transaction. This validation is not done when EBRONZE is chosen.

ConsumerInfo optional ConsumerInfoType Complex Type

Information about the consumer.

Note: While all these are optional in the schema, the check processor may require some of these fields in specific circumstances. For additional information on this, please consult the requirements of the specific processor.

All

FirstName optional xs:string

Consumer first name

LastName optional xs:string

Consumer last name

CheckName optional xs:string

Business name on check.

Note: If processing with Colonnade, this field is required.

Note: This sets the COMPANY_NAME sent to GETI.

Address1 optional xs:string

Consumer address line 1

Address2 optional xs:string

Consumer address line 2

City optional xs:string

Consumer city

State optional xs:string

Consumer state

Zip optional xs:string

Consumer zip code

PhoneNumber optional xs:string

Consumer phone number

EmailAddress optional xs:string

Consumer email address

Note: This was for Transmodus only and is no longer used.

DLState optional xs:string

Consumer driver's license state

Note: This field may be required by GETI based on the terminal configuration.

DLNumber optional Restriction of xs:string

Consumer driver's license number

Note: This field may be required by GETI based on the terminal configuration.

CourtesyCard optional Restriction of xs:string

Consumer courtesy card number

IdentityInfo optional IdentityInfoType Complex Type

Consumer identity information

All

SSNL4 optional Restriction of xs:string

Last four digits of the consumer social security number

Note: This field may be required by GETI based on the terminal configuration.

DOBYear optional xs:string

Consumer year of birth

Note: This field may be required by GETI based on the terminal configuration.

AdditionalTxnFields optional AdditionalTxnFieldsType Complex Type

A common group of optional fields that are supported in several different transaction types for Merchant use.

All

Description optional descriptionType Simple Type

Free-form description field. This must not contain sensitive information.

InvoiceNbr optional Restriction of xs:string

Used to log the invoice number on transactions that are not eCommerce.

CustomerID optional customerIDType Simple Type

Used to log Merchant specific customer identification.

Note: For GETI check transactions, this is sent in the CUSTOM3 field.

PaymentMethodKey optional guidType Simple Type

Unique key generated by PayPlan associated with a stored payment method

Note: When using PaymentMethodKey, the following fields should not be sent as part of the transaction as they will be obtained from previously stored data:

DataEntryMode
CheckType
VerifyInfo
SECCode
ConsumerInfo
RoutingNumber
AccountNumber

RecurringData optional RecurringDataType Complex Type

Additional data that may be required for recurring transactions

All

ScheduleID optional scheduleIDType Simple Type

The PayPlan ScheduleIdentifier

OneTime optional booleanType Simple Type

Indicates a one-time payment (Y) or a recurring payment (N); if not provided N is assumed.

RecurringDataCode optional xs:string

MasterCard value that may be returned on recurring transactions.

Note: This is returned in the response and should never be used in the request.

TokenValue optional xs:string

Token used to replace payment method data (route, account, and MICR).

Note: Multi-use tokens are not yet supported on check transactions. This is currently only used for single-use tokens. Single-use tokens are provided by the SecureSubmit product and are primarily used in eCommerce situations.

Used By

Block1 Element

Source

<xs:complexType name="CheckSaleReqBlock1Type" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="CheckAction" type="checkActionType">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">A modifier that determines the backend functionality to perform; see the associated Type enumerations for specific values supported.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> Return and Override are only supported when processing with GETI.
            </p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> This sets the PACKET_ID sent to GETI.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="AccountInfo" type="AccountInfoType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Account information to use as the payment method</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> The check processor may allow MICR data to be sent in place of account and route or it may require both. This can be determined during certification.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="DataEntryMode" type="dataEntryModeType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates whether the provided data was entered manually or retrieved from a reader; see the associated Type enumerations for specific values supported.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> This sets the CONTROL_CHAR sent to GETI.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="CheckType" type="checkTypeType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates the type of check being processed; see the associated Type enumerations for specific values supported.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> This sets the IDENTIFIER sent to GETI.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="VerifyInfo" type="VerifyInfoType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Verification only options</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> If eBronze is selected as the SEC code for GETI during boarding, all requests will be verification only and this element is not required.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="Amt" type="amtTypeGlobal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The amount of the check to be processed</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="SECCode" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">NACHA Standard Entry Class Code for processing.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">
              Valid values include:
              <ul><li>"PPD" (Prearranged Payment and Deposit)</li><li>"CCD" (Cash Concentration or Disbursement)</li><li>"POP" (GETI only, Point of Purchase Entry)</li><li>"WEB" (Internet Initiated Entry)</li><li>"TEL" (Telephone Initiated Entry)</li><li>"EBRONZE" (GETI only)</li></ul></p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> SECCode is a required field when the check processor is Colonnade.
            </p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> For GETI, this will be used to validate information returned from GETI during the transaction. This validation is not done when EBRONZE is chosen.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="ConsumerInfo" type="ConsumerInfoType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Information about the consumer.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> While all these are optional in the schema, the check processor may require some of these fields in specific circumstances. For additional information on this, please consult the requirements of the specific processor.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="AdditionalTxnFields" type="AdditionalTxnFieldsType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">A common group of optional fields that are supported in several different transaction types for Merchant use.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="PaymentMethodKey" type="guidType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Unique key generated by PayPlan associated with a stored payment method</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> When using PaymentMethodKey, the following fields should not be sent as part of the transaction as they will be obtained from previously stored data:
              <ul><li>DataEntryMode</li><li>CheckType</li><li>VerifyInfo</li><li>SECCode</li><li>ConsumerInfo</li><li>RoutingNumber</li><li>AccountNumber</li></ul></p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="RecurringData" type="RecurringDataType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Additional data that may be required for recurring transactions</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="TokenValue" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Token used to replace payment method data (route, account, and MICR).</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> Multi-use tokens are not yet supported on check transactions. This is currently only used for single-use tokens. Single-use tokens are provided by the SecureSubmit product and are primarily used in eCommerce situations.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:all>
</xs:complexType>