Open the Portico Developer Guide site
Portico Schema
Transaction Element
Portico Schema > PosResponse Element > Ver1.0 Element : Transaction Element
Description

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).

Namespace http://Hps.Exchange.PosGateway
Diagram
InteracDeviceKeys Element TestCredentials Element SendReceipt Element RewardCashRedeem Element RewardCashQuery Element ReportTxnDetail Element ReportSearch Element ReportOpenAuths Element ReportBatchSummary Element ReportBatchHistory Element ReportBatchDetail Element ReportActivity Element RecurringBillingAuth Element RecurringBilling Element PrePaidBalanceInquiry Element PrePaidAddValue Element ParameterDownload Element ManageUsers Element ManageSettings Element InvalidateAuthentication Element Impersonate Element GiftCardVoid Element GiftCardTip Element GiftCardSale Element GiftCardReward Element GiftCardReversal Element GiftCardReplace Element GiftCardPreviousDayTotals Element GiftCardDeactivate Element GiftCardCurrentDayTotals Element GiftCardBalance Element GiftCardAlias Element GiftCardAddValue Element GiftCardActivate Element GetUserDeviceSettings Element GetUserSettings Element GetTransactionStatus Element GetAttachments Element FindTransactions Element EndToEndTest Element EBTVoucherPurchase Element EBTFSReversal Element EBTFSReturn Element EBTFSPurchase Element EBTCashBenefitWithdrawal Element EBTCashBackPurchase Element EBTBalanceInquiry Element DebitSale Element DebitAuth Element DebitAddToBatch Element DebitReversal Element DebitReturn Element DebitBalanceInquiry Element DebitAddValue Element CreditVoid Element CreditTxnEdit Element CreditSale Element CreditReversal Element CreditReturn Element CreditOfflineSale Element CreditOfflineAuth Element CreditIPQuery Element CreditIncrementalAuth Element CreditCPCEdit Element CreditCapture Element CreditAdditionalAuth Element CreditAuth Element CreditAddToBatch Element CreditAccountVerify Element ChipCardDecline Element CheckVoid Element CheckQuery Element CheckSale Element CashSale Element CashReturn Element CancelImpersonation Element BatchClose Element Authenticate Element AltPaymentVoid Element AltPaymentSessionInfo Element AltPaymentSale Element AltPaymentReversal Element AltPaymentReturn Element AltPaymentOrder Element AltPaymentCreateSession Element AltPaymentCreateAuth Element AltPaymentCapture Element AltPaymentAuth Element AddAttachment Element Choice Transaction Element
Overview
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
AddAttachment
AltPaymentAuth PosAltPayAuthRspType Complex Type
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 message returned by the processor

Status optional xs:string

Status from processors processing of the transaction

StatusMessage optional xs:string

Status message from processors processing of the transaction

Processor optional

Additional processor response information

Sequence 1..100
AltPaymentCapture PosAltPayCaptureRspType Complex Type
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 message returned by the processor

Status optional xs:string

Status from processors processing of the transaction

StatusMessage optional xs:string

Status message from processors processing of the transaction

Processor optional

Additional processor response information

Sequence 1..100
AltPaymentCreateAuth PosAltPayCreateAuthRspType Complex Type
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 message returned by the processor

Status optional xs:string

Status from processors processing of the transaction

StatusMessage optional xs:string

Status message from processors processing of the transaction

Processor optional

Additional processor response information

Sequence 1..100
AltPaymentCreateSession PosAltPayCreateSessRspType Complex Type
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 message returned by the processor

Session optional

Session Information from processor

Processor optional

Additional processor response information

Sequence 1..100
AltPaymentOrder PosAltPayOrderRspType Complex Type
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 message returned by the processor

Status optional xs:string

Status from processors processing of the transaction

StatusMessage optional xs:string

Status message from processors processing of the transaction

Processor optional

Additional processor response information

Sequence 1..100
AltPaymentReturn PosAltPayReturnRspType Complex Type
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 message returned by the processor

Status optional xs:string

Status from processors processing of the transaction

StatusMessage optional xs:string

Status message from processors processing of the transaction

ReturnAmt optional amtType Simple Type

Return Amount

TotalReturnAmt optional amtType Simple Type

Total Return Amount

Processor optional

Additional processor response information

Sequence 1..100
AltPaymentReversal PosAltPayReversalRspType Complex Type
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 message returned by the processor

Status optional xs:string

Status from processors processing of the transaction

StatusMessage optional xs:string

Status message from processors processing of the transaction

Amt optional amtType Simple Type

Reversal Amount

Processor optional

Additional processor response information

Sequence 1..100
AltPaymentSale PosAltPaySaleRspType Complex Type
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 message returned by the processor

Status optional xs:string

Status from processors processing of the transaction

StatusMessage optional xs:string

Status message from processors processing of the transaction

Processor optional

Additional processor response information

Sequence 1..100
AltPaymentSessionInfo PosAltPaySessionInfoRspType Complex Type
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 message returned by the processor

Status optional xs:string

Status from processors processing of the transaction

StatusMessage optional xs:string

Status message from processors processing of the transaction

Buyer optional

Buyer Information

Shipping optional

Shipping Information for the Session

Sequence 1..10
Payment optional

Payment Information for the Session

LineItem optional

Line Item purchase information for the session

Sequence 1..100
Processor optional

Additional processor response information

Sequence 1..100
AltPaymentVoid PosAltPayVoidRspType Complex Type
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 message returned by the processor

Status optional xs:string

Status from processors processing of the transaction

StatusMessage optional xs:string

Status message from processors processing of the transaction

Processor optional

Additional processor response information

Sequence 1..100
Authenticate PosAuthenticateRspType Complex Type
Sequence
CredentialToken xs:string

A credential token that can be used to identify a specific user session on subsequent requests

BatchClose PosBatchCloseRspType Complex Type
All
BatchId xs:int

The gateway-generated batch id of the closed batch

TxnCnt xs:int

The number of transactions closed (sent for settlement)

TotalAmt xs:decimal

The total transaction amount closed (sent for settlement)

BatchSeqNbr batchSeqNbrType Simple Type

The gateway-generated batch sequence number of the closed batch

HostBatchNbr optional xs:int

Host batch number.

HostTotalCnt optional xs:int

Total number of transactions in the host batch.

HostTotalAmt optional xs:decimal

Sum of transaction amounts in the host batch.

ProcessedDeviceId optional deviceIdType Simple Type

Device identifier used to process the request.

CancelImpersonation xs:anySimpleType
CashReturn xs:anySimpleType
CashSale xs:anySimpleType
CheckSale PosCheckSaleRspType Complex Type
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.

Note: This is not passed in the settlement process.

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

CheckQuery PosCheckQueryRspType Complex Type
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 (-)

TransactionStatus optional CheckTransactionStatus Simple Type

Transaction status returned by the check processor

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

CheckVoid PosCheckVoidRspType Complex Type
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.

Note: This is not passed in the settlement process.

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

ChipCardDecline xs:anySimpleType
CreditAccountVerify 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditAddToBatch 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditAuth 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditAdditionalAuth 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditCapture 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditCPCEdit 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditIncrementalAuth 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditIPQuery 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditOfflineAuth xs:anySimpleType
CreditOfflineSale 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditReturn 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditReversal 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditSale 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditTxnEdit 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CreditVoid 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

