Open the Portico Developer Guide site
PosGateway Schema
Transaction Element
PosGateway 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
NTRSTokenMetadata Element NTRSUpdateTokenStatus Element NTRSTokenStatus Element NTRSGetTokenCryptogram Element NTRSCreateToken Element BNPLCreateOrder Element InteracDeviceKeys Element TestCredentials Element SurchargeEligibilityLookup Element TokenUpdaterHistory Element SendReceipt Element SendFunds Element RewardCashRedeem Element RewardCashQuery Element ReportTxnResearch 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 amtTypeGlobal Simple Type

Return Amount

TotalReturnAmt optional amtTypeGlobal 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 amtTypeGlobal 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 amtTypeGlobal Simple Type

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.

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.

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

DebitAuth AuthRspStatusType Complex Type
All
RspCode xs:string

Response (result) code returned by the issuer

RspText optional xs:string

Response (result) text returned by the issuer

AuthCode optional xs:string

If authorized, authorization code returned by the issuer

AVSRsltCode optional xs:string

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

CVVRsltCode optional xs:string

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

CPCInd optional xs:string

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

Valid values include:

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

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

RefNbr optional xs:string

Reference number returned by the processor or issuer

AvailableBalance optional amtTypeGlobal Simple Type

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

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

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

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

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

All
Program programType Simple Type

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

TermOptions optional TermOptionsType Simple Type

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

The format is based by the Program.

VISEligiblePlans optional

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

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

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

PaymentFacilitatorTxnId optional xs:string

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

PaymentFacilitatorTxnNbr optional xs:string

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

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

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

RateLookupTxnId optional guidType Simple Type

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

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

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

AccountReference optional xs:string

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

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

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

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

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

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

AVSResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

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

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

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

RecurringDataCode optional xs:string

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

Valid values include:

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

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

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

TokenPANLast4 optional xs:string

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

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

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

HostRspDT optional xs:dateTime

Processing Host response date and time.

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

CardBrandTxnId optional xs:string

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

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

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

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

Information on the Installment Plan chosen by the customer. Usage varies by region and the Installments service provider:

Merchants located in the Asia Pacific region must provide the NbrInstallments and Program. SIPOptions is optional.

Merchants located in Mexico must provide the NbrInstallemnts, InstallmentPlan, and GracePeriod only.

Merchants located in Canada using Visa Installment Service (VIS) must provide the Program and VISOptions.

All
Program programType Simple Type

The installment payments program type. This value is echoed from the request.

TermOptions optional TermOptionsType Simple Type

Term Options, only returned for the mIPP or SIP Programs.

The format is based by the Program.

VISEligiblePlans optional

This block provides information regarding eligible Visa Installment Service (VIS) installment plans, to be presented to the cardholder (EligiblePlans).

When the CardNbr and Amt are eligible, VIS returns 2 to n installment plans. Multiple plans are returned in the response.

When the CardNbr and Amt are not eligible, VIS returns a success response but EligiblePlans will be empty.

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator. This identifier is for use only by the payment facilitator, and should not be used as a reference in future client requests to the Portico Gateway.

PaymentFacilitatorTxnNbr optional xs:string

Unique account identifier assigned by the payment facilitator for the sub-merchant. This is used as the sub-merchant account reference if contacting the payment facilitator for support.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

This setting indicates if the Customer has decided Opt Out of currency conversion and have the amount remain in the Merchants currency. If the customer does not opt out, the amount will be converted to currency associated with the card.

RateLookupTxnId optional guidType Simple Type

The Retrieval Reference Number (RRN) of the RateLookup or Incremental Authorization that provided the rate used for the calculations in this transaction, if it is different from the original Authorization.

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

The mark up percentage applied to the transaction, resulting in the commission fee.

AccountReference optional xs:string

'Payment Account Reference' (PAR) data returned by issuer. PAR is 29-character alphanumeric reference number associated with each unique PAN and used by merchants to track transactions associated with customers PAN. Currently, PAR is only supported by Card Brand American Express.

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

Value returned by Visa in authorization responses for merchants participating in the Commercial Choice Program.

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 amtTypeGlobal Simple Type

The original requested amount

AuthAmt optional amtTypeGlobal Simple Type

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

SettlementAmt amtTypeGlobal Simple Type

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 amtTypeGlobal Simple Type
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 amtTypeGlobal Simple Type
ShippingAmtInfo optional amtTypeGlobal Simple Type
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 amtTypeGlobal 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.

Integration must be through GP-API

AccountReference optional xs:string

'Payment Account Reference' (PAR) data returned by issuer. PAR is 29-character alphanumeric reference number associated with each unique PAN and used by merchants to track transactions associated with customers PAN. Currently, PAR is only supported by Card Brand American Express.

Note: Account Reference is supported only for HOST Exchange.

ProcessedTxnMcc optional mccType Simple Type

The merchant category code (MCC)  used in the authorization request; if not provided the default MCC configured for the Device is assumed.

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 amtTypeGlobal Simple Type

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

Note: If not returned, the authorized amount is the requested amount.

AVSResultCodeAction optional resultCodeActionType Simple Type

AVS result action; this is a "suggestion" to the client based on the device's configuration during boarding and the AVS result received.

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

CVV result action; this is a "suggestion" to the client based on the device's configuration during boarding and the CVV result received.

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

The dynamic portion of this was provided in the header of the request; this is the final string sent to the issuer based on the provided value and the values configured during boarding

RecurringDataCode optional xs:string

MasterCard value that may be returned on recurring transactions. The only potential value on an approval is "01"; any of the other values may be returned on a decline.

Valid values include:

  • "01" (New account information available)
  • "02" (Cannot approve at this time, try again later)
  • "03" (Do not try again)
  • "04" (Declined due to lack of cryptography or partial shipment indicator)
  • "21" (Recurring Payment Cancellation Service)
  • "24" (Retry after 1 hour)
  • "25" (Retry after 24 hour)
  • "26" (Retry after 2 days)
  • "27" (Retry after 4 days)
  • "28" (Retry after 6 days)
  • "29" (Retry after 8 days)
  • "30" (Retry after 10 days)

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

The Visa Cardholder Authentication Verfication Value results code. This is returned by Visa when using SecureECommerce.

TokenPANLast4 optional xs:string

Last 4 digits of PAN associated with Token. This may be returned by issuer when using SecureECommerce.

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

A block of encrypted data to be sent from the POS on every contact Interac sale and return request. Required for Canadian merchants processing debit reversals.

HostRspDT optional xs:dateTime

Processing Host response date and time.

Note:For Canadian merchants, the HostRspDT contains the timestamp to be printed on the customer receipt.

CardBrandTxnId optional xs:string

This is the Network Transaction Identifier returned by the Card Brand.

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

The IPSelectedTermsRsp data block is included in a Credit response to provide the name of the issuer and/or the authorized terms. The data returned is dependent on the Program.

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

Information on the Installment Plan chosen by the customer. Usage varies by region and the Installments service provider:

Merchants located in the Asia Pacific region must provide the NbrInstallments and Program. SIPOptions is optional.

Merchants located in Mexico must provide the NbrInstallemnts, InstallmentPlan, and GracePeriod only.

Merchants located in Canada using Visa Installment Service (VIS) must provide the Program and VISOptions.

All
Program programType Simple Type

The installment payments program type. This value is echoed from the request.

TermOptions optional TermOptionsType Simple Type

Term Options, only returned for the mIPP or SIP Programs.

The format is based by the Program.

VISEligiblePlans optional

This block provides information regarding eligible Visa Installment Service (VIS) installment plans, to be presented to the cardholder (EligiblePlans).

When the CardNbr and Amt are eligible, VIS returns 2 to n installment plans. Multiple plans are returned in the response.

When the CardNbr and Amt are not eligible, VIS returns a success response but EligiblePlans will be empty.

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator. This identifier is for use only by the payment facilitator, and should not be used as a reference in future client requests to the Portico Gateway.

PaymentFacilitatorTxnNbr optional xs:string

Unique account identifier assigned by the payment facilitator for the sub-merchant. This is used as the sub-merchant account reference if contacting the payment facilitator for support.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

