PosCheckSaleRspType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

PosCheckSaleRspType

Sequence

RspCode xs:int

Response (result) code indicating the overall success of the transaction; '0' indicates success while non-zero indicates a failure.

RspMessage optional xs:string

Response (result) text returned by the check processor; additional error messages may be separated by a hyphen (-)

AuthCode optional xs:string

If authorized, authorization code returned by the check processor

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.

CheckRspInfo 0..∞ CheckRspInfoType Complex Type

Additional response information that can vary by check processor

Sequence

Type optional xs:string

Indicates type of response information:

Error
Decline
Information
Warning
Approve
Unknown

Code optional xs:string

Check processor response code(s); overall single response code or detail response codes separated by a hyphen (-)

Message optional xs:string

Message description of the provided code

FieldNumber optional xs:string

Field number that is in error

FieldName optional xs:string

Field name that is in error

Used By

CheckSale Element

Source

<xs:complexType name="PosCheckSaleRspType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element name="RspCode" type="xs:int">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Response (result) code indicating the overall success of the transaction; '0' indicates success while non-zero indicates a failure.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="RspMessage" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Response (result) text returned by the check processor; additional error messages may be separated by a hyphen (-)</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="AuthCode" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">If authorized, authorization code returned by the check 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="CheckRspInfo" type="CheckRspInfoType" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Additional response information that can vary by check processor</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>