Open the Portico Developer Guide site
PosGateway Schema
DebitAuth Element
PosGateway Schema > PosResponse Element > Ver1.0 Element > Transaction Element : DebitAuth Element
Namespace http://Hps.Exchange.PosGateway
Type
AuthRspStatusType Complex Type
Diagram
AgreementId Element HostIssRspCode Element RedirectUrl Element BnplId Element AccountReference Element CurrencyConversion Element PaymentFacilitatorTxnNbr Element PaymentFacilitatorTxnId Element IpTerms Element IpSelectedTermsRsp Element CardBrandTxnId Element HostRspDT Element DebitMac Element TokenPANLast4 Element CAVVResultCode Element EMVIssuerResp Element RecurringDataCode Element TxnDescriptor Element CVVRsltText Element AVSRsltText Element CardType Element CVVResultCodeAction Element AVSResultCodeAction Element AuthAmt Element AvailableBalance Element RefNbr Element CPCInd Element CVVRsltCode Element AVSRsltCode Element AuthCode Element RspText Element RspCode Element All DebitAuth Element
Overview
DebitAuth AuthRspStatusType Complex Type
All
RspCode xs:string

Response (result) code returned by the issuer

RspText optional xs:string

Response (result) text returned by the issuer

AuthCode optional xs:string

If authorized, authorization code returned by the issuer

AVSRsltCode optional xs:string

If address verification requested, address verification result code returned by the issuer

CVVRsltCode optional xs:string

If card verification was provided on the request, card verification result code returned by the issuer

CPCInd optional xs:string

If commercial card was specified in the request, commercial card response indicator returned by the issuer.

Valid values include:

  • B (Business Card)
  • R (Corporate Card)
  • S (Purchasing Card)
  • L (B2B - Settlement amount may not exceed Authorized amount)

Note: If this is returned with one of these values, the client should obtain additional information from the card holder and provide it to the gateway via a CreditCPCEdit before this transaction is closed.

RefNbr optional xs:string

Reference number returned by the processor or issuer

AvailableBalance optional amtTypeGlobal Simple Type

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

Note: If not returned, the authorized amount is the requested amount.

AVSResultCodeAction optional resultCodeActionType Simple Type

AVS result action; this is a "suggestion" to the client based on the device's configuration during boarding and the AVS result received.

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

CVV result action; this is a "suggestion" to the client based on the device's configuration during boarding and the CVV result received.

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

The dynamic portion of this was provided in the header of the request; this is the final string sent to the issuer based on the provided value and the values configured during boarding

RecurringDataCode optional xs:string

MasterCard value that may be returned on recurring transactions. The only potential value on an approval is "01"; any of the other values may be returned on a decline.

Valid values include:

  • "01" (New account information available)
  • "02" (Cannot approve at this time, try again later)
  • "03" (Do not try again)
  • "04" (Declined due to lack of cryptography or partial shipment indicator)
  • "21" (Recurring Payment Cancellation Service)
  • "24" (Retry after 1 hour)
  • "25" (Retry after 24 hour)
  • "26" (Retry after 2 days)
  • "27" (Retry after 4 days)
  • "28" (Retry after 6 days)
  • "29" (Retry after 8 days)
  • "30" (Retry after 10 days)

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

The Visa Cardholder Authentication Verfication Value results code. This is returned by Visa when using SecureECommerce.

TokenPANLast4 optional xs:string

Last 4 digits of PAN associated with Token. This may be returned by issuer when using SecureECommerce.

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

A block of encrypted data to be sent from the POS on every contact Interac sale and return request. Required for Canadian merchants processing debit reversals.

HostRspDT optional xs:dateTime

Processing Host response date and time.

Note:For Canadian merchants, the HostRspDT contains the timestamp to be printed on the customer receipt.

CardBrandTxnId optional xs:string

This is the Network Transaction Identifier returned by the Card Brand.

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

The IPSelectedTermsRsp data block is included in a Credit response to provide the name of the issuer and/or the authorized terms. The data returned is dependent on the Program.

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

Information on the Installment Plan chosen by the customer. Usage varies by region and the Installments service provider:

Merchants located in the Asia Pacific region must provide the NbrInstallments and Program. SIPOptions is optional.

Merchants located in Mexico must provide the NbrInstallemnts, InstallmentPlan, and GracePeriod only.

Merchants located in Canada using Visa Installment Service (VIS) must provide the Program and VISOptions.

All
Program programType Simple Type

The installment payments program type. This value is echoed from the request.

TermOptions optional TermOptionsType Simple Type

Term Options, only returned for the mIPP or SIP Programs.

The format is based by the Program.

VISEligiblePlans optional

This block provides information regarding eligible Visa Installment Service (VIS) installment plans, to be presented to the cardholder (EligiblePlans).

When the CardNbr and Amt are eligible, VIS returns 2 to n installment plans. Multiple plans are returned in the response.

When the CardNbr and Amt are not eligible, VIS returns a success response but EligiblePlans will be empty.

Choice 0..∞
EligiblePlans MatchedPlansType Complex Type

VIS installment plan information returned by VIS. Certain sub-elements may be repeated.

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator. This identifier is for use only by the payment facilitator, and should not be used as a reference in future client requests to the Portico Gateway.

PaymentFacilitatorTxnNbr optional xs:string

Unique account identifier assigned by the payment facilitator for the sub-merchant. This is used as the sub-merchant account reference if contacting the payment facilitator for support.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

This setting indicates if the Customer has decided Opt Out of currency conversion and have the amount remain in the Merchants currency. If the customer does not opt out, the amount will be converted to currency associated with the card.

RateLookupTxnId optional guidType Simple Type

The Retrieval Reference Number (RRN) of the RateLookup or Incremental Authorization that provided the rate used for the calculations in this transaction, if it is different from the original Authorization.

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

The mark up percentage applied to the transaction, resulting in the commission fee.

AccountReference optional xs:string

'Payment Account Reference' (PAR) data returned by issuer. PAR is 29-character alphanumeric reference number associated with each unique PAN and used by merchants to track transactions associated with customers PAN. Currently, PAR is only supported by Card Brand American Express.

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

Value returned by Visa in authorization responses for merchants participating in the Commercial Choice Program.

Source
<xs:element name="DebitAuth" type="AuthRspStatusType" xmlns:xs="http://www.w3.org/2001/XMLSchema" />
See Also
Transaction Element | Ver1.0 Element | PosResponse Element | PosGateway Schema

 

 

© 2024 Heartland Payment Systems, Inc.