This setting indicates if the Customer has decided Opt Out of currency conversion and have the amount remain in the Merchants currency. If the customer does not opt out, the amount will be converted to currency associated with the card.

RateLookupTxnId optional guidType Simple Type

The Retrieval Reference Number (RRN) of the RateLookup or Incremental Authorization that provided the rate used for the calculations in this transaction, if it is different from the original Authorization.

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

The mark up percentage applied to the transaction, resulting in the commission fee.

AccountReference optional xs:string

'Payment Account Reference' (PAR) data returned by issuer. PAR is 29-character alphanumeric reference number associated with each unique PAN and used by merchants to track transactions associated with customers PAN. Currently, PAR is only supported by Card Brand American Express.

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

Value returned by Visa in authorization responses for merchants participating in the Commercial Choice Program.

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 amtTypeGlobal Simple Type

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

Note: If not returned, the authorized amount is the requested amount.

AVSResultCodeAction optional resultCodeActionType Simple Type

AVS result action; this is a "suggestion" to the client based on the device's configuration during boarding and the AVS result received.

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

CVV result action; this is a "suggestion" to the client based on the device's configuration during boarding and the CVV result received.

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

The dynamic portion of this was provided in the header of the request; this is the final string sent to the issuer based on the provided value and the values configured during boarding

RecurringDataCode optional xs:string

MasterCard value that may be returned on recurring transactions. The only potential value on an approval is "01"; any of the other values may be returned on a decline.

Valid values include:

  • "01" (New account information available)
  • "02" (Cannot approve at this time, try again later)
  • "03" (Do not try again)
  • "04" (Declined due to lack of cryptography or partial shipment indicator)
  • "21" (Recurring Payment Cancellation Service)
  • "24" (Retry after 1 hour)
  • "25" (Retry after 24 hour)
  • "26" (Retry after 2 days)
  • "27" (Retry after 4 days)
  • "28" (Retry after 6 days)
  • "29" (Retry after 8 days)
  • "30" (Retry after 10 days)

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

The Visa Cardholder Authentication Verfication Value results code. This is returned by Visa when using SecureECommerce.

TokenPANLast4 optional xs:string

Last 4 digits of PAN associated with Token. This may be returned by issuer when using SecureECommerce.

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

A block of encrypted data to be sent from the POS on every contact Interac sale and return request. Required for Canadian merchants processing debit reversals.

HostRspDT optional xs:dateTime

Processing Host response date and time.

Note:For Canadian merchants, the HostRspDT contains the timestamp to be printed on the customer receipt.

CardBrandTxnId optional xs:string

This is the Network Transaction Identifier returned by the Card Brand.

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

The IPSelectedTermsRsp data block is included in a Credit response to provide the name of the issuer and/or the authorized terms. The data returned is dependent on the Program.

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

Information on the Installment Plan chosen by the customer. Usage varies by region and the Installments service provider:

Merchants located in the Asia Pacific region must provide the NbrInstallments and Program. SIPOptions is optional.

Merchants located in Mexico must provide the NbrInstallemnts, InstallmentPlan, and GracePeriod only.

Merchants located in Canada using Visa Installment Service (VIS) must provide the Program and VISOptions.

All
Program programType Simple Type

The installment payments program type. This value is echoed from the request.

TermOptions optional TermOptionsType Simple Type

Term Options, only returned for the mIPP or SIP Programs.

The format is based by the Program.

VISEligiblePlans optional

This block provides information regarding eligible Visa Installment Service (VIS) installment plans, to be presented to the cardholder (EligiblePlans).

When the CardNbr and Amt are eligible, VIS returns 2 to n installment plans. Multiple plans are returned in the response.

When the CardNbr and Amt are not eligible, VIS returns a success response but EligiblePlans will be empty.

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator. This identifier is for use only by the payment facilitator, and should not be used as a reference in future client requests to the Portico Gateway.

PaymentFacilitatorTxnNbr optional xs:string

Unique account identifier assigned by the payment facilitator for the sub-merchant. This is used as the sub-merchant account reference if contacting the payment facilitator for support.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

This setting indicates if the Customer has decided Opt Out of currency conversion and have the amount remain in the Merchants currency. If the customer does not opt out, the amount will be converted to currency associated with the card.

RateLookupTxnId optional guidType Simple Type

The Retrieval Reference Number (RRN) of the RateLookup or Incremental Authorization that provided the rate used for the calculations in this transaction, if it is different from the original Authorization.

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

The mark up percentage applied to the transaction, resulting in the commission fee.

AccountReference optional xs:string

'Payment Account Reference' (PAR) data returned by issuer. PAR is 29-character alphanumeric reference number associated with each unique PAN and used by merchants to track transactions associated with customers PAN. Currently, PAR is only supported by Card Brand American Express.

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

Value returned by Visa in authorization responses for merchants participating in the Commercial Choice Program.

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 amtTypeGlobal Simple Type

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

Note: If not returned, the authorized amount is the requested amount.

AVSResultCodeAction optional resultCodeActionType Simple Type

AVS result action; this is a "suggestion" to the client based on the device's configuration during boarding and the AVS result received.

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

CVV result action; this is a "suggestion" to the client based on the device's configuration during boarding and the CVV result received.

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

The dynamic portion of this was provided in the header of the request; this is the final string sent to the issuer based on the provided value and the values configured during boarding

RecurringDataCode optional xs:string

MasterCard value that may be returned on recurring transactions. The only potential value on an approval is "01"; any of the other values may be returned on a decline.

Valid values include:

  • "01" (New account information available)
  • "02" (Cannot approve at this time, try again later)
  • "03" (Do not try again)
  • "04" (Declined due to lack of cryptography or partial shipment indicator)
  • "21" (Recurring Payment Cancellation Service)
  • "24" (Retry after 1 hour)
  • "25" (Retry after 24 hour)
  • "26" (Retry after 2 days)
  • "27" (Retry after 4 days)
  • "28" (Retry after 6 days)
  • "29" (Retry after 8 days)
  • "30" (Retry after 10 days)

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

The Visa Cardholder Authentication Verfication Value results code. This is returned by Visa when using SecureECommerce.

TokenPANLast4 optional xs:string

Last 4 digits of PAN associated with Token. This may be returned by issuer when using SecureECommerce.

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

A block of encrypted data to be sent from the POS on every contact Interac sale and return request. Required for Canadian merchants processing debit reversals.

HostRspDT optional xs:dateTime

Processing Host response date and time.

Note:For Canadian merchants, the HostRspDT contains the timestamp to be printed on the customer receipt.

CardBrandTxnId optional xs:string

This is the Network Transaction Identifier returned by the Card Brand.

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

The IPSelectedTermsRsp data block is included in a Credit response to provide the name of the issuer and/or the authorized terms. The data returned is dependent on the Program.

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

Information on the Installment Plan chosen by the customer. Usage varies by region and the Installments service provider:

Merchants located in the Asia Pacific region must provide the NbrInstallments and Program. SIPOptions is optional.

Merchants located in Mexico must provide the NbrInstallemnts, InstallmentPlan, and GracePeriod only.

Merchants located in Canada using Visa Installment Service (VIS) must provide the Program and VISOptions.

All
Program programType Simple Type

The installment payments program type. This value is echoed from the request.

TermOptions optional TermOptionsType Simple Type

Term Options, only returned for the mIPP or SIP Programs.

The format is based by the Program.

VISEligiblePlans optional

This block provides information regarding eligible Visa Installment Service (VIS) installment plans, to be presented to the cardholder (EligiblePlans).

When the CardNbr and Amt are eligible, VIS returns 2 to n installment plans. Multiple plans are returned in the response.

When the CardNbr and Amt are not eligible, VIS returns a success response but EligiblePlans will be empty.

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator. This identifier is for use only by the payment facilitator, and should not be used as a reference in future client requests to the Portico Gateway.

PaymentFacilitatorTxnNbr optional xs:string

Unique account identifier assigned by the payment facilitator for the sub-merchant. This is used as the sub-merchant account reference if contacting the payment facilitator for support.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