DebitAddValue 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

DebitBalanceInquiry 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

DebitReturn 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

DebitReversal 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

DebitAddToBatch 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

DebitSale 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

EBTBalanceInquiry 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

EBTCashBackPurchase 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

EBTCashBenefitWithdrawal 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

EBTFSPurchase 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

EBTFSReturn 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

EBTFSReversal 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

EBTVoucherPurchase 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

EndToEndTest
FindTransactions FindTransactionsRspType Complex Type
Sequence
Transactions 0..∞ TransactionDataType Complex Type

The result set of the search

Note: If the data was defined in the request or response, a description has not been added here; only fields that are being introduced in this response have additional detail added. Typically, these will be fields that drive business logic that can be assumed at the time of the transaction or they are calculated at the time of the report.

Sequence
GatewayTxnId txnIdType Simple Type
ClientTxnId clientIdType Simple Type
GatewayRspCode xs:int

Gateway response code (issuer is separate)

GatewayRspMsg xs:string

Gateway response message

CardType xs:string
MaskedCardNbr optional xs:string

This is the original transaction's card number, if any. It will contain the first six and last four digits with '*' filling in the middle. This value is safe for receipts and displays.

CardSwiped xs:string

Indicates whether or not the payment method from the original transaction was swiped

CardHolderData optional CardHolderDataType Complex Type

Card holder data

PaymentType paymentTypeType Simple Type

This will be based on the original request; see the associated Type enumerations for specific values supported.

ServiceName xs:string

This is the original request type (i.e. CreditSale)

TxnStatus xs:string

The current transaction status at the time of the search.

These can vary, but some of the key status values include:

  • Active - 'A'
  • Closed - 'C'
  • Voided - 'V'
  • Inactive - 'I'
  • Reversed - 'R'

AuthCode optional xs:string
Amt xs:decimal

The original requested amount

AuthAmt optional xs:decimal

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

SettlementAmt xs:decimal

The amount the transaction would settle for if it were closed as part of a batch

Note: This does not mean that it has or will close for this amount. The client controls this by adding it to the batch and closing the batch.

Note: This can be different from the original requested amount or the authorized amount for many reasons including: transaction edits (tip), reversals, additional authorizations, etc.

GratuityAmtInfo optional xs:decimal
UserName userNameType Simple Type
ClerkID optional Restriction of xs:string
RspDT xs:dateTime

Transaction response date time in the time zone conversion requested

RspCode optional xs:string

Issuer response code

RspText optional xs:string

Issuer response text

IssTxnId optional xs:string

Issuer transaction identifier

RefNbr optional xs:string
BatchSeqNbr optional xs:int
BatchCloseDT optional xs:dateTime

Batch close date time in the time zone conversion requested. If the transaction is in open batch value is nil.

SiteTrace optional xs:string
OriginalGatewayTxnId optional txnIdType Simple Type

If this transaction performed an action on a previous transaction, this field records the transaction that was acted upon.

AcctDataSrc optional xs:string

Account data source code. This is a derived value that represents the source of the account data received. For example, proximity vs. swiped vs. manual, et al.

CPCData optional CPCDataType Complex Type
LodgingData optional LodgingDataType Complex Type
AdditionalTxnFields optional AdditionalTxnFieldsType Complex Type
CredentialData optional CredentialDataType Complex Type

Credential details tied to a user session

Note: This is for internal use only.

UniqueDeviceId optional xs:string
ConvenienceAmtInfo optional xs:decimal
ShippingAmtInfo optional xs:decimal
TxnDescriptor optional xs:string
CheckData optional CheckDataType Complex Type

A collection of check transaction related fields

AttachmentInfo 0..4 AttachmentInfoType Complex Type

Information regarding attachments associated with this transaction

GiftData optional GiftDataType Complex Type

A collection of stored value transaction related fields

PaymentMethodKey optional guidType Simple Type
RecurringData optional RecurringDataType Complex Type
SurchargeAmtInfo optional amtType Simple Type
CashData optional CashDataType Complex Type

A collection of cash transaction related fields

FraudRuleInfo optional xs:string

Comma-separated list of strings containing the ID or description of the fraud rule that triggered the fraud decline. Only applies to authorizations that were declined due to fraud.

Note: This is for internal use only.

RepeatCount optional xs:int

For fraud declines indicates how many times the transaction has been overridden. Max is 1, so essentially, this indicates if the fraud decline result was overridden. Only applies to authorizations that were declined due to fraud.

Note: This is for internal use only.

EMVChipCondition optional xs:string
HasEMVTag optional xs:string

Indicates whether or not EMVTags were sent on this transaction; 'Y' indicates that EMV were sent, 'N' indicates that they were not.

HasEComPaymentData optional xs:string

Indicates whether or not Secure ECommerce Payment Data was sent on this transaction; 'Y' indicates that it did and 'N' that it did not.

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.

Company optional xs:string

The company associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.

CustomerFirstname optional xs:string

The customer first name associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.

CustomerLastname optional xs:string

The customer last name associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.

DebtRepaymentIndicator optional debtRepaymentType Simple Type

Allows for flagging this transaction as being against a debt obligation. Only use this field with Heartland's explicit direction. This flag is used to identify transactions that might qualify for VISA's Debt Repayment Program special interchange rates.

AltPaymentData optional AltPaymentDataType Complex Type

A collection of AltPayment transaction related fields

MultiFulfillmentData optional MultiFulfillmentDataType Complex Type

A collection of transaction of multi-fulfillment related fields

x_global_transaction_id optional x_global_transaction_idType Simple Type
AuthenticatedSiteId optional siteIdType Simple Type

Authenticated Site identifier received in the request header.

AuthenticatedDeviceId optional deviceIdType Simple Type

Authenticated Device identifier received in the request header.

ProcessedSiteId optional siteIdType Simple Type

Site identifier used to process the request.

ProcessedDeviceId optional deviceIdType Simple Type

Device identifier used to process the request.

CardOnFileData optional CardOnFileDataType Complex Type

The Card on File data received in the request.

CardBrandTxnId optional xs:string

The CardBrandTxnId for this transaction.

HasLevelIII optional booleanType Simple Type

Specify if transaction has L3 data

SAFData optional SAFDataType Complex Type

Specify if transaction was initiated in "store and forward" (SAF) mode (Y).

If SAFData block is present, SAFIndicator is required.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

TzConversion optional tzoneConversionType Simple Type

Indicates the time zone conversion applied to dates/times in the response; see the associated Type enumerations for specific values supported.

GetAttachments PosGetAttachmentsRspType Complex Type
Sequence
Details 0..∞ AttachmentRspDataType Complex Type

The attachments found based on the data in the request

All
GatewayTxnId optional txnIdType Simple Type

Gateway-generated transaction identifier returned in the response of the original transaction.

AttachmentType xs:string

Identifies the attachment types to be returned; see the attachmentTypeType enumerations for specific values supported.

AttachmentData xs:string

Base64 encoded attachment data

AttachmentFormat xs:string

Identifies the format of the attachment data; see the attachmentFormatType enumerations for specific values supported.

Height optional xs:int

For image formats, this is the height calculated internally based on the provided data.

Width optional xs:int

