Ver1.0 Element

GatewayTxnId txnIdType Simple Type

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

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

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

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

All

LicenseId optional licenseIdType Simple Type

Echoed from request

SiteId optional siteIdType Simple Type

Echoed from request

DeviceId optional deviceIdType Simple Type

Echoed from request

SiteTrace optional siteTraceType Simple Type

Echoed from request

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

GatewayRspCode gatewayRspCodeType Simple Type

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

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

GatewayRspMsg optional gatewayRspMsgType Simple Type

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

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

RspDT optional xs:dateTime

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

TokenData optional TokenDataRspType Complex Type

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

All

TokenRspCode optional xs:int

Response code specific to the tokenization process; the processing of the request will not be impacted by tokenization failures in most cases.

TokenRspMsg optional xs:string

Response message specific to the tokenization process that may provide additional information to the client or user

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

TokenValue optional xs:string

The generated (or echoed) multi-use token; this can be used by the client on subsequent calls in the card data element.

AdditionalDuplicateData optional AdditionalDuplicateDataType Complex Type

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

All

OriginalGatewayTxnId txnIdType Simple Type

Contains the original Gateway Transaction ID.

OriginalRspDT xs:dateTime

Contains the original transaction response date and time in the time zone stored for the associated site.

OriginalClientTxnId clientIdType Simple Type

Contains the original client transaction ID.

OriginalUniqueDeviceId uniqueDeviceIdType Simple Type

Contains the original unique device ID.

Originalx_global_transaction_id x_global_transaction_idType Simple Type

Contains the original Global transaction ID.

OriginalAuthCode xs:string

Contains the original authorization code.

OriginalRefNbr xs:string

Contains the original reference number.

OriginalAuthAmt xs:decimal

Contains the original authorized amount.

OriginalCardType xs:string

Contains the original card type.

OriginalCardNbrLast4 xs:string

Contains the original last four digits of the account number used on the original transaction.

ClientTxnId optional clientIdType Simple Type

Echoed from request

UniqueDeviceId optional xs:string

Echoed from request

BatchId optional batchIdType Simple Type

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

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

BatchSeqNbr optional xs:int

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

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

PDLNotification optional booleanType Simple Type

Indicates a parameter download is available

x_global_transaction_id optional x_global_transaction_idType Simple Type

Echoed from request

x_global_transaction_source optional x_global_transaction_sourceType Simple Type

Echoed from request

CustomHash optional xs:string

Fingerprint value for customer-specific usage.

BatchItemNbr optional xs:int

FOR INTERNAL USE ONLY

MerchCurrencyCode optional xs:string

Indicates the 3-digit currency code of the merchant.

MerchCurrencyText optional xs:string

Indicates the 3-digit currency acronym of the merchant

RetryInd optional booleanType Simple Type

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

The time alloted for retries is 90 minutes.

Note: It is internal only

Transaction optional

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

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

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

Choice

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

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

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

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

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

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

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

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

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

Payment optional

Payment Information for the Session

LineItem optional

Line Item purchase information for the session

Processor optional

Additional processor response information

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

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.

CheckRspInfo 0..∞ CheckRspInfoType Complex Type

Additional response information that can vary by check processor

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

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

CheckRspInfo 0..∞ CheckRspInfoType Complex Type

Additional response information that can vary by check processor

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditAddToBatch AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditAuth AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditAdditionalAuth AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditCapture AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditCPCEdit AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditIncrementalAuth AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditIPQuery AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditOfflineSale AuthRspStatusType Complex 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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditReturn AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditReversal AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditSale AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditTxnEdit AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

CreditVoid AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

DebitAddValue AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

DebitBalanceInquiry AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

DebitReturn AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

DebitReversal AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

DebitAddToBatch AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

DebitAuth AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

DebitSale AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

EBTBalanceInquiry AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

EBTCashBackPurchase AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

EBTCashBenefitWithdrawal AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

EBTFSPurchase AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

EBTFSReturn AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

EBTFSReversal AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

EBTVoucherPurchase AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

FindTransactions FindTransactionsRspType Complex Type

Internal Use Only

AgreementId optional xs:string

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

EndToEndTest

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.

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

GetTransactionStatus PosGetTransactionStatusRspType Complex Type

All

TransactionStatus optional

TzConversion optional tzoneConversionType Simple Type

Time zone conversion applied to returned dates

GetUserSettings PosGetUserSettingsRspType Complex Type

Sequence

MIDS 1..∞ MidRspType Complex Type

User

GetUserDeviceSettings PosGetUserDeviceSettingsRspType Complex Type

Sequence

MerchNbr merchNbrType Simple Type

Site optional NameValuePairRspType Complex Type

Permissions 1..∞ PermissionType Complex Type

Devices 1..∞ DeviceRspType 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

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

Sequence

MIDS 1..∞ MidRspType Complex Type

User

InvalidateAuthentication xs:anySimpleType

ManageSettings ManageSettingsRspType Complex Type

Sequence

Site optional NameValuePairRspType Complex Type

Device optional NameValuePairRspType Complex Type

ManageUsers PosManageUsersRspType Complex Type

Sequence

Users 1..∞ PosUserDetailRspType Complex Type

Device 1..∞ DeviceType Complex Type

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

PrePaidBalanceInquiry AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

RecurringBilling AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

RecurringBillingAuth AuthRspStatusType Complex Type

Internal Use Only

AgreementId optional xs:string

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

ReportActivity PosReportActivityRspType Complex Type

Internal Use Only

AgreementId optional xs:string

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

Sequence

ReportBatchDetail PosReportBatchDetailRspType Complex Type

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

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.

Sequence

ReportBatchHistory PosReportBatchHistoryRspType Complex Type

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

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

ReportBatchSummary PosReportBatchSummaryRspType Complex Type

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

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.

Sequence

ReportOpenAuths PosReportOpenAuthsRspType Complex Type

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

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.

Sequence

ReportSearch PosReportSearchRspType Complex Type

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

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.

Sequence

ReportTxnDetail PosReportTxnDetailRspType Complex Type

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

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

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

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

RewardCashData optional RewardCashDataType Complex Type

RewardCashData details.

SAFData optional SAFDataType Complex Type

SAF details

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

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.

IPData optional IPDataBlockType Complex Type

Information regarding Installment Plans associated with the transaction. Currently only returned for Visa Installment Service (VIS).

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.

ReportTxnResearch PosReportTxnResearchRspType Complex Type

Sequence

Transaction 0..∞

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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

TokenUpdaterHistory PosTokenUpdaterHistoryRspType Complex Type

Internal Use Only

AgreementId optional xs:string

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

SendReceipt

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

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

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)

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.

A group of optional fields that are related to Message Authentication

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.

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.

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

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