This setting indicates if the Customer has decided Opt Out of currency conversion and have the amount remain in the Merchants currency. If the customer does not opt out, the amount will be converted to currency associated with the card.

RateLookupTxnId optional guidType Simple Type

The Retrieval Reference Number (RRN) of the RateLookup or Incremental Authorization that provided the rate used for the calculations in this transaction, if it is different from the original Authorization.

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

The mark up percentage applied to the transaction, resulting in the commission fee.

AccountReference optional xs:string

'Payment Account Reference' (PAR) data returned by issuer. PAR is 29-character alphanumeric reference number associated with each unique PAN and used by merchants to track transactions associated with customers PAN. Currently, PAR is only supported by Card Brand American Express.

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

Value returned by Visa in authorization responses for merchants participating in the Commercial Choice Program.

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 amtTypeGlobal Simple Type

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

Note: If not returned, the authorized amount is the requested amount.

AVSResultCodeAction optional resultCodeActionType Simple Type

AVS result action; this is a "suggestion" to the client based on the device's configuration during boarding and the AVS result received.

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

CVV result action; this is a "suggestion" to the client based on the device's configuration during boarding and the CVV result received.

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

The dynamic portion of this was provided in the header of the request; this is the final string sent to the issuer based on the provided value and the values configured during boarding

RecurringDataCode optional xs:string

MasterCard value that may be returned on recurring transactions. The only potential value on an approval is "01"; any of the other values may be returned on a decline.

Valid values include:

  • "01" (New account information available)
  • "02" (Cannot approve at this time, try again later)
  • "03" (Do not try again)
  • "04" (Declined due to lack of cryptography or partial shipment indicator)
  • "21" (Recurring Payment Cancellation Service)
  • "24" (Retry after 1 hour)
  • "25" (Retry after 24 hour)
  • "26" (Retry after 2 days)
  • "27" (Retry after 4 days)
  • "28" (Retry after 6 days)
  • "29" (Retry after 8 days)
  • "30" (Retry after 10 days)

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

The Visa Cardholder Authentication Verfication Value results code. This is returned by Visa when using SecureECommerce.

TokenPANLast4 optional xs:string

Last 4 digits of PAN associated with Token. This may be returned by issuer when using SecureECommerce.

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

A block of encrypted data to be sent from the POS on every contact Interac sale and return request. Required for Canadian merchants processing debit reversals.

HostRspDT optional xs:dateTime

Processing Host response date and time.

Note:For Canadian merchants, the HostRspDT contains the timestamp to be printed on the customer receipt.

CardBrandTxnId optional xs:string

This is the Network Transaction Identifier returned by the Card Brand.

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

The IPSelectedTermsRsp data block is included in a Credit response to provide the name of the issuer and/or the authorized terms. The data returned is dependent on the Program.

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

Information on the Installment Plan chosen by the customer. Usage varies by region and the Installments service provider:

Merchants located in the Asia Pacific region must provide the NbrInstallments and Program. SIPOptions is optional.

Merchants located in Mexico must provide the NbrInstallemnts, InstallmentPlan, and GracePeriod only.

Merchants located in Canada using Visa Installment Service (VIS) must provide the Program and VISOptions.

All
Program programType Simple Type

The installment payments program type. This value is echoed from the request.

TermOptions optional TermOptionsType Simple Type

Term Options, only returned for the mIPP or SIP Programs.

The format is based by the Program.

VISEligiblePlans optional

This block provides information regarding eligible Visa Installment Service (VIS) installment plans, to be presented to the cardholder (EligiblePlans).

When the CardNbr and Amt are eligible, VIS returns 2 to n installment plans. Multiple plans are returned in the response.

When the CardNbr and Amt are not eligible, VIS returns a success response but EligiblePlans will be empty.

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator. This identifier is for use only by the payment facilitator, and should not be used as a reference in future client requests to the Portico Gateway.

PaymentFacilitatorTxnNbr optional xs:string

Unique account identifier assigned by the payment facilitator for the sub-merchant. This is used as the sub-merchant account reference if contacting the payment facilitator for support.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

This setting indicates if the Customer has decided Opt Out of currency conversion and have the amount remain in the Merchants currency. If the customer does not opt out, the amount will be converted to currency associated with the card.

RateLookupTxnId optional guidType Simple Type

The Retrieval Reference Number (RRN) of the RateLookup or Incremental Authorization that provided the rate used for the calculations in this transaction, if it is different from the original Authorization.

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

The mark up percentage applied to the transaction, resulting in the commission fee.

AccountReference optional xs:string

'Payment Account Reference' (PAR) data returned by issuer. PAR is 29-character alphanumeric reference number associated with each unique PAN and used by merchants to track transactions associated with customers PAN. Currently, PAR is only supported by Card Brand American Express.

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

Value returned by Visa in authorization responses for merchants participating in the Commercial Choice Program.

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 amtTypeGlobal Simple Type

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 amtTypeGlobal Simple Type

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

SettlementAmt amtTypeGlobal Simple Type

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 amtTypeGlobal Simple Type
CashbackAmtInfo amtTypeGlobal Simple Type
AuthAmt amtTypeGlobal Simple Type

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

SettlementAmt amtTypeGlobal Simple Type

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 amtTypeGlobal Simple Type
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 amtTypeGlobal Simple Type

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 amtTypeGlobal Simple Type
ShippingAmtInfo optional amtTypeGlobal Simple Type
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 amtTypeGlobal 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.

Integration must be through GP-API

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 amtTypeGlobal Simple Type

Sum of transaction amounts in the batch

TotalGratuityAmtInfo amtTypeGlobal Simple Type

Sum of gratuity amounts in the batch. Gratuity amounts, if any, are already included in the other amounts.

TotalSurchargeAmtInfo amtTypeGlobal Simple Type

Sum of surcharge amounts in the batch. Surcharge 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.

VisaDirectCnt xs:int

Number of Visa Direct transactions processed

VisaDirectAmt xs:decimal

Sum of Visa Direct transaction processed

MCSendCnt xs:int

Number of Mastercard Send transactions processed

MCSendAmt xs:decimal

Sum of Mastercard Send transaction processed

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 amtTypeGlobal Simple Type

Sum of transaction amounts in the batch

TotalGratuityAmtInfo amtTypeGlobal Simple Type

Sum of gratuity amounts in the batch. Gratuity amounts, if any, are already included in the other amounts.

TotalSurchargeAmtInfo amtTypeGlobal Simple Type

Sum of surcharge amounts in the batch. Surcharge amounts, if any, are already included in the other amounts.

TotalHCPCnt xs:int

Total number of Home Currency Pay transactions in the batch

VisaDirectCnt xs:int

Number of Visa Direct transactions processed

VisaDirectAmt xs:decimal

Sum of Visa Direct transaction processed

MCSendCnt xs:int

Number of Mastercard Send transactions processed

MCSendAmt xs:decimal

Sum of Mastercard Send transaction processed

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 amtTypeGlobal Simple Type

The original requested amount

AuthAmt amtTypeGlobal Simple Type

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

SettlementAmt amtTypeGlobal Simple Type

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 amtTypeGlobal Simple Type
CashbackAmtInfo amtTypeGlobal Simple Type
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 amtTypeGlobal Simple Type
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 amtTypeGlobal Simple Type

The original requested amount

AuthAmt amtTypeGlobal Simple Type

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

SettlementAmt amtTypeGlobal Simple Type

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 amtTypeGlobal Simple Type
GratuityAmtInfo amtTypeGlobal Simple Type
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 amtTypeGlobal Simple Type

The original requested amount

AuthAmt amtTypeGlobal Simple Type

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

GratuityAmtInfo amtTypeGlobal Simple Type
CashbackAmtInfo amtTypeGlobal Simple Type
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

AmountIndicator xs:string

Valid values include:

  • 'E' indicates that the transaction amount is an estimated amount
  • 'F' indicates the transaction amount is the final amount to be charged to the cardholder