For image formats, this is the width calculated internally based on the provided data.

AttachmentName optional Restriction of xs:string

A merchant-assigned name for the associated attachment

AttachmentDataId xs:int

Gateway-generated attachment identifier

GetTransactionStatus PosGetTransactionStatusRspType Complex Type
All
TransactionStatus optional
TzConversion optional tzoneConversionType Simple Type

Time zone conversion applied to returned dates

GetUserSettings PosGetUserSettingsRspType Complex Type
GetUserDeviceSettings PosGetUserDeviceSettingsRspType Complex Type
GiftCardActivate PosGiftCardActivateRspType Complex Type
All
RspCode xs:int

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

BalanceAmt optional xs:decimal

Balance on the account after the transaction

PointsBalanceAmt optional xs:decimal

Points balance on the account after the transaction

Rewards optional xs:string

Identifies rewards added to the account as a result of a transaction

Notes optional xs:string

Contains rewards messages to be displayed by the client to inform an account holder about special rewards or promotions available

GiftCardAddValue PosGiftCardAddValueRspType Complex Type
All
RspCode xs:int

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

BalanceAmt optional xs:decimal

Balance on the account after the transaction

PointsBalanceAmt optional xs:decimal

Points balance on the account after the transaction

Rewards optional xs:string

Identifies rewards added to the account as a result of a transaction

Notes optional xs:string

Contains rewards messages to be displayed by the client to inform an account holder about special rewards or promotions available

GiftCardAlias PosGiftCardAliasRspType Complex Type
All
RspCode xs:int

Response (result) code returned by the issuer

RspText optional xs:string

Response (result) text returned by the issuer

CardData optional GiftCardDataRspType Complex Type

Information about the impacted account

All
CardNbr cardNbrType Simple Type

Stored value account number

Alias Restriction of xs:string

Echoed from the request

PIN optional Restriction of pinType Simple Type

A numeric PIN associated with the stored value account.

Note: This is not a PIN block as defined in debit transactions.

GiftCardBalance PosGiftCardBalanceRspType Complex Type
All
RspCode xs:int

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

BalanceAmt optional xs:decimal

Balance on the account after the transaction

PointsBalanceAmt optional xs:decimal

Points balance on the account after the transaction

Rewards optional xs:string

Identifies rewards added to the account as a result of a transaction

Notes optional xs:string

Contains rewards messages to be displayed by the client to inform an account holder about special rewards or promotions available

GiftCardCurrentDayTotals GiftCardTotalsType Complex Type
All
RspCode xs:int

Response (result) code returned by the issuer

RspText optional xs:string

Response (result) text returned by the issuer

SaleCnt optional xs:int

Number of sale transactions in the reporting period

SaleAmt optional xs:decimal

Sum of sale transaction amounts in the reporting period

ActivateCnt optional xs:int

Number of activate transactions in the reporting period

ActivateAmt optional xs:decimal

Sum of activate transaction amounts in the reporting period

AddValueCnt optional xs:int

Number of add value transactions in the reporting period

AddValueAmt optional xs:decimal

Sum of add value transaction amounts in the reporting period

VoidCnt optional xs:int

Number of void transactions in the reporting period

VoidAmt optional xs:decimal

Sum of void transaction amounts in the reporting period

DeactivateCnt optional xs:int

Number of deactivate transactions in the reporting period

DeactivateAmt optional xs:decimal

Sum of deactivate transaction amounts in the reporting period

GiftCardDeactivate PosGiftCardDeactivateRspType Complex Type
All
RspCode xs:int

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

RefundAmt optional xs:decimal

Balance on the account before it was deactivated; this should be refunded

PointsBalanceAmt optional xs:decimal

Point balance on the account before it was deactivated; the client must determine how to handle this

GiftCardPreviousDayTotals GiftCardTotalsType Complex Type
All
RspCode xs:int

Response (result) code returned by the issuer

RspText optional xs:string

Response (result) text returned by the issuer

SaleCnt optional xs:int

Number of sale transactions in the reporting period

SaleAmt optional xs:decimal

Sum of sale transaction amounts in the reporting period

ActivateCnt optional xs:int

Number of activate transactions in the reporting period

ActivateAmt optional xs:decimal

Sum of activate transaction amounts in the reporting period

AddValueCnt optional xs:int

Number of add value transactions in the reporting period

AddValueAmt optional xs:decimal

Sum of add value transaction amounts in the reporting period

VoidCnt optional xs:int

Number of void transactions in the reporting period

VoidAmt optional xs:decimal

Sum of void transaction amounts in the reporting period

DeactivateCnt optional xs:int

Number of deactivate transactions in the reporting period

DeactivateAmt optional xs:decimal

Sum of deactivate transaction amounts in the reporting period

GiftCardReplace PosGiftCardReplaceRspType Complex Type
All
RspCode xs:int

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

BalanceAmt optional xs:decimal

Balance on the new account after the transaction

PointsBalanceAmt optional xs:decimal

Points balance on the new account after the transaction

GiftCardReversal PosGiftCardReversalRspType Complex Type
All
RspCode xs:int

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

BalanceAmt optional xs:decimal

Balance on the account after the transaction

GiftCardReward PosGiftCardRewardRspType Complex Type
All
RspCode xs:int

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

BalanceAmt optional xs:decimal

Balance on the account after the transaction

PointsBalanceAmt optional xs:decimal

Points balance on the account after the transaction

Rewards optional xs:string

Identifies rewards added to the account as a result of a transaction

Notes optional xs:string

Contains rewards messages to be displayed by the client to inform an account holder about special rewards or promotions available

GiftCardSale PosGiftCardSaleRspType Complex Type
All
RspCode xs:int

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

BalanceAmt optional xs:decimal

Balance on the account after the transaction

SplitTenderCardAmt optional xs:decimal

If the stored account has insufficient funds to complete the sale, this field will contain the portion of the sale that was covered by the remaining funds in the account.

Note: In this case, the BalanceAmt should always be $0 after the sale since the balance was depleted trying to complete the sale.

SplitTenderBalanceDueAmt optional xs:decimal

If the stored account has insufficient funds to complete the sale, this field will contain the portion of the sale that was not covered. This is the amount that is still due from the customer. The client must collect this amount from the customer using an additional payment method.

PointsBalanceAmt optional xs:decimal

Points balance on the account after the transaction

Rewards optional xs:string

Identifies rewards added to the account as a result of a transaction

Notes optional xs:string

Contains rewards messages to be displayed by the client to inform an account holder about special rewards or promotions available

GiftCardTip PosGiftCardTipRspType Complex Type
All
RspCode xs:int

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

BalanceAmt optional xs:decimal

Balance on the account after the transaction

SplitTenderCardAmt optional xs:decimal

If the stored account has insufficient funds to complete the sale, this field will contain the portion of the sale that was covered by the remaining funds in the account.

Note: In this case, the BalanceAmt should always be $0 after the sale since the balance was depleted trying to complete the sale.

SplitTenderBalanceDueAmt optional xs:decimal

If the stored account has insufficient funds to complete the sale, this field will contain the portion of the sale that was not covered. This is the amount that is still due from the customer. The client must collect this amount from the customer using an additional payment method.

PointsBalanceAmt optional xs:decimal

Points balance on the account after the transaction

Rewards optional xs:string

