Open the Portico Developer Guide site
PosGateway Schema
PosCashReturnReqType Complex Type
PosGateway Schema : PosCashReturnReqType Complex Type
Namespace http://Hps.Exchange.PosGateway
Diagram
Block1 Element Sequence PosCashReturnReqType Complex Type
Overview
PosCashReturnReqType
Sequence
Block1 CashReturnReqBlock1Type 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 must refer to a prior CashSale.

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.

Amt amtTypeGlobal Simple Type

The cash amount returned to the customer

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.

Used By
CashReturn Element
Source
<xs:complexType name="PosCashReturnReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element name="Block1" type="CashReturnReqBlock1Type">
      <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:sequence>
</xs:complexType>
See Also
PosGateway Schema

 

 

© 2025 Heartland Payment Systems, Inc.