DirectMktInvoiceNbr xs:string
DirectMktShipMonth xs:int
DirectMktShipDay xs:int
CPCCardHolderPONbr xs:string
CPCTaxType xs:string
CPCTaxAmt amtTypeGlobal Simple Type
SalesTaxDetails optional SalesTaxDetailsType Complex Type

Allows sending the Canadian sales tax details for corporate card processing.

SettlementAmt amtTypeGlobal Simple Type

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 LodgingDataForReportType Complex Type
ConvenienceAmtInfo optional amtTypeGlobal Simple Type
ShippingAmtInfo optional amtTypeGlobal Simple Type
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 amtTypeGlobal Simple Type
CashData optional CashDataType Complex Type

A collection of cash transaction related fields

ReturnAmtInfo optional amtTypeGlobal Simple Type

This is the total amount of returns that have been done against this specific transaction

ReversalAmtInfo optional amtTypeGlobal Simple Type

This is the total amount of reversals that have been done against this specific transaction

IncrementalAuthAmtInfo optional amtTypeGlobal Simple Type

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
ProcessedTxnMcc optional mccType Simple Type

The merchant category code (MCC)  used in the authorization request; if not provided the default MCC configured for the Device is assumed.

TransactionType xs:string

This is the OCT transaction type

RecipientCountry xs:string

This is the recipient country name

ServiceLocation optional ServiceLocationType Complex Type

The Service Location data received in the request.

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.

SDKNameVersion optional

Name and Version of the SDK used for integration, where applicable.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

This setting indicates if the Customer has decided Opt Out of currency conversion and have the amount remain in the Merchants currency. If the customer does not opt out, the amount will be converted to currency associated with the card.

RateLookupTxnId optional guidType Simple Type

The Retrieval Reference Number (RRN) of the RateLookup or Incremental Authorization that provided the rate used for the calculations in this transaction, if it is different from the original Authorization.

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

The mark up percentage applied to the transaction, resulting in the commission fee.

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

Available to merchants in Asia Pacific, Mexico, and Canada.

For merchants in Canada, use VIS.

Valid values include:

  • HSBCIPP
  • mIPP
  • SIP
  • VIS

SIPOptions optional sipOptionsType Simple Type

Available to merchants in Asia Pacific. Required when the Program is SIP

Valid values include:

  • 01 - SIPZERO
  • 02 - SIPREGULAR
  • 03 - SIPMADNESS

InstallmentPlan optional installmentPlanType Simple Type

Required for merchants in Mexico

Valid values include:

  • 00 - No promotion
  • 03 - Without interest to the cardholder
  • 05 - With interest to the cardholder
  • 07 - Buy today, pay later

GracePeriod optional gracePeriodType Simple Type

The grace period before the first payment. 00 indicates no grace period

Required for merchants in Mexico

NbrInstallments optional nbrInstallmentsType Simple Type

The total number of installments

This field is available to merchants in Asia Pacific and merchants in Mexico

PlanId optional planIdReqType Simple Type

The PlanId of the customer's selected VIS installment plan

Required when the Program is VIS

TermsConditionVersion optional termsConditionVersionReqType Simple Type

The Terms and Conditions version the customer's selected VIS installment plan

Required when the Program is VIS

TermsConditionLanguage optional termsConditionLanguageReqType Simple Type

The Language Code the customer's selected VIS installment plan

Required when the Program is VIS

IPData optional IPDataBlockType Complex Type

Information regarding Installment Plans associated with the transaction. Currently only returned for Visa Installment Service (VIS).

All
PlanId optional planIdReqType Simple Type

The reference ID of the VIS Installment Plan chosen by the customer.

EUSingleTap optional booleanType Simple Type

This field provides a way for a European merchant to indicate whether a transaction is a Single Tap contactless transaction, or whether the request contains an intentionally duplicated (replayed) ATC value. Applies to MC transactions only. Valid values: Y - SingleTap N - ReplayedATC

SCAExemptionData optional SCAExemptionDataType Complex Type

This fields provides a way for a European merchant to indicate that the transaction can take advantage of one of the exemptions to SCA. Applies to visa transactions only.

All
SCAExemptionType SCAExemptionTypeType Simple Type

Eligible exemption to Strong Customer authentication (SCA) for the transaction.

Valid values include:

  • 'TrustedMerchant' Trusted merchant exemption claimed/requested.
  • 'LowValue' Transaction exemption from SCA as the merchant has determined it to be a low value payment.
  • 'SecureCorporatePayment' Transaction exemption from SCA as the merchant has determined it as a SCP.
  • 'TxnRiskAnalysis' TRA exemption claimed/requested.
  • 'DelegatedAuth' Issuer has delegated SCA.
  • 'AuthenticationOutage' Authentication outage
  • 'MerchantInitiated' Merchant initiated
  • 'RecurringPayment' Recurring payment

Note: Visa Merchant ID is required when the SCA Exemption Type is Trusted Merchant or Delegated Authentication.

SCAVisaMerchantId optional Restriction of xs:string

Note: Visa Merchant ID for Trusted Merchant and Delegated Authentication exemptions, required when the SCA Exemption Type is Trusted Merchant or Delegated Authentication