Identifies rewards added to the account as a result of a transaction

Notes optional xs:string

Contains rewards messages to be displayed by the client to inform an account holder about special rewards or promotions available

GiftCardVoid PosGiftCardVoidRspType Complex Type
All
RspCode xs:int

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

BalanceAmt optional xs:decimal

Balance on the account after the transaction

PointsBalanceAmt optional xs:decimal

Points balance on the account after the transaction

Notes optional xs:string

Contains rewards messages to be displayed by the client to inform an account holder about special rewards or promotions available

Impersonate PosImpersonateRspType Complex Type
InvalidateAuthentication xs:anySimpleType
ManageSettings ManageSettingsRspType Complex Type
ManageUsers PosManageUsersRspType Complex Type
Sequence
Users 1..∞ PosUserDetailRspType Complex Type
Device 1..∞ DeviceType Complex Type
Sequence
DeviceId deviceIdType Simple Type
IndustryCode xs:string
DeviceTypeId xs:int
DeviceDescription optional xs:string
CheckProcessor optional xs:string
CheckSEC 0..∞ xs:string
PDLNotification optional booleanType Simple Type

PDLNotification flag that has been persisted for this device.

ParameterDownload PosParameterDownloadRspType Complex Type
All
RspCode xs:string

Response code returned by the Parameter Data Download system

RspText optional xs:string

Response text associated with RspCode

PDLBlockRsp optional xs:string

Pass-through PDL block response; full definition of this field must be obtained from the Parameter Data Download system

PDLResponse optional PDLResponseType Complex Type

Abstracted PDL response; full definition of these fields must be obtained from the Parameter Data Download system

Sequence
Version optional PDLVersionType Simple Type

Parameter or table version

BlockSequence PDLBlockSequenceType Simple Type

Sequence number for each block

TableID PDLTableIDType Simple Type

Table id

CardType optional PDLCardTypeType Simple Type

Card type

EndOfTableFlag optional booleanType Simple Type

End of table flag

ConfirmationFlag optional PDLConfirmationFlagType Simple Type

Confirmation flag

TableData optional PDLTableDataRspType Complex Type

Table data

PrePaidAddValue 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

PrePaidBalanceInquiry 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

RecurringBilling 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

RecurringBillingAuth 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 amtType Simple Type

The available balance on the associated account

AuthAmt optional amtType 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)
  • "21" (Recurring Payment Cancellation Service)

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

The IPTerms data block is included in a Credit response to provide the available terms for a cardholder. The program (mIPP or SIP) is echoed back from the request. The format of the term options is dictated by the program.

All
Program programType Simple Type

Valid values include:

  • mIPP
  • SIP

TermOptions optional TermOptionsType Simple Type

Term Options

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

ReportActivity PosReportActivityRspType Complex Type
Sequence
Header

Report header that can include general information related to the details, criteria used for the report, totals, etc.

All
RptStartUtcDT xs:dateTime

Start date time of report results in UTC (Coordinated Universal Time)

RptEndUtcDT xs:dateTime

End date time of report results in UTC (Coordinated Universal Time)

SiteId xs:int
MerchName xs:string

Merchant name associated with this site id

DeviceId optional xs:int

Device identifier of report results. If not present, results are for all devices associated with the site.

TxnCnt xs:int

Number of transactions in report results

Details 0..∞

Report details sorted by DeviceId, TxnUtcDT

Note: If the data was defined in the request or response, a description has not been added here; only fields that are being introduced in this response have additional detail added. Typically, these will be fields that drive business logic that can be assumed at the time of the transaction or they are calculated at the time of the report.

All
DeviceId xs:int
UserName xs:string
ServiceName xs:string

This is the original request type (i.e. CreditSale)

GatewayTxnId txnIdType Simple Type
TxnUtcDT xs:dateTime

Transaction response date time in UTC (Coordinated Universal Time)

OriginalGatewayTxnId txnIdType Simple Type

If the transaction performed an action on a previous transaction, this field records the transaction that was acted upon.

SiteTrace xs:string
GatewayRspCode xs:int

Gateway response code (issuer is separate)

GatewayRspMsg xs:string

Gateway response message

Status xs:string

The current transaction status at the time of the search.

These can vary, but some of the key status values include:

  • Active - 'A'
  • Closed - 'C'
  • Voided - 'V'
  • Inactive - 'I'
  • Reversed - 'R'

IssuerRspCode xs:string

Issuer response code

IssuerRspText xs:string

Issuer response text

MaskedCardNbr xs:string

This is the original transaction's card number, if any. It will contain the first six and last four digits with '*' filling in the middle. This value is safe for receipts and displays.

Amt xs:decimal

The original requested amount

TzConversion tzoneConversionType Simple Type

Time zone conversion applied to report results

TxnDT xs:dateTime

Transaction response date time in the time zone conversion requested

AuthAmt xs:decimal

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

SettlementAmt xs:decimal

The amount the transaction would settle for if it were closed as part of a batch

Note: This does not mean that it has or will close for this amount. The client controls this by adding it to the batch and closing the batch.

Note: This can be different from the original requested amount or the authorized amount for many reasons including: transaction edits (tip), reversals, additional authorizations, etc.

ClerkID optional xs:string
CredentialData optional CredentialDataType Complex Type

Credential details tied to a user session

Note: This is for internal use only.

UniqueDeviceId optional xs:string
EMVChipCondition optional xs:string
HasEMVTag optional xs:string

Indicates whether or not EMVTags were sent on this transaction; 'Y' indicates that it did and 'N' that it did not.

x_global_transaction_id optional x_global_transaction_idType Simple Type
ReportBatchDetail PosReportBatchDetailRspType Complex Type
Sequence
Header

Report header that can include general information related to the details, criteria used for the report, totals, etc.

All
SiteId xs:int
MerchName xs:string

Merchant name associated with this site id

DeviceId xs:int
BatchId xs:int
BatchStatus xs:string

The batch status at the time of the report.

Key batch status values include:

  • 'O' (open)
  • 'C' (closed)
  • 'E' (error)

BatchSeqNbr xs:int
OpenUtcDT xs:dateTime

Batch open date time in UTC (Coordinated Universal Time)

CloseUtcDT optional xs:dateTime

Batch close date time in UTC (Coordinated Universal Time)

OpenTxnId txnIdType Simple Type

The transaction identifier of the transaction that caused the batch to be opened

CloseTxnId optional txnIdType Simple Type

The transaction identifier of the transaction that caused the batch to be closed

BatchTxnCnt xs:int

Number of transactions in the batch

BatchTxnAmt xs:decimal

Sum of transaction amounts in the batch

HostBatchNbr optional xs:int

Host batch number.

HostBatchTxnCnt optional xs:int

Total number of transactions in the host batch.

HostBatchTxnAmt optional xs:decimal

Sum of transaction amounts in the host batch.

Details 0..∞

Report details sorted by TxnUtcDT

Note: If the data was defined in the request or response, a description has not been added here; only fields that are being introduced in this response have additional detail added. Typically, these will be fields that drive business logic that can be assumed at the time of the transaction or they are calculated at the time of the report.

Sequence
GatewayTxnId txnIdType Simple Type
TxnUtcDT xs:dateTime

Transaction response date time in UTC (Coordinated Universal Time)

TxnStatus xs:string

