Open the Portico Developer Guide site
PosGateway Schema
PosResponse Element
PosGateway Schema : PosResponse Element
Description

Response message from the gateway to a client

Namespace http://Hps.Exchange.PosGateway
Diagram
Ver1.0 Element Choice PosResponse Element
Overview
PosResponse

Response message from the gateway to a client

rootUrl optional
Choice
Ver1.0

Messaging version

All
Header

Contains tracking information, echoed fields, and gateway response indicators.

The specific fields returned can vary. Clients should code to be able to potentially receive any optional elements at any time. New elements being added should not break client code.

Note: This should be inspected by the client to determine if the gateway was able to complete the processing of the associated request.

Note: If gateway successfully processed the request, the client will still need to check the transaction response details, if any, to determine the final result based on any issuer decisions.

All
LicenseId optional licenseIdType Simple Type

Echoed from request

SiteId optional siteIdType Simple Type

Echoed from request

DeviceId optional deviceIdType Simple Type

Echoed from request

SiteTrace optional siteTraceType Simple Type

Echoed from request

GatewayTxnId txnIdType Simple Type

Gateway-generated transaction identifier; can be used in future client requests to uniquely identify this transaction.

GatewayRspCode gatewayRspCodeType Simple Type

Gateway response code that indicates what occurred on the gateway while processing the request.

Note: This does not indicate approval or decline. Clients must see if additional information is provided in the transaction portion of the message from the issuer or other system.

GatewayRspMsg optional gatewayRspMsgType Simple Type

Gateway response message that may provide additional information to the client or user.

Note: In some cases the information may not assist the client or user directly, but it can be provided to a support representative to assist in problem resolution.

RspDT optional xs:dateTime

Transaction response date and time in the time zone stored for the associated site.

TokenData optional TokenDataRspType Complex Type

If requested, the multi-use token data generated (or echoed) from the supplied card data.

AdditionalDuplicateData optional AdditionalDuplicateDataType Complex Type

Contains the original transaction data from the first request which triggered the duplicate transaction.

ClientTxnId optional clientIdType Simple Type

Echoed from request

UniqueDeviceId optional xs:string

Echoed from request

BatchId optional batchIdType Simple Type

If the transaction was added to a batch, this is the associated batch id.

Note: This field is only returned if the device is configured for this option during the boarding process.

BatchSeqNbr optional xs:int

If the transaction was added to a batch, this is the batch's sequence number.

Note: This field is only returned if the device is configured for this option during the boarding process.

PDLNotification optional booleanType Simple Type

Indicates a parameter download is available

CustomHash optional xs:string

Fingerprint value for customer-specific usage.

BatchItemNbr optional xs:int

FOR INTERNAL USE ONLY

MerchCurrencyCode optional xs:string

Indicates the 3-digit currency code of the merchant.

MerchCurrencyText optional xs:string

Indicates the 3-digit currency acronym of the merchant

RetryInd optional booleanType Simple Type

Indicates that this transaction is a retry of the previous, in case if a timeout error occurred. GTID and Source fields are required for RetryInd.

The time alloted for retries is 90 minutes.

Note: It is internal only

Transaction optional

Transaction result details, issuer results codes and messages, authorization codes, balances, etc.

The specific fields returned can vary. Clients should code to be able to potentially receive any optional elements at any time. New elements being added should not break client code.

Note: Clients will need to inspect information returned in this portion to determine the final result of the requested transaction (i.e., approvals and declines).