ReportTxnResearch PosReportTxnResearchRspType Complex Type
Sequence
Transaction 0..∞
All
DS_GnapMacKey optional xs:string
DS_LastAutoClose optional xs:string
DS_BatchSequenceNbr optional xs:string
SE_EmailType optional xs:string
SE_EmailTo optional xs:string
SE_EmailSubject optional xs:string
TL_TxnId optional xs:string
TL_PartitionID optional xs:string
TL_SiteId optional xs:string
TL_DeviceId optional xs:string
TL_UserId optional xs:string
TL_ServiceId optional xs:string
TL_GatewayRspCode optional xs:string
TL_GatewayRspMsg optional xs:string
TL_ReqDcDateTime xs:dateTime
TL_ReqUtcDateTime xs:dateTime
TL_RspDcDateTime xs:dateTime
TL_RspUtcDateTime xs:dateTime
TL_SiteTrace optional xs:string
TL_OrigTxnId optional xs:string
TL_CreateDcDateTime optional xs:string
TL_UpdateDcDateTime optional xs:string
TL_AppSvr optional xs:string
TL_ClientIp optional xs:string
TL_ClerkId optional xs:string
TL_DeveloperId optional xs:string
TL_VersionNbr optional xs:string
TL_UniqueDeviceId optional xs:string
TL_AppVer optional xs:string
TL_ProcSvcId optional xs:string
TL_CreateUtcDateTime optional xs:string
TL_UpdateUtcDateTime optional xs:string
TRI_GlobalTxnId optional xs:string
TRI_ClientTxnId optional xs:string
TRI_AuthSiteId optional xs:string
TRI_AuthDeviceId optional xs:string
TRI_ProcSiteId optional xs:string
TRI_ProcDeviceId optional xs:string
TRI_CrossMidTidInd optional xs:string
TRI_GlobalTxnSource optional xs:string
AF_FailureReason optional xs:string
B_BatchId optional xs:string
B_BatchStatus optional xs:string
B_BatchSeqNbr optional xs:string
B_BatchOpenDcDateTime optional xs:string
B_BatchOpenUtcDateTime optional xs:string
B_BatchCloseDcDateTime optional xs:string
B_BatchCloseUtcDateTime optional xs:string
B_RetryCount optional xs:string
B_BatchCloseLastRetryDcDateTime optional xs:string
B_CreditCount optional xs:string
B_DebitCount optional xs:string
B_DebitAmount optional xs:string
B_TransactionCount optional xs:string
B_BatchCreateUtcDateTime optional xs:string
B_BatchUpdateUtcDateTime optional xs:string
BSDG_GSAPHostBatchNbr optional xs:string
BSDG_GSAPReqCreditPurchCnt optional xs:string
BSDG_GSAPReqCreditPurchAmt optional xs:string
BSDG_GSAPReqCreditReturnCnt optional xs:string
BSDG_GSAPReqCreditReturnAmt optional xs:string
BSDG_GSAPReqDebitPurchCnt optional xs:string
BSDG_GSAPReqDebitReturnCnt optional xs:string
BSDG_GSAPReqDebitReturnAmt optional xs:string
BSDG_GSAPReqNbrItems optional xs:string
BSDG_GSAPHostCreditPurchCnt optional xs:string
BSDG_GSAPHostCreditPurchAmt optional xs:string
BSDG_GSAPHostCreditReturnCnt optional xs:string
BSDG_GSAPHostCreditReturnAmt optional xs:string
BSDG_GSAPHostDebitPurchCnt optional xs:string
BSDG_GSAPHostDebitPurchAmt optional xs:string
BSDG_GSAPHostDebitReturnCnt optional xs:string
BSDG_GSAPHostDebitReturnAmt optional xs:string
BSDG_GSAPHostNbrItems optional xs:string
BSDG_GSAPForceCloseInd optional xs:string
BSDH_GSAPHostRspCode optional xs:string
BSDH_HostOutofBalanceInd optional xs:string
BSDH_HostProcessedBy optional xs:string
TD_PartitionId optional xs:string
TD_TxnStatus optional xs:string
TD_DebitCreditInd optional xs:string
TD_SaleReturnInd optional xs:string
TD_CardType optional xs:string
TD_AllowDupInd optional xs:string
TD_MaskedCardNbr optional xs:string
TD_ExpMonth optional xs:string
TD_ExpYear optional xs:string
TD_ReaderPresentInd optional xs:string
TD_CardSwipeInd optional xs:string
TD_CvvReqInd optional xs:string
TD_CvvRsltCode optional xs:string
TD_Amt optional xs:string
TD_AuthAmt optional xs:string
TD_GratuityAmt optional xs:string
TD_CashBackAmt optional xs:string
TD_CardHolderLastName optional xs:string
TD_CardHolderFirstName optional xs:string
TD_CardHolderAddr optional xs:string
TD_CardHolderCity optional xs:string
TD_CardHolderState optional xs:string
TD_CardHolderPhone optional xs:string
TD_CardHolderEmail optional xs:string
TD_CardHolderZip optional xs:string
TD_AvsRsltCode optional xs:string
TD_CPCReq optional xs:string
TD_CPCInd optional xs:string
TD_RspCode optional xs:string
TD_Rsptext optional xs:string
TD_AuthCode optional xs:string
TD_ReqACI optional xs:string
TD_RspACI optional xs:string
TD_MktSpecificId optional xs:string
TD_TxnCode optional xs:string
TD_AccountDataSrc optional xs:string
TD_AuthSrcCode optional xs:string
TD_IssTxnId optional xs:string
TD_CardholderIdCode optional xs:string
TD_RefNbr optional xs:string
TD_TxnSeqNbr optional xs:string
TD_ShipDateMonth optional xs:string
TD_ShipDateDay optional xs:string
TD_CryptoType optional xs:string
TD_ECommerceInd optional xs:string
TD_FolioNbr optional xs:string
TD_CheckInDateTime optional xs:string
TD_CheckOutDateTime optional xs:string
TD_NoShowInd optional xs:string
TD_ExtraCharges optional xs:string
TD_RoomRate optional xs:string
TD_RoomDuration optional xs:string
TD_LocalTxnDate optional xs:string
TD_LocalTxnTime optional xs:string
TD_AmexChargeType optional xs:string
TD_IncrementalAuthAmt optional xs:string
TD_AdditionalChargeAmt optional xs:string
TD_ReversalInd optional xs:string
TD_AllowPartialAuthInd optional xs:string
TD_SettlementAmt optional xs:string
TD_ReversalAmt optional xs:string
TD_CryptoTypeOut optional xs:string
TD_Description optional xs:string
TD_InvoiceNbr optional xs:string
TD_CustomerId optional xs:string
TD_ReturnAmt optional xs:string
TD_TokenRequestInd optional xs:string
TD_TokenGeneratedInd optional xs:string
TD_CryptoTypeIn optional xs:string
TD_ConvenienceAmt optional xs:string
TD_ShippingAmt optional xs:string
TD_TxnDescrtiptor optional xs:string
TD_OneTimeInd optional xs:string
TD_TaxAmt optional xs:string
TD_Currency optional xs:string
TD_SurchargeAmt optional xs:string
TD_ScheduleId optional xs:string
TD_PaymentMethodKey optional xs:string
TD_RecurringDataCode optional xs:string
TD_ICCChopCondition optional xs:string
TD_ICCTagData optional xs:string
TD_OrigRspCode optional xs:string
TD_OrigRspText optional xs:string
TD_EComPaymentType optional xs:string
TD_EComECI optional xs:string
TD_CavvRsltCode optional xs:string
TD_TokenPANLastFour optional xs:string
TD_EComPaymentSource optional xs:string
TDA_ReqProcCode optional xs:string
TDA_RspProcCode optional xs:string
TDA_ActionCode optional xs:string
TDA_AcqRefData optional xs:string
TDA_TxnNbr optional xs:string
TDA_ReasonCode optional xs:string
TDA_AccountType optional xs:string
TDA_PosEntryMode optional xs:string
TDA_HostBatchNbr optional xs:string
TDA_MarketData optional xs:string
TDA_HostAvsRsltCode optional xs:string
TDA_HostCvvRsltCode optional xs:string
TDA_HostCavvRsltCode optional xs:string
TDA_RspVerbiage optional xs:string
TDA_CardHolderLang optional xs:string
TDI_InteracTxnCode optional xs:string
TDI_IInteracRspCode optional xs:string
TDRQ_ITerminalAttributesUsed optional xs:string
TDRQ_ITerminalAttributes optional xs:string
TDRQ_ITerminalCapabilities optional xs:string
TDRQ_IAdditionalPosData optional xs:string
TDRQ_IPosConditionCode optional xs:string
TDRQ_ISAFInd optional xs:string
TDRQ_ISAFOrigDateTime optional xs:string
TDRQ_IProcessedBy optional xs:string
TDRQ_IBillPayInd optional xs:string
TDRQ_IFormat optional xs:string
TDRQ_IPedSerialNbr optional xs:string
TDRQ_IAmountInd optional xs:string
TDRQ_IAccountRefReq optional xs:string
TDRQCOF_CofInd optional xs:string
TDRQCOF_CofBrandTxnId optional xs:string
TDRP_ReturnedCardBrandTxnId optional xs:string
TDRP_ReturnedHostRspCode optional xs:string
TDRP_ReturnedHostRspText optional xs:string
TDRP_ReturnedAcqRefData optional xs:string
TDRP_ReturnedAvsRsltCode optional xs:string
TDRP_ReturnedCvvRsltCode optional xs:string
TDRP_ReturnedSecurityProtocol optional xs:string
TDRP_ReturnedCardHolderAuth optional xs:string
TDRP_ReturnedUCAFInd optional xs:string
TDRP_ReturnedApprovalAmtType optional xs:string
TDRP_ReturnedDeclineCatCode optional xs:string
TDRP_ReturnedAccountReference optional xs:string
TDCPCV_VisaCommodityCode optional xs:string
TDCPCV_VisaDiscountAmt optional xs:string
TDCPCV_VisaFreightAmt optional xs:string
TDCPCV_VisaDutyAmt optional xs:string
TDCPCV_VisaDestinationPostalCode optional xs:string
TDCPCV_VisaShipFromPostalCode optional xs:string
TDCPCV_VisaDestinationCountry optional xs:string
TDCPCV_VisaInvoiceRefNbr optional xs:string
TDCPCV_VisaOrderDate optional xs:string
TDCPCV_VisaVATFreightAmt optional xs:string
TDCPCV_VisaVATFreightRate optional xs:string
TDCPCV_VisaDiscountTreatment optional xs:string
TDCPCV_VisaTaxTreatment optional xs:string
TDCCRQ_DCCOptOutInd optional xs:string
TDCCRQ_DCCCardHolderCurrency optional xs:string
TDCCRQ_DCCCardholderAmt optional xs:string
TDCCRQ_DCCRateLookupId optional xs:string
TDCCRQ_DCCExchangeRate optional xs:string
TDCCRQ_DCCMarkupFee optional xs:string
TDPFRQ_PayFacAccountSource optional xs:string
TDPFRQ_PayFacCardholderIdentity optional xs:string
TDPFRQ_PayFacCPSMeritInd optional xs:string
TDPFRQ_PayFacMarketDataIdentifier optional xs:string
TDPFRQ_PayFacMotoEcomInd optional xs:string
TDPFRP_PayFacTxnId optional xs:string
TDPFRP_PayFacTxnNbr optional xs:string
TDPFRP_PayFacTxnType optional xs:string
TDPFRP_PayFacTxnStatus optional xs:string
TDRS_Secure3DVer optional xs:string
TDRS_Secure3DECI optional xs:string
TDRS_Secure3DServerTxnId optional xs:string
TDRS_Secure3DEncodeType optional xs:string
TDRS_Secure3DPaymentSource optional xs:string
TDRS_Secure3DWalletECI optional xs:string
TDRS_Secure3DDecryptSource optional xs:string
TDSM_PayFacSubMerchId optional xs:string
TDSM_PayFacSubMerchTermId optional xs:string
TDSM_PayFacSubMerchMcc optional xs:string
TDIPRQ_IPProgram optional xs:string
TDIPRQ_IPNbrInstallments optional xs:string
TDIPRQ_SIPOptionsReq optional xs:string
TDIPRQ_InstallmentPlan optional xs:string
TDIPRQ_IPGracePeriod optional xs:string
TDIPRP_IPTerms optional xs:string
TDIPRP_IPIssuerName optional xs:string
TDIPRP_SIPOptionsRsp optional xs:string
TDVIS_VISPlanConfId optional xs:string
TDVIS_VISPlanAcquirer optional xs:string
TDVIS_VISPlanId optional xs:string
TDVISL_VISPlanFunction optional xs:string
TDVISL_VISRspCode optional xs:string
TDVISL_VISRspText optional xs:string
TDVISL_VISCreateUtcDateTime optional xs:string
TDVISL_VISUpdateUtcDateTime optional xs:string
Environment optional xs:string
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