The current transaction status at the time of the search.

These can vary, but some of the key status values include:

  • Active - 'A'
  • Closed - 'C'
  • Voided - 'V'
  • Inactive - 'I'
  • Reversed - 'R'

SiteTrace xs:string
DebitCreditInd xs:string

Indicates if the transaction was a 'D' (debit) or 'C' (credit)

SaleReturnInd xs:string

Indicates if the transaction was a 'S' (sale) or 'R' (return)

CardSwiped xs:string

Indicates whether or not the payment method from the original transaction was swiped; 'Y' indicates that it was and 'N' that it was not.

CardType xs:string
MaskedCardNbr xs:string

This is the original transaction's card number, if any. It will contain the first six and last four digits with '*' filling in the middle. This value is safe for receipts and displays.

CardHolderLastName xs:string
CardHolderFirstName xs:string
CardHolderAddr xs:string
CardHolderCity xs:string
CardHolderState xs:string
CardHolderZip xs:string
CardHolderPhone xs:string
CardHolderEmail xs:string
GratuityAmtInfo xs:decimal
CashbackAmtInfo xs:decimal
AuthAmt xs:decimal

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

SettlementAmt xs:decimal

The amount the transaction would settle for if it were closed as part of this batch

Note: This can be different from the original requested amount or the authorized amount for many reasons including: transaction edits (tip), reversals, additional authorizations, etc.

RspCode xs:string

Issuer response code

RspText xs:string

Issuer response text

AuthCode xs:string
AVSRsltCode xs:string
CVVRsltCode xs:string
DirectMktInvoiceNbr xs:string
DirectMktShipMonth xs:int
DirectMktShipDay xs:int
CPCCardHolderPONbr xs:string
CPCTaxType xs:string
CPCTaxAmt xs:decimal
TzConversion tzoneConversionType Simple Type

Time zone conversion applied to report results

TxnDT xs:dateTime

Transaction response date time in the time zone conversion requested

Amt xs:decimal

The original requested amount

LodgingData optional LodgingDataType Complex Type
ClerkID optional Restriction of xs:string
ServiceName optional xs:string

This is the original request type (i.e. CreditSale)

AdditionalTxnFields optional AdditionalTxnFieldsType Complex Type
CredentialData optional CredentialDataType Complex Type

Credential details tied to a user session

Note: This is for internal use only.

ConvenienceAmtInfo optional xs:decimal
ShippingAmtInfo optional xs:decimal
AttachmentInfo 0..4 AttachmentInfoType Complex Type

Information regarding attachments that are available for this transaction.

PaymentMethodKey optional guidType Simple Type
RecurringData optional RecurringDataType Complex Type
SurchargeAmtInfo optional amtType Simple Type
EMVChipCondition optional xs:string
HasEMVTag optional xs:string

Indicates whether or not EMVTags were sent on this transaction; 'Y' indicates that it did and 'N' that it did not

Company optional xs:string

The company associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.

CustomerFirstname optional xs:string

The customer first name associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.

CustomerLastname optional xs:string

The customer last name associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.

AltPaymentData optional AltPaymentDataType Complex Type

A collection of AltPayment transaction related fields

HostBatchNbr optional xs:int

Host batch number.

HostItemNbr optional xs:int

Host batch item number.

x_global_transaction_id optional x_global_transaction_idType Simple Type

Client generated transaction identifier sent in the request of the original transaction. This indicates the transaction to be retrieved.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

CurrencyCodeAlpha xs:string

Indicates the currency text associated with the CardHolderCurrCode.

ReportBatchHistory PosReportBatchHistoryRspType Complex Type
Sequence
Header

Report header that can include general information related to the details, criteria used for the report, totals, etc.

All
RptStartUtcDT xs:dateTime

Start date time of report results in UTC (Coordinated Universal Time)

RptEndUtcDT xs:dateTime

End date time of report results in UTC (Coordinated Universal Time)

SiteId xs:int
MerchName xs:string

Merchant name associated with this site id

DeviceId optional xs:int

Device identifier of report results, if not present results are for all devices associated with the site

BatchCnt xs:int

Number of batches

BatchAmt xs:decimal

Sum of all batch amounts

Details 0..∞

Report details, sorted by DeviceId, OpenUtcDT

Note: If the data was defined in the request or response, a description has not been added here; only fields that are being introduced in this response have additional detail added. Typically, these will be fields that drive business logic that can be assumed at the time of the transaction or they are calculated at the time of the report.

All
DeviceId xs:int
BatchId xs:int
BatchStatus xs:string

The batch status at the time of the report.

Key batch status values include:

  • 'O' (open)
  • 'C' (closed)
  • 'E' (error)

BatchSeqNbr xs:int
OpenUtcDT xs:dateTime

Batch open date time in UTC (Coordinated Universal Time)

CloseUtcDT optional xs:dateTime

Batch close date time in UTC (Coordinated Universal Time)

OpenTxnId txnIdType Simple Type

The transaction identifier of the transaction that caused the batch to be opened

CloseTxnId optional txnIdType Simple Type

The transaction identifier of the transaction that caused the batch to be closed

BatchTxnCnt xs:int

Number of transactions in the batch

BatchTxnAmt xs:decimal

Sum of transaction amounts in the batch

TzConversion tzoneConversionType Simple Type

Time zone conversion applied to report results

OpenDT xs:dateTime

Batch open date time in the time zone conversion requested

CloseDT optional xs:dateTime

Batch close date time in the time zone conversion requested

ReportBatchSummary PosReportBatchSummaryRspType Complex Type
Sequence
Header

Report header that can include general information related to the details, criteria used for the report, totals, etc.

All
SiteId xs:int
MerchName xs:string

Merchant name associated with this site id

DeviceId xs:int
BatchId xs:int
BatchStatus xs:string

The batch status at the time of the report.

Key batch status values include:

  • 'O' (open)
  • 'C' (closed)
  • 'E' (error)

BatchSeqNbr xs:int
OpenUtcDT xs:dateTime

Batch open date time in UTC (Coordinated Universal Time)

CloseUtcDT optional xs:dateTime

Batch close date time in UTC (Coordinated Universal Time)

OpenTxnId txnIdType Simple Type

The transaction identifier of the transaction that caused the batch to be opened

CloseTxnId optional txnIdType Simple Type

The transaction identifier of the transaction that caused the batch to be closed

CreditCnt xs:int

Number of credit transactions in the batch

CreditAmt xs:decimal

Sum of credit transaction amounts in the batch

DebitCnt xs:int

Number of debit transactions in the batch

DebitAmt xs:decimal

Sum of debit transaction amounts in the batch

SaleCnt xs:int

Number of sale transactions in the batch

SaleAmt xs:decimal

Sum of sale transaction amounts in the batch

ReturnCnt xs:int

Number of return transactions in the batch

ReturnAmt xs:decimal

Sum of return transaction amounts in the batch

TotalCnt xs:int

Total number of transactions in the batch

TotalAmt xs:decimal

Sum of transaction amounts in the batch

TotalGratuityAmtInfo xs:decimal

Sum of gratuity amounts in the batch. Gratuity amounts, if any, are already included in the other amounts.

TotalHCPCnt xs:int

Total number of Home Currency Pay transactions in the batch

HostBatchNbr optional xs:int