Choice
CancelImpersonation xs:anySimpleType
CashReturn xs:anySimpleType
CashSale xs:anySimpleType
ChipCardDecline xs:anySimpleType
CreditOfflineAuth xs:anySimpleType
InvalidateAuthentication xs:anySimpleType
TestCredentials xs:anySimpleType
Attributes
NameTypeUseDefaultFixedDescription
rootUrl optional   
Source
<xs:element name="PosResponse" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">Response message from the gateway to a client</p>
    </xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:choice>
      <xs:element name="Ver1.0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Messaging version</p>
          </xs:documentation>
        </xs:annotation>
        <xs:complexType>
          <xs:all>
            <xs:element name="Header">
              <xs:annotation>
                <xs:documentation>
                  <p xmlns="http://Hps.Exchange.PosGateway">Contains tracking information, echoed fields, and gateway response indicators.</p>
                  <p xmlns="http://Hps.Exchange.PosGateway">The specific fields returned can vary. Clients should code to be able to potentially receive any optional elements at any time. New elements being added should not break client code.</p>
                  <p xmlns="http://Hps.Exchange.PosGateway" />
                  <p xmlns="http://Hps.Exchange.PosGateway">
                    <strong>Note:</strong> This should be inspected by the client to determine if the gateway was able to complete the processing of the associated request.
                    </p>
                  <p xmlns="http://Hps.Exchange.PosGateway" />
                  <p xmlns="http://Hps.Exchange.PosGateway">
                    <strong>Note:</strong> If gateway successfully processed the request, the client will still need to check the transaction response details, if any, to determine the final result based on any issuer decisions.
                    </p>
                </xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:all>
                  <xs:element name="LicenseId" type="licenseIdType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Echoed from request</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="SiteId" type="siteIdType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Echoed from request</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="DeviceId" type="deviceIdType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Echoed from request</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="SiteTrace" type="siteTraceType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Echoed from request</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="GatewayTxnId" type="txnIdType">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Gateway-generated transaction identifier; can be used in future client requests to uniquely identify this transaction.</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="GatewayRspCode" type="gatewayRspCodeType">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Gateway response code that indicates what occurred on the gateway while processing the request.</p>
                        <p xmlns="http://Hps.Exchange.PosGateway" />
                        <p xmlns="http://Hps.Exchange.PosGateway">
                          <strong>Note:</strong> This does not indicate approval or decline. Clients must see if additional information is provided in the transaction portion of the message from the issuer or other system.
                          </p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="GatewayRspMsg" type="gatewayRspMsgType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Gateway response message that may provide additional information to the client or user.</p>
                        <p xmlns="http://Hps.Exchange.PosGateway" />
                        <p xmlns="http://Hps.Exchange.PosGateway">
                          <strong>Note:</strong> In some cases the information may not assist the client or user directly, but it can be provided to a support representative to assist in problem resolution.
                          </p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="RspDT" type="xs:dateTime" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Transaction response date and time in the time zone stored for the associated site.</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="TokenData" type="TokenDataRspType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">If requested, the multi-use token data generated (or echoed) from the supplied card data.</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="AdditionalDuplicateData" type="AdditionalDuplicateDataType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Contains the original transaction data from the first request which triggered the duplicate transaction.</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="ClientTxnId" type="clientIdType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Echoed from request</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="UniqueDeviceId" type="xs:string" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Echoed from request</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="BatchId" type="batchIdType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">If the transaction was added to a batch, this is the associated batch id.</p>
                        <p xmlns="http://Hps.Exchange.PosGateway" />
                        <p xmlns="http://Hps.Exchange.PosGateway">
                          <strong>Note:</strong> This field is only returned if the device is configured for this option during the boarding process.
                          </p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="BatchSeqNbr" type="xs:int" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">If the transaction was added to a batch, this is the batch's sequence number.</p>
                        <p xmlns="http://Hps.Exchange.PosGateway" />
                        <p xmlns="http://Hps.Exchange.PosGateway">
                          <strong>Note:</strong> This field is only returned if the device is configured for this option during the boarding process.
                          </p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="PDLNotification" type="booleanType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Indicates a parameter download is available</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="x_global_transaction_id" type="x_global_transaction_idType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Echoed from request</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="x_global_transaction_source" type="x_global_transaction_sourceType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Echoed from request</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="CustomHash" type="xs:string" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Fingerprint value for customer-specific usage.</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="BatchItemNbr" type="xs:int" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">FOR INTERNAL USE ONLY</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="MerchCurrencyCode" type="xs:string" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Indicates the 3-digit currency code of the merchant.</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="MerchCurrencyText" type="xs:string" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Indicates the 3-digit currency acronym of the merchant</p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="RetryInd" type="booleanType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>
                        <p xmlns="http://Hps.Exchange.PosGateway">Indicates that this transaction is a retry of the previous, in case if a timeout error occurred. GTID and Source fields are required for RetryInd.</p>
                        <p xmlns="http://Hps.Exchange.PosGateway">The time alloted for retries is 90 minutes.</p>
                        <p xmlns="http://Hps.Exchange.PosGateway">
                          <strong>Note:</strong> It is internal only
                          </p>
                      </xs:documentation>
                    </xs:annotation>
                  </xs:element>
                </xs:all>
              </xs:complexType>
            </xs:element>
            <xs:element name="Transaction" minOccurs="0">
              <xs:annotation>
                <xs:documentation>
                  <p xmlns="http://Hps.Exchange.PosGateway">Transaction result details, issuer results codes and messages, authorization codes, balances, etc.</p>
                  <p xmlns="http://Hps.Exchange.PosGateway">The specific fields returned can vary. Clients should code to be able to potentially receive any optional elements at any time. New elements being added should not break client code.</p>
                  <p xmlns="http://Hps.Exchange.PosGateway" />
                  <p xmlns="http://Hps.Exchange.PosGateway">
                    <strong>Note:</strong> Clients will need to inspect information returned in this portion to determine the final result of the requested transaction (i.e., approvals and declines).
                    </p>
                </xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:choice>
                  <xs:element name="AddAttachment" />
                  <xs:element name="AltPaymentAuth" type="PosAltPayAuthRspType" />
                  <xs:element name="AltPaymentCapture" type="PosAltPayCaptureRspType" />
                  <xs:element name="AltPaymentCreateAuth" type="PosAltPayCreateAuthRspType" />
                  <xs:element name="AltPaymentCreateSession" type="PosAltPayCreateSessRspType" />
                  <xs:element name="AltPaymentOrder" type="PosAltPayOrderRspType" />
                  <xs:element name="AltPaymentReturn" type="PosAltPayReturnRspType" />
                  <xs:element name="AltPaymentReversal" type="PosAltPayReversalRspType" />
                  <xs:element name="AltPaymentSale" type="PosAltPaySaleRspType" />
                  <xs:element name="AltPaymentSessionInfo" type="PosAltPaySessionInfoRspType" />
                  <xs:element name="AltPaymentVoid" type="PosAltPayVoidRspType" />
                  <xs:element name="Authenticate" type="PosAuthenticateRspType" />
                  <xs:element name="BatchClose" type="PosBatchCloseRspType" />
                  <xs:element name="CancelImpersonation" type="xs:anySimpleType" />
                  <xs:element name="CashReturn" type="xs:anySimpleType" />
                  <xs:element name="CashSale" type="xs:anySimpleType" />
                  <xs:element name="CheckSale" type="PosCheckSaleRspType" />
                  <xs:element name="CheckQuery" type="PosCheckQueryRspType" />
                  <xs:element name="CheckVoid" type="PosCheckVoidRspType" />
                  <xs:element name="ChipCardDecline" type="xs:anySimpleType" />
                  <xs:element name="CreditAccountVerify" type="AuthRspStatusType" />
                  <xs:element name="CreditAddToBatch" type="AuthRspStatusType" />
                  <xs:element name="CreditAuth" type="AuthRspStatusType" />
                  <xs:element name="CreditAdditionalAuth" type="AuthRspStatusType" />
                  <xs:element name="CreditCapture" type="AuthRspStatusType" />
                  <xs:element name="CreditCPCEdit" type="AuthRspStatusType" />
                  <xs:element name="CreditIncrementalAuth" type="AuthRspStatusType" />
                  <xs:element name="CreditIPQuery" type="AuthRspStatusType" />
                  <xs:element name="CreditOfflineAuth" type="xs:anySimpleType" />
                  <xs:element name="CreditOfflineSale" type="AuthRspStatusType" />
                  <xs:element name="CreditReturn" type="AuthRspStatusType" />
                  <xs:element name="CreditReversal" type="AuthRspStatusType" />
                  <xs:element name="CreditSale" type="AuthRspStatusType" />
                  <xs:element name="CreditTxnEdit" type="AuthRspStatusType" />
                  <xs:element name="CreditVoid" type="AuthRspStatusType" />
                  <xs:element name="DebitAddValue" type="AuthRspStatusType" />
                  <xs:element name="DebitBalanceInquiry" type="AuthRspStatusType" />
                  <xs:element name="DebitReturn" type="AuthRspStatusType" />
                  <xs:element name="DebitReversal" type="AuthRspStatusType" />
                  <xs:element name="DebitAddToBatch" type="AuthRspStatusType" />
                  <xs:element name="DebitAuth" type="AuthRspStatusType" />
                  <xs:element name="DebitSale" type="AuthRspStatusType" />
                  <xs:element name="EBTBalanceInquiry" type="AuthRspStatusType" />
                  <xs:element name="EBTCashBackPurchase" type="AuthRspStatusType" />
                  <xs:element name="EBTCashBenefitWithdrawal" type="AuthRspStatusType" />
                  <xs:element name="EBTFSPurchase" type="AuthRspStatusType" />
                  <xs:element name="EBTFSReturn" type="AuthRspStatusType" />
                  <xs:element name="EBTFSReversal" type="AuthRspStatusType" />
                  <xs:element name="EBTVoucherPurchase" type="AuthRspStatusType" />
                  <xs:element name="EndToEndTest" />
                  <xs:element name="FindTransactions" type="FindTransactionsRspType" />
                  <xs:element name="GetAttachments" type="PosGetAttachmentsRspType" />
                  <xs:element name="GetTransactionStatus" type="PosGetTransactionStatusRspType" />
                  <xs:element name="GetUserSettings" type="PosGetUserSettingsRspType" />
                  <xs:element name="GetUserDeviceSettings" type="PosGetUserDeviceSettingsRspType" />
                  <xs:element name="GiftCardActivate" type="PosGiftCardActivateRspType" />
                  <xs:element name="GiftCardAddValue" type="PosGiftCardAddValueRspType" />
                  <xs:element name="GiftCardAlias" type="PosGiftCardAliasRspType" />
                  <xs:element name="GiftCardBalance" type="PosGiftCardBalanceRspType" />
                  <xs:element name="GiftCardCurrentDayTotals" type="GiftCardTotalsType" />
                  <xs:element name="GiftCardDeactivate" type="PosGiftCardDeactivateRspType" />
                  <xs:element name="GiftCardPreviousDayTotals" type="GiftCardTotalsType" />
                  <xs:element name="GiftCardReplace" type="PosGiftCardReplaceRspType" />
                  <xs:element name="GiftCardReversal" type="PosGiftCardReversalRspType" />
                  <xs:element name="GiftCardReward" type="PosGiftCardRewardRspType" />
                  <xs:element name="GiftCardSale" type="PosGiftCardSaleRspType" />
                  <xs:element name="GiftCardTip" type="PosGiftCardTipRspType" />
                  <xs:element name="GiftCardVoid" type="PosGiftCardVoidRspType" />
                  <xs:element name="Impersonate" type="PosImpersonateRspType" />
                  <xs:element name="InvalidateAuthentication" type="xs:anySimpleType" />
                  <xs:element name="ManageSettings" type="ManageSettingsRspType" />
                  <xs:element name="ManageUsers" type="PosManageUsersRspType" />
                  <xs:element name="ParameterDownload" type="PosParameterDownloadRspType" />
                  <xs:element name="PrePaidAddValue" type="AuthRspStatusType" />
                  <xs:element name="PrePaidBalanceInquiry" type="AuthRspStatusType" />
                  <xs:element name="RecurringBilling" type="AuthRspStatusType" />
                  <xs:element name="RecurringBillingAuth" type="AuthRspStatusType" />
                  <xs:element name="ReportActivity" type="PosReportActivityRspType" />
                  <xs:element name="ReportBatchDetail" type="PosReportBatchDetailRspType" />
                  <xs:element name="ReportBatchHistory" type="PosReportBatchHistoryRspType" />
                  <xs:element name="ReportBatchSummary" type="PosReportBatchSummaryRspType" />
                  <xs:element name="ReportOpenAuths" type="PosReportOpenAuthsRspType" />
                  <xs:element name="ReportSearch" type="PosReportSearchRspType" />
                  <xs:element name="ReportTxnDetail" type="PosReportTxnDetailRspType" />
                  <xs:element name="ReportTxnResearch" type="PosReportTxnResearchRspType" />
                  <xs:element name="RewardCashQuery" type="PosRewardCashQueryRspType" />
                  <xs:element name="RewardCashRedeem" type="PosRewardCashRedeemRspType" />
                  <xs:element name="SendFunds" type="AuthRspStatusType" />
                  <xs:element name="SendReceipt" />
                  <xs:element name="TokenUpdaterHistory" type="PosTokenUpdaterHistoryRspType" />
                  <xs:element name="SurchargeEligibilityLookup" type="PosSurchargeEligibilityLookupRspType" />
                  <xs:element name="TestCredentials" type="xs:anySimpleType" />
                  <xs:element name="InteracDeviceKeys" type="PosInteracDeviceKeysRspType" />
                  <xs:element name="BNPLCreateOrder" type="AuthRspStatusType" />
                  <xs:element name="NTRSCreateToken" type="NTRSCreateTokenRspStatusType" />
                  <xs:element name="NTRSGetTokenCryptogram" type="NTRSGetTokenCryptogramRspStatusType" />
                  <xs:element name="NTRSTokenStatus" type="NTRSTokenStatusRspStatusType" />
                  <xs:element name="NTRSUpdateTokenStatus" type="NTRSTokenStatusRspStatusType" />
                  <xs:element name="NTRSTokenMetadata" type="NTRSTokenMetadataRspStatusType" />
                </xs:choice>
              </xs:complexType>
            </xs:element>
          </xs:all>
        </xs:complexType>
      </xs:element>
    </xs:choice>
    <xs:attribute name="rootUrl" />
  </xs:complexType>
</xs:element>
See Also
PosGateway Schema