SendFunds AuthRspStatusType Complex Type
All
RspCode xs:string

Response (result) code returned by the issuer

RspText optional xs:string

Response (result) text returned by the issuer

AuthCode optional xs:string

If authorized, authorization code returned by the issuer

AVSRsltCode optional xs:string

If address verification requested, address verification result code returned by the issuer

CVVRsltCode optional xs:string

If card verification was provided on the request, card verification result code returned by the issuer

CPCInd optional xs:string

If commercial card was specified in the request, commercial card response indicator returned by the issuer.

Valid values include:

  • B (Business Card)
  • R (Corporate Card)
  • S (Purchasing Card)
  • L (B2B - Settlement amount may not exceed Authorized amount)

Note: If this is returned with one of these values, the client should obtain additional information from the card holder and provide it to the gateway via a CreditCPCEdit before this transaction is closed.

RefNbr optional xs:string

Reference number returned by the processor or issuer

AvailableBalance optional amtTypeGlobal Simple Type

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

Note: If not returned, the authorized amount is the requested amount.

AVSResultCodeAction optional resultCodeActionType Simple Type

AVS result action; this is a "suggestion" to the client based on the device's configuration during boarding and the AVS result received.

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

CVV result action; this is a "suggestion" to the client based on the device's configuration during boarding and the CVV result received.

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

The dynamic portion of this was provided in the header of the request; this is the final string sent to the issuer based on the provided value and the values configured during boarding

RecurringDataCode optional xs:string

MasterCard value that may be returned on recurring transactions. The only potential value on an approval is "01"; any of the other values may be returned on a decline.

Valid values include:

  • "01" (New account information available)
  • "02" (Cannot approve at this time, try again later)
  • "03" (Do not try again)
  • "04" (Declined due to lack of cryptography or partial shipment indicator)
  • "21" (Recurring Payment Cancellation Service)
  • "24" (Retry after 1 hour)
  • "25" (Retry after 24 hour)
  • "26" (Retry after 2 days)
  • "27" (Retry after 4 days)
  • "28" (Retry after 6 days)
  • "29" (Retry after 8 days)
  • "30" (Retry after 10 days)

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

The Visa Cardholder Authentication Verfication Value results code. This is returned by Visa when using SecureECommerce.

TokenPANLast4 optional xs:string

Last 4 digits of PAN associated with Token. This may be returned by issuer when using SecureECommerce.

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

A block of encrypted data to be sent from the POS on every contact Interac sale and return request. Required for Canadian merchants processing debit reversals.

HostRspDT optional xs:dateTime

Processing Host response date and time.

Note:For Canadian merchants, the HostRspDT contains the timestamp to be printed on the customer receipt.

CardBrandTxnId optional xs:string

This is the Network Transaction Identifier returned by the Card Brand.

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

The IPSelectedTermsRsp data block is included in a Credit response to provide the name of the issuer and/or the authorized terms. The data returned is dependent on the Program.

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

Information on the Installment Plan chosen by the customer. Usage varies by region and the Installments service provider:

Merchants located in the Asia Pacific region must provide the NbrInstallments and Program. SIPOptions is optional.

Merchants located in Mexico must provide the NbrInstallemnts, InstallmentPlan, and GracePeriod only.

Merchants located in Canada using Visa Installment Service (VIS) must provide the Program and VISOptions.

All
Program programType Simple Type

The installment payments program type. This value is echoed from the request.

TermOptions optional TermOptionsType Simple Type

Term Options, only returned for the mIPP or SIP Programs.

The format is based by the Program.

VISEligiblePlans optional

This block provides information regarding eligible Visa Installment Service (VIS) installment plans, to be presented to the cardholder (EligiblePlans).

When the CardNbr and Amt are eligible, VIS returns 2 to n installment plans. Multiple plans are returned in the response.

When the CardNbr and Amt are not eligible, VIS returns a success response but EligiblePlans will be empty.

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator. This identifier is for use only by the payment facilitator, and should not be used as a reference in future client requests to the Portico Gateway.

PaymentFacilitatorTxnNbr optional xs:string

Unique account identifier assigned by the payment facilitator for the sub-merchant. This is used as the sub-merchant account reference if contacting the payment facilitator for support.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

This setting indicates if the Customer has decided Opt Out of currency conversion and have the amount remain in the Merchants currency. If the customer does not opt out, the amount will be converted to currency associated with the card.

RateLookupTxnId optional guidType Simple Type

The Retrieval Reference Number (RRN) of the RateLookup or Incremental Authorization that provided the rate used for the calculations in this transaction, if it is different from the original Authorization.

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

The mark up percentage applied to the transaction, resulting in the commission fee.

AccountReference optional xs:string

'Payment Account Reference' (PAR) data returned by issuer. PAR is 29-character alphanumeric reference number associated with each unique PAN and used by merchants to track transactions associated with customers PAN. Currently, PAR is only supported by Card Brand American Express.

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

Value returned by Visa in authorization responses for merchants participating in the Commercial Choice Program.

SendReceipt
TokenUpdaterHistory PosTokenUpdaterHistoryRspType Complex Type
All
ReportStartDate xs:dateTime

Start of the reporting date

ReportEndDate xs:string

End of the reporting date

Offset optional xs:int

Records to be returned limit

Limit optional xs:int

Records to be returned limit

TotalMatchingRecords xs:int

Total number of records returned

CountUpdateCardNumber optional xs:int

Count of card numbers updated

CountUpdateExpirationDate optional xs:int

Count of expiration dates updated

CountAccountsClosed optional xs:int

Count of accounts closed

CountContactCardholder optional xs:int

Count of contact cardholder

Results

Array of return records

Sequence
TokenDetails 0..∞ TokenUpdaterHistoryResultType Complex Type

Contains detailed information about an update that was performed

SurchargeEligibilityLookup PosSurchargeEligibilityLookupRspType Complex Type
All
IsSurchargeable booleanType Simple Type

Indicates if the card data provided is surchargeable

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
BNPLCreateOrder AuthRspStatusType Complex Type
All
RspCode xs:string

Response (result) code returned by the issuer

RspText optional xs:string

Response (result) text returned by the issuer

AuthCode optional xs:string