Host batch number.

HostTotalCnt optional xs:int

Total number of transactions in the host batch.

HostTotalAmt optional xs:decimal

Sum of transaction amounts in the host batch.

HostCreditSaleCnt optional xs:int

Number of credit sale transactions in the host batch.

HostCreditSaleAmt optional xs:decimal

Sum of credit sale transaction amounts in the host batch.

HostCreditReturnCnt optional xs:int

Number of credit return transactions in the host batch.

HostCreditReturnAmt optional xs:decimal

Sum of credit return transaction amounts in the host batch.

HostDebitSaleCnt optional xs:int

Number of debit sale transactions in the host batch.

HostDebitSaleAmt optional xs:decimal

Sum of debit sale transaction amounts in the host batch.

HostDebitReturnCnt optional xs:int

Number of debit return transactions in the host batch.

HostDebitReturnAmt optional xs:decimal

Sum of debit return transaction amounts in the host batch.

Details 0..∞

Report details, sorted by CardType

Note: If the data was defined in the request or response, a description has not been added here; only fields that are being introduced in this response have additional detail added. Typically, these will be fields that drive business logic that can be assumed at the time of the transaction or they are calculated at the time of the report.

All
CardType xs:string
CreditCnt xs:int

Number of credit transactions in the batch

CreditAmt xs:decimal

Sum of credit transaction amounts in the batch

DebitCnt xs:int

Number of debit transactions in the batch

DebitAmt xs:decimal

Sum of debit transaction amounts in the batch

SaleCnt xs:int

Number of sale transactions in the batch

SaleAmt xs:decimal

Sum of sale transaction amounts in the batch

ReturnCnt xs:int

Number of return transactions in the batch

ReturnAmt xs:decimal

Sum of return transaction amounts in the batch

TotalCnt xs:int

Total number of transactions in the batch

TotalAmt xs:decimal

Sum of transaction amounts in the batch

TotalGratuityAmtInfo xs:decimal

Sum of gratuity amounts in the batch. Gratuity amounts, if any, are already included in the other amounts.

TotalHCPCnt xs:int

Total number of Home Currency Pay transactions in the batch

ReportOpenAuths PosReportOpenAuthsRspType Complex Type
Sequence
Header

Report header that can include general information related to the details, criteria used for the report, totals, etc.

All
SiteId xs:int
MerchName xs:string

Merchant name associated with this site id

DeviceId optional xs:int

Device identifier of report results. If not present, results are for all devices associated with the site.

TxnCnt xs:int

Number of transactions in the batch

TxnAmt xs:decimal

Sum of transaction amounts in the batch

Details 0..∞

Report details, sorted by DeviceId, TxnUtcDT

Note: If the data was defined in the request or response, a description has not been added here; only fields that are being introduced in this response have additional detail added. Typically, these will be fields that drive business logic that can be assumed at the time of the transaction or they are calculated at the time of the report.

All
DeviceId xs:int
GatewayTxnId txnIdType Simple Type
TxnStatus xs:string

The current transaction status at the time of the search.

These can vary, but some of the key status values include:

  • Active - 'A'
  • Closed - 'C'
  • Voided - 'V'
  • Inactive - 'I'
  • Reversed - 'R'

TxnUtcDT xs:dateTime

Transaction response date time in UTC (Coordinated Universal Time)

SiteTrace xs:string
DebitCreditInd xs:string

Indicates if the transaction was a 'D' (debit) or 'C' (credit)

SaleReturnInd xs:string

Indicates if the transaction was a 'S' (sale) or 'R' (return)

CardSwiped xs:string

Indicates whether or not the payment method from the original transaction was swiped; 'Y' indicates that it was and 'N' that it was not.

CardType xs:string
MaskedCardNbr xs:string

This is the original transaction's card number, if any. It will contain the first six and last four digits with '*' filling in the middle. This value is safe for receipts and displays.

CardHolderLastName xs:string
CardHolderFirstName xs:string
CardHolderAddr xs:string
CardHolderCity xs:string
CardHolderState xs:string
CardHolderZip xs:string
CardHolderPhone xs:string
CardHolderEmail xs:string
Amt xs:decimal

The original requested amount

AuthAmt xs:decimal

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

SettlementAmt xs:decimal

The amount the transaction would settle for if it were closed as part of a batch

Note: This does not mean that it has or will close for this amount. The client controls this by adding it to the batch and closing the batch.

Note: This can be different from the original requested amount or the authorized amount for many reasons including: transaction edits (tip), reversals, additional authorizations, etc.

GratuityAmtInfo xs:decimal
CashbackAmtInfo xs:decimal
RspCode xs:string

Issuer response code

RspText xs:string

Issuer response text

AuthCode xs:string
AVSRsltCode xs:string
CVVRsltCode xs:string
DirectMktInvoiceNbr xs:string
DirectMktShipMonth xs:int
DirectMktShipDay xs:int
CPCCardHolderPONbr xs:string
CPCTaxType xs:string
CPCTaxAmt xs:decimal
TzConversion tzoneConversionType Simple Type

Time zone conversion applied to report results

TxnDT xs:dateTime

Transaction response date time in the time zone conversion requested

ClerkID optional xs:string
CredentialData optional CredentialDataType Complex Type

Credential details tied to a user session

Note: This is for internal use only.

EMVChipCondition optional xs:string
HasEMVTag optional xs:string

Indicates whether or not EMVTags were sent on this transaction; 'Y' indicates that it did and 'N' that it did not.

ReportSearch PosReportSearchRspType Complex Type
Sequence
Header

Report header that can include general information related to the details, criteria used for the report, totals, etc.

All
RptStartUtcDT xs:dateTime

Start date time of report results in UTC (Coordinated Universal Time)

RptEndUtcDT xs:dateTime

End date time of report results in UTC (Coordinated Universal Time)

SiteId xs:int
MerchName xs:string

Merchant name associated with this site id

DeviceId optional xs:int

Device identifier of report results, if not present results are for all devices.

TxnCnt xs:int

Number of transactions in the results

TxnAmt xs:decimal

Sum of transaction amounts in the results

Details 0..∞

Report details, in the order found

Note: If the data was defined in the request or response, a description has not been added here; only fields that are being introduced in this response have additional detail added. Typically, these will be fields that drive business logic that can be assumed at the time of the transaction or they are calculated at the time of the report.

All
GatewayTxnId txnIdType Simple Type
DeviceId deviceIdType Simple Type
ServiceName xs:string

This is the original request type (i.e. CreditSale)

TxnUtcDT xs:dateTime

Transaction response date time in UTC (Coordinated Universal Time)

TxnStatus xs:string

The current transaction status at the time of the search

These can vary, but some of the key status values include:

  • Active - 'A'
  • Closed - 'C'
  • Voided - 'V'
  • Inactive - 'I'
  • Reversed - 'R'

SiteTrace xs:string
DebitCreditInd xs:string

Indicates if the transaction was a 'D' (debit) or 'C' (credit)

SaleReturnInd xs:string

Indicates if the transaction was a 'S' (sale) or 'R' (return)

CardType xs:string
MaskedCardNbr xs:string

This is the original transaction's card number, if any. It will contain the first six and last four digits with '*' filling in the middle. This value is safe for receipts and displays.

Amt xs:decimal

The original requested amount

AuthAmt xs:decimal

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

SettlementAmt xs:decimal

The amount the transaction would settle for if it were closed as part of a batch

Note: This does not mean that it has or will close for this amount. The client controls this by adding it to the batch and closing the batch.

Note: This can be different from the original requested amount or the authorized amount for many reasons including: transaction edits (tip), reversals, additional authorizations, etc.

CashbackAmtInfo xs:decimal
GratuityAmtInfo xs:decimal
RspCode xs:string

Issuer response code

RspText xs:string

Issuer response text

AuthCode xs:string
TzConversion tzoneConversionType Simple Type

Time zone conversion applied to report results

TxnDT xs:dateTime

Transaction response date time in the time zone conversion requested

ClerkID optional xs:string
CredentialData optional CredentialDataType Complex Type

Credential details tied to a user session

Note: This is for internal use only.

EMVChipCondition optional xs:string
HasEMVTag optional xs:string

Indicates whether or not EMVTags were sent on this transaction; 'Y' indicates that it did and 'N' that it did not

ReportTxnDetail PosReportTxnDetailRspType Complex Type
All
GatewayTxnId txnIdType Simple Type
ClientTxnId clientIdType Simple Type
SiteId xs:int

Site identifier used to process the request.

MerchName xs:string

Merchant name associated with this site id

DeviceId xs:int

Device identifier used to process the request.

UserName xs:string
ServiceName xs:string

This is the original request type (i.e. CreditSale)

GatewayRspCode xs:int

Gateway response code (issuer is separate)

GatewayRspMsg xs:string

Gateway response message

ReqUtcDT xs:dateTime

Transaction request date time in UTC (Coordinated Universal Time)

ReqDT xs:dateTime

Transaction request date time in the time zone conversion requested

RspUtcDT xs:dateTime

Transaction response date time in UTC (Coordinated Universal Time)

RspDT xs:dateTime

Transaction response date time in the time zone conversion requested

SiteTrace xs:string
OriginalGatewayTxnId txnIdType Simple Type

If the transaction performed an action on a previous transaction, this field records the transaction ID that was acted upon.

MerchNbr xs:string

The merchant number (MID) associated with this site id

TermOrdinal xs:int

Terminal ordinal number associated with this device id

MerchAddr1 xs:string

Merchant address 1 associated with this site id

MerchAddr2 xs:string

Merchant address 2 associated with this site id

MerchCity xs:string

Merchant city associated with this site id

MerchState xs:string

Merchant state associated with this site id

MerchZip xs:string

Merchant zip associated with this site id

MerchPhone xs:string

Merchant phone number associated with this site id

TzConversion tzoneConversionType Simple Type

Time zone conversion applied to report results

UniqueDeviceId optional xs:string
Data

Transaction details

Sequence
TxnStatus xs:string

The current transaction status at the time of the search.

These can vary, but some of the key status values include:

  • Active - 'A'
  • Closed - 'C'
  • Voided - 'V'
  • Inactive - 'I'
  • Reversed - 'R'

CardType xs:string
MaskedCardNbr xs:string

This is the original transaction's card number, if any. It will contain the first six and last four digits with '*' filling in the middle. This value is safe for receipts and displays.

CardPresent xs:string
ReaderPresent xs:string
CardSwiped xs:string

Indicates whether or not the payment method from the original transaction was swiped; 'Y' indicates that it was and 'N' that it was not

DebitCreditInd xs:string

Indicates if the transaction was a 'D (debit) or 'C' (credit)

SaleReturnInd xs:string

Indicates if the transaction was a 'S' (sale) or 'R' (return)

CVVReq xs:string
CVVRsltCode xs:string
Amt xs:decimal

The original requested amount

AuthAmt xs:decimal

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

GratuityAmtInfo xs:decimal
CashbackAmtInfo xs:decimal
CardHolderLastName xs:string
CardHolderFirstName xs:string
CardHolderAddr xs:string
CardHolderCity xs:string
CardHolderState xs:string
CardHolderZip xs:string
CardHolderPhone xs:string
CardHolderEmail xs:string
AVSRsltCode xs:string
CPCReq xs:string
CPCInd xs:string
RspCode xs:string

Issuer response code

RspText xs:string

Issuer response text

AuthCode xs:string
ReqACI xs:string

Requested authorization characteristics indicator

RspACI xs:string

Response authorization characteristics indicator

MktSpecDataId xs:string

Market specific data identifier

TxnCode xs:string

Transaction code

AcctDataSrc xs:string

Account data source code. This is a derived value that represents the source of the account data received. For example, proximity vs. swiped vs. manual, et al.

AuthSrcCode xs:string

Authorization source code

IssTxnId xs:string

Issuer transaction identifier

IssValidationCode xs:string

Issuer validation code

CardHolderIdCode xs:string

Card holder identification code

NetworkIdCode xs:string

Network identification code

RefNbr xs:string

Retrieval reference number

TxnSeqNbr xs:int

Transaction sequence number incremented with each authorization requested by a device

DirectMktInvoiceNbr xs:string
DirectMktShipMonth xs:int
DirectMktShipDay xs:int
CPCCardHolderPONbr xs:string
CPCTaxType xs:string
CPCTaxAmt xs:decimal
SettlementAmt xs:decimal

The amount the transaction would settle for if it were closed as part of a batch

Note: This does not mean that it has or will close for this amount. The client controls this by adding it to the batch and closing the batch.

Note: This can be different from the original requested amount or the authorized amount for many reasons including: transaction edits (tip), reversals, additional authorizations, etc.

AllowPartialAuth booleanType Simple Type
AutoSubstantiation optional AutoSubstantiationReportType Complex Type
AdditionalTxnFields optional AdditionalTxnFieldsType Complex Type
Attachment optional AttachmentRspDataType Complex Type

Attachment data

AVSRsltText optional xs:string
CVVRsltText optional xs:string
Ecommerce optional eCommerceType Simple Type
TokenizationMsg optional xs:string

Tokenization action taken

CryptoTypeIn optional xs:string

Encryption type in request

CryptoTypeOut optional xs:string

Encryption type used internally

ClerkID optional xs:string
CredentialData optional CredentialDataType Complex Type

Credential details tied to a user session

Note: This is for internal use only.

LodgingData optional LodgingDataType Complex Type
ConvenienceAmtInfo optional xs:decimal
ShippingAmtInfo optional xs:decimal
TxnDescriptor optional xs:string
CheckDataInfo optional CheckDataInfoType Complex Type

A collection of check transaction related fields

AttachmentInfo 0..4 AttachmentInfoType Complex Type

Information regarding attachments that are available for this transaction.

GiftData optional GiftDataType Complex Type

A collection of stored value transaction related fields

PaymentMethodKey optional guidType Simple Type
RecurringData optional RecurringDataType Complex Type
SurchargeAmtInfo optional amtType Simple Type
CashData optional CashDataType Complex Type

A collection of cash transaction related fields

ReturnAmtInfo optional xs:decimal

This is the total amount of returns that have been done against this specific transaction

ReversalAmtInfo optional xs:decimal

This is the total amount of reversals that have been done against this specific transaction

IncrementalAuthAmtInfo optional xs:decimal

This is the total amount of incremental authorizations that have been done against this specific transaction