If authorized, authorization code returned by the issuer

AVSRsltCode optional xs:string

If address verification requested, address verification result code returned by the issuer

CVVRsltCode optional xs:string

If card verification was provided on the request, card verification result code returned by the issuer

CPCInd optional xs:string

If commercial card was specified in the request, commercial card response indicator returned by the issuer.

Valid values include:

  • B (Business Card)
  • R (Corporate Card)
  • S (Purchasing Card)
  • L (B2B - Settlement amount may not exceed Authorized amount)

Note: If this is returned with one of these values, the client should obtain additional information from the card holder and provide it to the gateway via a CreditCPCEdit before this transaction is closed.

RefNbr optional xs:string

Reference number returned by the processor or issuer

AvailableBalance optional amtTypeGlobal Simple Type

The available balance on the associated account

AuthAmt optional amtTypeGlobal Simple Type

Actual amount authorized; could differ from requested for partial authorizations

Note: If not returned, the authorized amount is the requested amount.

AVSResultCodeAction optional resultCodeActionType Simple Type

AVS result action; this is a "suggestion" to the client based on the device's configuration during boarding and the AVS result received.

See enumerations for specific values supported.

CVVResultCodeAction optional resultCodeActionType Simple Type

CVV result action; this is a "suggestion" to the client based on the device's configuration during boarding and the CVV result received.

See enumerations for specific values supported.

CardType optional xs:string

The card type processed based on configured BIN ranges

AVSRsltText optional xs:string

Address verification result description returned by the issuer

CVVRsltText optional xs:string

Card verification result description returned by the issuer

TxnDescriptor optional xs:string

The dynamic portion of this was provided in the header of the request; this is the final string sent to the issuer based on the provided value and the values configured during boarding

RecurringDataCode optional xs:string

MasterCard value that may be returned on recurring transactions. The only potential value on an approval is "01"; any of the other values may be returned on a decline.

Valid values include:

  • "01" (New account information available)
  • "02" (Cannot approve at this time, try again later)
  • "03" (Do not try again)
  • "04" (Declined due to lack of cryptography or partial shipment indicator)
  • "21" (Recurring Payment Cancellation Service)
  • "24" (Retry after 1 hour)
  • "25" (Retry after 24 hour)
  • "26" (Retry after 2 days)
  • "27" (Retry after 4 days)
  • "28" (Retry after 6 days)
  • "29" (Retry after 8 days)
  • "30" (Retry after 10 days)

EMVIssuerResp optional emvTagDataType Simple Type

EMV tag data in TLV format returned by the issuer

CAVVResultCode optional xs:string

The Visa Cardholder Authentication Verfication Value results code. This is returned by Visa when using SecureECommerce.

TokenPANLast4 optional xs:string

Last 4 digits of PAN associated with Token. This may be returned by issuer when using SecureECommerce.

DebitMac optional DebitMacRspType Complex Type

A group of optional fields that are related to Message Authentication

All
TransactionCode optional xs:string

Code that indicates type of transaction on the host.

TransmissionNumber optional xs:string

Used for MACing and receipt on the host.

BankResponseCode optional xs:string

Used for MACing and receipt on the host.

MacKey optional xs:string

Current working key.

PinKey optional xs:string

Current working key.

FieldKey optional xs:string

Used to decrypt field information.

TraceNumber optional xs:string

Number identifying original transaction.

MessageAuthenticationCode optional xs:string

A block of encrypted data to be sent from the POS on every contact Interac sale and return request. Required for Canadian merchants processing debit reversals.

HostRspDT optional xs:dateTime

Processing Host response date and time.

Note:For Canadian merchants, the HostRspDT contains the timestamp to be printed on the customer receipt.

CardBrandTxnId optional xs:string

This is the Network Transaction Identifier returned by the Card Brand.

IpSelectedTermsRsp optional IPSelectedTermsRspType Complex Type

The IPSelectedTermsRsp data block is included in a Credit response to provide the name of the issuer and/or the authorized terms. The data returned is dependent on the Program.

All
IssuerName optional xs:string

Issuer Name

AuthorizedTerms optional xs:string

Authorized Terms

IpTerms optional IPTermsRspDataType Complex Type

Information on the Installment Plan chosen by the customer. Usage varies by region and the Installments service provider:

Merchants located in the Asia Pacific region must provide the NbrInstallments and Program. SIPOptions is optional.

Merchants located in Mexico must provide the NbrInstallemnts, InstallmentPlan, and GracePeriod only.

Merchants located in Canada using Visa Installment Service (VIS) must provide the Program and VISOptions.

All
Program programType Simple Type

The installment payments program type. This value is echoed from the request.

TermOptions optional TermOptionsType Simple Type

Term Options, only returned for the mIPP or SIP Programs.

The format is based by the Program.

VISEligiblePlans optional

This block provides information regarding eligible Visa Installment Service (VIS) installment plans, to be presented to the cardholder (EligiblePlans).

When the CardNbr and Amt are eligible, VIS returns 2 to n installment plans. Multiple plans are returned in the response.

When the CardNbr and Amt are not eligible, VIS returns a success response but EligiblePlans will be empty.

PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator. This identifier is for use only by the payment facilitator, and should not be used as a reference in future client requests to the Portico Gateway.

PaymentFacilitatorTxnNbr optional xs:string

Unique account identifier assigned by the payment facilitator for the sub-merchant. This is used as the sub-merchant account reference if contacting the payment facilitator for support.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

This setting indicates if the Customer has decided Opt Out of currency conversion and have the amount remain in the Merchants currency. If the customer does not opt out, the amount will be converted to currency associated with the card.

RateLookupTxnId optional guidType Simple Type

The Retrieval Reference Number (RRN) of the RateLookup or Incremental Authorization that provided the rate used for the calculations in this transaction, if it is different from the original Authorization.

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

The mark up percentage applied to the transaction, resulting in the commission fee.

AccountReference optional xs:string

'Payment Account Reference' (PAR) data returned by issuer. PAR is 29-character alphanumeric reference number associated with each unique PAN and used by merchants to track transactions associated with customers PAN. Currently, PAR is only supported by Card Brand American Express.

Note: Account Reference is supported only for HOST Exchange.

BnplId optional xs:string

Id received from the BNPL Provider

RedirectUrl optional xs:string

Redirect url for the provider

HostIssRspCode optional hostIssRspCode Simple Type

Internal Use Only

AgreementId optional xs:string

Value returned by Visa in authorization responses for merchants participating in the Commercial Choice Program.

NTRSCreateToken NTRSCreateTokenRspStatusType Complex Type
All
NTRSTokenId xs:string

The ID of the token.

NTRSToken Restriction of xs:string

The token itself.

NTRSExpirationDate Restriction of xs:int

The expiry date of the real PAN. The format is 'YYMM'.

NTRSTokenStatus Restriction of xs:string

The current state of the token. Allowed values: INACTIVE, ACTIVE, SUSPENDED, DELETED.

CardBrandTxnId Restriction of xs:long

The TRID assigned by the card brand.

AccountReference Restriction of xs:string

Globally unique reference of a cardholder’s PAN.

PaymentInstrument PaymentInstrumentRspType Complex Type
All
PanSuffix Restriction of xs:int

The last four digits of the real PAN.

CardScheme Restriction of xs:string

The brand of the card.

CardAlias Restriction of xs:string

The name of the card.

BankIdentificationNumber Restriction of xs:long

The first six digits of the real PAN.

CardMetadata CardMetadataRspType Complex Type
All
TermsAndConditionsId Restriction of xs:string

Unique identifier (GUID format) of the terms and conditions.

TermsAndConditionsUrl Restriction of xs:string

The website URL which is used to describe the terms and conditions.

CardArtUrl Restriction of xs:string

Website URL to see the card art.

CardBackgroundColor Restriction of xs:string

The background color of the card.

CardForegroundColor Restriction of xs:string

The foreground color of the card.

LabelColor Restriction of xs:string

The detailed description of the card product to be displayed inside the mobile wallet.

LongDescription Restriction of xs:string

The detailed description of the card product to be displayed inside the mobile wallet.