AllowDup optional Restriction of xs:string
SystemAuditTraceNumber optional Restriction of xs:string

System audit trace number

LodgingCheckInDate optional xs:dateTime
LodgingCheckOutDate optional xs:dateTime
ProcessorRefNum optional Restriction of xs:string

Reference number returned by processor

ReversalIndicator optional Restriction of xs:string

Indicates that this transaction was reversed

TokenRequested optional Restriction of xs:string

Indicates that a request for a token was made on this transaction

TokenGenerated optional Restriction of xs:string

Indicates that a Token was generated as a result of this transaction

EMVChipCondition optional xs:string
EMVTagData optional xs:string

EMV tag data in TLV format.

Note: This field has been obsoleted.See the TagData field for the alternative.

EMVIssuerResp optional xs:string

EMV tag data returned by the issuer in TLV format

TypeOfPaymentData optional xs:string

Type of SecureECommerce Payment Data.

PaymentData optional xs:string

SecureECommerce Payment Data.

ECommerceIndicator optional xs:string

Electronic Commerce Indicator when using SecureECommerce.

CAVVResultCode optional xs:string

The Visa Cardholder Authentication Verfication Value results code returned by the Issuer when using SecureECommerce.

TokenPANLast4 optional xs:string

Last 4 digits of PAN associated with Token returned by the Issuer when using SecureECommerce.

Company optional xs:string

The company associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.

CustomerFirstname optional xs:string

The customer first name associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.

CustomerLastname optional xs:string

The customer last name associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.

DebtRepaymentIndicator optional debtRepaymentType Simple Type

Allows for flagging this transaction as being against a debt obligation. Only use this field with Heartland's explicit direction. This flag is used to identify transactions that might qualify for VISA's Debt Repayment Program special interchange rates.

AltPaymentData optional AltPaymentDataType Complex Type

A collection of AltPayment transaction related fields

MultiFulfillmentData optional MultiFulfillmentDataType Complex Type

A collection of transaction of multi-fulfillment related fields

PaymentDataSource optional xs:string

Source of SecureECommerce Payment Data.

TagData optional TagDataType Complex Type

EMV or Non-EMV tag data in TLV format

XID optional xs:string

SecureECommerce XID.

CardOnFileData optional CardOnFileDataType Complex Type

The Card on File data received in the request.

CardBrandTxnId optional xs:string

The CardBrandTxnId for this transaction.

PaymentFacilitatorData optional PaymentFacilitatorDataType Complex Type
Secure3D optional Secure3DType Complex Type
WalletData optional WalletDataType Complex Type
x_global_transaction_id optional x_global_transaction_idType Simple Type
MerchAddr3 optional xs:string

Merchant address 3 associated with this site id

AuthenticatedSiteId optional siteIdType Simple Type

Authenticated Site identifier received in the request header.

AuthenticatedDeviceId optional deviceIdType Simple Type

Authenticated Device identifier received in the request header.

CrossMidTidInd optional xs:string

Indicates whether the transaction was processed as a Cross MID or Cross TID transaction.

CorporateData optional CorporateDataType Complex Type

Corporate/Purchasing Card Level III data

Sequence
Choice
Visa VisaType Complex Type

Visa Corporate/Purchasing Card Level III data.

MC MCType Complex Type

MC Corporate/Purchasing Card Level III data.

RewardCashData optional RewardCashDataType Complex Type

RewardCashData details.

All
GiftCode1 optional RCGiftCodeType Simple Type
Quantity1 optional xs:int
GiftCode2 optional RCGiftCodeType Simple Type
Quantity2 optional xs:int
GiftCode3 optional RCGiftCodeType Simple Type
Quantity3 optional xs:int
CashDiscountUsed CashDiscountType Simple Type
RewardCashRedeemed xs:decimal

Points redeemed

FileReferenceNbr xs:string

Reference number returned by the processor or issuer

SAFData optional SAFDataType Complex Type

SAF details

All
SAFIndicator booleanType Simple Type

Indicates that transaction was initiated in "store and forward" (SAF) mode (Y)

SAFOrigDT optional xs:dateTime

Date and time when the transaction was originally initiated.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

CurrencyCodeAlpha xs:string

Indicates the currency text associated with the CardHolderCurrCode.

IPSelectedTerms optional IPSelectedTermsReqType Complex Type

This service is only available for merchants on the AP host, or merchants in Mexico on the GSAP host.

All
Program optional programType Simple Type

Valid values include:

  • HSBCIPP
  • mIPP
  • SIP

Note: This field is available to Asia Pacific merchants only.

SIPOptions optional sipOptionsType Simple Type

Optional, sent for SIP only

Valid values include:

  • 01 - SIPZERO
  • 02 - SIPREGULAR
  • 03 - SIPMADNESS

Note: This field is available to Asia Pacific merchants only.

InstallmentPlan optional installmentPlanType Simple Type

Valid values include:

  • 00 - No promotion
  • 03 - Without interest to the cardholder
  • 05 - With interest to the cardholder
  • 07 - Buy today, pay later

Note: This field is available to Mexico merchants only.

GracePeriod optional gracePeriodType Simple Type

The grace period before the first payment. 00 indicates no grace period.

Note: This field is available to Mexico merchants only.

NbrInstallments nbrInstallmentsType Simple Type

Number of Installments, 01-99

Note: This field is applicable to both the AP and GSAP hosts.

RewardCashQuery PosRewardCashQueryRspType 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

AvailableRewardCashBalance xs:decimal

Available Points balance on the cardholder account

FileReferenceNbr optional xs:string

Reference number returned by the processor or issuer

RewardCashRedeem PosRewardCashRedeemRspType 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

PromotionCode xs:string

Response (result) code returned by the issuer

PromotionMessageCode optional xs:string

Response (result) text returned by the issuer

PromotionDiscountPercentage optional xs:string

Response (result) text returned by the issuer

TotalRewardCashRedeemed xs:decimal

Points redeemed

MaximumCashDiscount optional xs:decimal

Response (result) returned by the issuer

FileReferenceNbr optional xs:string

Reference number returned by the processor or issuer

SendReceipt
TestCredentials xs:anySimpleType
InteracDeviceKeys PosInteracDeviceKeysRspType Complex Type
All
FieldKey optional xs:string

Key generated and provided to the PIN pad. This key is used to decrypt the balance information.

MacKey optional xs:string

Key generated and provided to the PIN pad. Key is used to generate the MAC value.

MessageAuthenticationCode optional xs:string

Used to transmit the Message Authentication Code for Canadian debit transactions.

PinKey optional xs:string

Key used to encrypt PIN. Maintained in PIN Pad.

RspCode optional xs:string
RspText optional xs:string
Source
<xs:element name="Transaction" minOccurs="0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <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="RewardCashQuery" type="PosRewardCashQueryRspType" />
      <xs:element name="RewardCashRedeem" type="PosRewardCashRedeemRspType" />
      <xs:element name="SendReceipt" />
      <xs:element name="TestCredentials" type="xs:anySimpleType" />
      <xs:element name="InteracDeviceKeys" type="PosInteracDeviceKeysRspType" />
    </xs:choice>
  </xs:complexType>
</xs:element>
See Also
Ver1.0 Element | PosResponse Element | Portico Schema

 

 

© 2021 Heartland Payment Systems, Inc.