ShortDescription Restriction of xs:string

The short description of the card product to be used for notification on the mobile device.

NTRSIssuerName Restriction of xs:string

The name of the card issuer.

IssuerAppData IssuerAppDataDataType Complex Type

The name of the card issuer.

CardAssets

Array of the card issuer.

NTRSCardData NTRSCardDataRspType Complex Type
All
PanReferenceId Restriction of xs:string

The unique reference ID (GUID format) of the real PAN.

CardSuffix Restriction of xs:int

The last four digits of the real PAN.

PanExpDate Restriction of xs:int

The expiry date of the real PAN. The format is 'YYMM'.

CardholderEmbossedName Restriction of xs:string

The embossed name on the physical card.

CardCountryCode Restriction of xs:string

A 2 character country code.

CardName Restriction of xs:string

The name of the card.

NTRSCardType Restriction of xs:string

The type of the card product. Allowed values: CREDIT, DEBIT, PREPAID, UNKNOWN

CardBrand Restriction of xs:string

The brand of the card.

CardLongDescription Restriction of xs:string

The long description of the card.

CardShortDescription Restriction of xs:string

The short description of the card.

CoBranded Restriction of xs:boolean

It indicates if the card is a co-branded card.

CoBrandName Restriction of xs:string

The card co-brand name.

CardTypeIndicator Restriction of xs:string

Indication if the token requestor supports debit cards, credit cards or both.

ExpDataPrinted Restriction of xs:boolean

It indicates if the expiration date is printed on the card or not.

Cvv2Printed Restriction of xs:boolean

It indicates if the cvv2 is printed on the card or not.

NTRSGetTokenCryptogram NTRSGetTokenCryptogramRspStatusType Complex Type
All
NTRSToken Restriction of xs:string

The token itself.

NTRSCryptogram Restriction of xs:string

The cryptogram for the transaction. base64 characters.

NTRSCryptogramType Restriction of xs:string

The type of the cryptogram. Allowed values: TAVV, UCAF, DCSC, CRYPTOGRAM_TYPE_NOT_AVAILABLE.

NTRSECI Restriction of xs:string

EC indicator for liability shift (only for Visa).

NTRSTokenExpirationDate Restriction of xs:int

The expiration date of the token. Format YYMM.

CardBrandTxnId Restriction of xs:long

The TRID assigned by the card brand.

NTRSTokenStatus NTRSTokenStatusRspStatusType Complex Type
All
NTRSTokenId xs:string

The ID of the token that status is being requested for.

NTRSTokenStatus Restriction of xs:string

The current state of the token. Allowed values: INACTIVE, ACTIVE, SUSPENDED, DELETED.

NTRSTokenLastModified Restriction of xs:dateTime

The current state of the token. Allowed values: INACTIVE, ACTIVE, SUSPENDED, DELETED.

NTRSUpdateTokenStatus NTRSTokenStatusRspStatusType Complex Type
All
NTRSTokenId xs:string

The ID of the token that status is being requested for.

NTRSTokenStatus Restriction of xs:string

The current state of the token. Allowed values: INACTIVE, ACTIVE, SUSPENDED, DELETED.

NTRSTokenLastModified Restriction of xs:dateTime

The current state of the token. Allowed values: INACTIVE, ACTIVE, SUSPENDED, DELETED.

NTRSTokenMetadata NTRSTokenMetadataRspStatusType Complex Type
All
NTRSTokenId xs:string

The ID of the token that status is being requested for.

CardBrandTxnId Restriction of xs:long

The TRID assigned by the card brand.

AccountReference Restriction of xs:string

Globally unique reference of a cardholder’s PAN.

CardMetadata CardMetadataRspType Complex Type
All
TermsAndConditionsId Restriction of xs:string

Unique identifier (GUID format) of the terms and conditions.

TermsAndConditionsUrl Restriction of xs:string

The website URL which is used to describe the terms and conditions.

CardArtUrl Restriction of xs:string

Website URL to see the card art.

CardBackgroundColor Restriction of xs:string

The background color of the card.

CardForegroundColor Restriction of xs:string

The foreground color of the card.

LabelColor Restriction of xs:string

The detailed description of the card product to be displayed inside the mobile wallet.

LongDescription Restriction of xs:string

The detailed description of the card product to be displayed inside the mobile wallet.

ShortDescription Restriction of xs:string

The short description of the card product to be used for notification on the mobile device.

NTRSIssuerName Restriction of xs:string

The name of the card issuer.

IssuerAppData IssuerAppDataDataType Complex Type

The name of the card issuer.

CardAssets

Array of the card issuer.

NTRSTokenMetadata NTRSTokenMetadataRspType Complex Type
All
NTRSTokenSuffix Restriction of xs:long

The last four digits of the network token.

NTRSTokenExpDate Restriction of xs:long

The expiration date of the network token.

NTRSPanData NTRSPanDataRspType Complex Type
All
NTRSPanReferenceId Restriction of xs:string

The unique reference ID (GUID format) of the real PAN.

NTRSPan Restriction of xs:long

The real Primary Account Number (PAN).

NTRSPanExpDate Restriction of xs:int

The expiry date of the real PAN. The format is 'YYMM'.

NTRSPanCvv Restriction of xs:int

The security code embedded on the back of the physical credit or debit card.

NTRSCardData NTRSCardDataRspType Complex Type
All
PanReferenceId Restriction of xs:string

The unique reference ID (GUID format) of the real PAN.

CardSuffix Restriction of xs:int

The last four digits of the real PAN.

PanExpDate Restriction of xs:int

The expiry date of the real PAN. The format is 'YYMM'.

CardholderEmbossedName Restriction of xs:string

The embossed name on the physical card.

CardCountryCode Restriction of xs:string

A 2 character country code.

CardName Restriction of xs:string

The name of the card.

NTRSCardType Restriction of xs:string

The type of the card product. Allowed values: CREDIT, DEBIT, PREPAID, UNKNOWN

CardBrand Restriction of xs:string

The brand of the card.

CardLongDescription Restriction of xs:string

The long description of the card.

CardShortDescription Restriction of xs:string

The short description of the card.

CoBranded Restriction of xs:boolean

It indicates if the card is a co-branded card.

CoBrandName Restriction of xs:string

The card co-brand name.

CardTypeIndicator Restriction of xs:string

Indication if the token requestor supports debit cards, credit cards or both.

ExpDataPrinted Restriction of xs:boolean

It indicates if the expiration date is printed on the card or not.

Cvv2Printed Restriction of xs:boolean

It indicates if the cvv2 is printed on the card or not.

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="ReportTxnResearch" type="PosReportTxnResearchRspType" />
      <xs:element name="RewardCashQuery" type="PosRewardCashQueryRspType" />
      <xs:element name="RewardCashRedeem" type="PosRewardCashRedeemRspType" />
      <xs:element name="SendFunds" type="AuthRspStatusType" />
      <xs:element name="SendReceipt" />
      <xs:element name="TokenUpdaterHistory" type="PosTokenUpdaterHistoryRspType" />
      <xs:element name="SurchargeEligibilityLookup" type="PosSurchargeEligibilityLookupRspType" />
      <xs:element name="TestCredentials" type="xs:anySimpleType" />
      <xs:element name="InteracDeviceKeys" type="PosInteracDeviceKeysRspType" />
      <xs:element name="BNPLCreateOrder" type="AuthRspStatusType" />
      <xs:element name="NTRSCreateToken" type="NTRSCreateTokenRspStatusType" />
      <xs:element name="NTRSGetTokenCryptogram" type="NTRSGetTokenCryptogramRspStatusType" />
      <xs:element name="NTRSTokenStatus" type="NTRSTokenStatusRspStatusType" />
      <xs:element name="NTRSUpdateTokenStatus" type="NTRSTokenStatusRspStatusType" />
      <xs:element name="NTRSTokenMetadata" type="NTRSTokenMetadataRspStatusType" />
    </xs:choice>
  </xs:complexType>
</xs:element>
See Also
Ver1.0 Element | PosResponse Element | PosGateway Schema

 

 

© 2024 Heartland Payment Systems, Inc.