Serialized Form

Package com.broadleafcommerce.vendor.chasepayment.provider.exception

Exception com.broadleafcommerce.vendor.chasepayment.provider.exception.ProviderApiException

class ProviderApiException extends RuntimeException implements Serializable

Serialized Fields

receivedException

org.springframework.web.reactive.function.client.WebClientResponseException receivedException

Package com.broadleafcommerce.vendor.chasepayment.service.hps.domain

Class com.broadleafcommerce.vendor.chasepayment.service.hps.domain.BroadleafHPSOrderAbstractionInitBillingAddress

class BroadleafHPSOrderAbstractionInitBillingAddress extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

address

String address

Customer street address first line.

See Also:

• HPSOrderAbstractionInitRequest.getAddress()

address2

String address2

Customer street address second line.

See Also:

• HPSOrderAbstractionInitRequest.getAddress2()

billingName

String billingName

Customer billing address name.

See Also:

• HPSOrderAbstractionInitRequest.getBilling_name()

city

String city

City of address.

See Also:

• HPSOrderAbstractionInitRequest.getCity()

country

String country

ISO Code of country. 2 or 3 character ISO code.

See Also:

• HPSOrderAbstractionInitRequest.getCountry()

email

String email

Customer email for the billing address.

See Also:

• HPSOrderAbstractionInitRequest.getEmail()

phone

String phone

Customer phone number for the billing address.

See Also:

• HPSOrderAbstractionInitRequest.getPhone()

postalCode

String postalCode

Postal (ZIP) code.

See Also:

• HPSOrderAbstractionInitRequest.getPostal_code()

stateProvince

String stateProvince

State or province

See Also:

• HPSOrderAbstractionInitRequest.getState_province()

Class com.broadleafcommerce.vendor.chasepayment.service.hps.domain.BroadleafHPSOrderAbstractionInitRequest

class BroadleafHPSOrderAbstractionInitRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

billingAddress

BroadleafHPSOrderAbstractionInitBillingAddress billingAddress

Billing address fields. If provided, will be passed along to pre-populate the HPF with these values. Useful in scenarios where a shipping address is already known and the billing address is the 'same as shipping address'.

description

String description

A description that will be stored in the UID metadata (on Chase's side) to indicate why this profile was created. If not provided, a generic default value will be set by the system.

hpsFormName

String hpsFormName

This field allows the API caller to request a specific, named form pre-configured in Chase HPS. If not specified, this will fall back to the HPSProviderDiscriminatedProperties.getFormName(String, String). If provided, this value is validated against HPSProviderDiscriminatedProperties.getAllowedRequestableFormNames(String, String).

paymentOwnerId

String paymentOwnerId

In most cases, this will be the Broadleaf Cart ID. Please see BroadleafHPSOrderAbstractionInitRequest.getPaymentOwnerType() for more context about this field.

paymentOwnerType

String paymentOwnerType

After HPS submission is completed and the profile is created, the caller's next step is typically to create a BLC Payment with the result. In an effort to guarantee consistency of payment ownership (i.e., a profile created for cartX cannot be used to create a Payment for cartY), the caller should send the expected payment owner information in this field. It will be passed along and stored in the UID metadata (on Chase's side).

In most cases, this will be 'BLC_CART'.

Class com.broadleafcommerce.vendor.chasepayment.service.hps.domain.BroadleafHPSOrderAbstractionInitResponse

class BroadleafHPSOrderAbstractionInitResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

hpsBaseRequestUrl

String hpsBaseRequestUrl

The base URL which should be used to request the HPF/HPP. We provide this information to reduce the burden on the frontend to maintain its own knowledge of HPS URLs.

Expectation is for the caller to put the BroadleafHPSOrderAbstractionInitResponse.getUid() as a query parameter on this base URL to request the HPF/HPP.

uid

String uid

See Also:

• HPSOrderAbstractionInitResponse.getUid()

Class com.broadleafcommerce.vendor.chasepayment.service.hps.domain.HPSOrderAbstractionInitRequest

class HPSOrderAbstractionInitRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

address

String address

Customer street billing address first line.

address2

String address2

Customer street billing address second line.

api_key

String api_key

See Also:

• HPSProviderDiscriminatedProperties.getApiKey(java.lang.String, java.lang.String)

billing_name

String billing_name

Customer billing address name.

card_indicators

String card_indicators

Card Indicators are authorization data elements available to merchants who use the Stratus (BIN 000001) platform. Card Indicators, also referred to as Card Type Indicators (CTI), are designed to capture valuable data that helps merchants make better payment decisions both at the time of the transaction and afterward

When set to 'Y', card indicators will be made available to the backend in responses to subsequent UID query requests. When 'N', card indicators will not be made available. Having this information can be helpful for determining whether the customer supplied a purchasing card and thus whether Level 2 data should be included in subsequent auth/capture transactions.

city

String city

City of billing address.

country

String country

ISO Code of country of billing address. 2 or 3 character ISO code.

customer_ref_num

String customer_ref_num

Useful if we want the Orbital profile to be created with a pre-determined ID value. The recommendation is to leave this blank to allow Chase to auto-generate the Orbital profile ID.

description

String description

Text description of the purchase this is being submitted for.

email

String email

Customer email for the billing address.

form_name

String form_name

See Also:

• HPSProviderDiscriminatedProperties.getFormName(java.lang.String, java.lang.String)
• BroadleafHPSOrderAbstractionInitRequest.getHpsFormName()

merchant_data1

String merchant_data1

Custom field that can be used by the merchant to pass system related values.

merchant_data2

String merchant_data2

Custom field that can be used by the merchant to pass system related values.

merchant_data3

String merchant_data3

Custom field that can be used by the merchant to pass system related values.

merchant_data4

String merchant_data4

Custom field that can be used by the merchant to pass system related values.

merchant_data5

String merchant_data5

Custom field that can be used by the merchant to pass system related values.

mit_msg_type

String mit_msg_type

See Also:

• HPSProviderDiscriminatedProperties.getMitMsgType(java.lang.String, java.lang.String, java.lang.String)

order_id

String order_id

System value of the order, reversal, or payment. This field is defined and supplied by us, and echoed back by Chase in responses.

phone

String phone

Customer phone number for the billing address.

postal_code

String postal_code

Postal (ZIP) code of billing address

retry_limit

String retry_limit

See Also:

• HPSProviderDiscriminatedProperties.getRetryLimit(java.lang.String, java.lang.String, java.lang.String)

secure_id

String secure_id

See Also:

• HPSProviderDiscriminatedProperties.getSecureId(java.lang.String, java.lang.String)

state_province

String state_province

State or province of billing address

tokenize

String tokenize

This is used to identify whether an Orbital customer profile should be created as part of an HPS submission. The only valid value (if supplied) is "1".

Chase states that this is specifically relevant when using DefaultHPSTransactionTypes.ACCOUNT_VERIFY or any transaction type that would engage an Authorization or Authorization-Capture request.

total_amount

String total_amount

The total amount of the transaction that should be engaged upon HPS submission, including a decimal and excluding a currency symbol. For example, "10.00". A decimal must be included to ensure the correct amount is sent. Not including a decimal may result in the incorrect amount being processed.

txn_type

String txn_type

See Also:

• HPSProviderDiscriminatedProperties.getTxnType(java.lang.String, java.lang.String, java.lang.String)
• DefaultHPSTransactionTypes

Class com.broadleafcommerce.vendor.chasepayment.service.hps.domain.HPSOrderAbstractionInitResponse

class HPSOrderAbstractionInitResponse extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

uid

String uid

The UID for the HPF/HPP that was generated for the init request.

Class com.broadleafcommerce.vendor.chasepayment.service.hps.domain.HPSOrderAbstractionQueryResponse

class HPSOrderAbstractionQueryResponse extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

address

String address

See Also:

• HPSOrderAbstractionInitRequest.getAddress()

address2

String address2

See Also:

• HPSOrderAbstractionInitRequest.getAddress2()

billing_name

String billing_name

See Also:

• HPSOrderAbstractionInitRequest.getBilling_name()

card_brand

String card_brand

The card brand of the card the customer entered.

city

String city

See Also:

• HPSOrderAbstractionInitRequest.getCity()

country

String country

See Also:

• HPSOrderAbstractionInitRequest.getCountry()

description

String description

See Also:

• HPSOrderAbstractionInitRequest.getDescription()

email

String email

See Also:

• HPSOrderAbstractionInitRequest.getEmail()

exp_month

String exp_month

The two-digit expiration month of the card the customer provided.

exp_year

String exp_year

The 4 digit expiration year of the card the customer provided.

gateway

GatewayResponse gateway

This will contain all the (variable) response data from the Orbital Gateway.

gateway_code

String gateway_code

Transaction response code returned by the gateway.

gateway_message

String gateway_message

Similar to HPSOrderAbstractionQueryResponse.getStatus_message() but will include the message returned by the gateway.

merchant_data1

String merchant_data1

See Also:

• HPSOrderAbstractionInitRequest.getMerchant_data1()

merchant_data2

String merchant_data2

See Also:

• HPSOrderAbstractionInitRequest.getMerchant_data2()

merchant_data3

String merchant_data3

See Also:

• HPSOrderAbstractionInitRequest.getMerchant_data3()

merchant_data4

String merchant_data4

See Also:

• HPSOrderAbstractionInitRequest.getMerchant_data4()

merchant_data5

String merchant_data5

See Also:

• HPSOrderAbstractionInitRequest.getMerchant_data5()

mpan

String mpan

The masked payment account number submitted by the customer (for example, the card number with many of the digits replaced with 'X').

order_id

String order_id

See Also:

• HPSOrderAbstractionInitRequest.getOrder_id()

phone

String phone

See Also:

• HPSOrderAbstractionInitRequest.getPhone()

postal_code

String postal_code

See Also:

• HPSOrderAbstractionInitRequest.getPostal_code()

state_province

String state_province

See Also:

• HPSOrderAbstractionInitRequest.getState_province()

status

String status

Transaction response status. Either "Success" or "Fail"

status_code

String status_code

Transaction status code according to the status value. The response code varies when there is an error. On success, the code is 00. If the transaction fails on the gateway end the code will be 2300, and the code will vary for other failures.

status_message

String status_message

Status message returned by the gateway on success. If the transaction failed on the gateway end, the message will be "Gateway Error".

total_amount

String total_amount

See Also:

• HPSOrderAbstractionInitRequest.getTotal_amount()

uid

String uid

Echoes the UID from the request.

Package com.broadleafcommerce.vendor.chasepayment.service.hps.domain.subschemas

Class com.broadleafcommerce.vendor.chasepayment.service.hps.domain.subschemas.GatewayResponse

class GatewayResponse extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

approvalStatus

String approvalStatus

This field is used to communicate an overall status for the transaction. The GatewayResponse.getRespCode() might have the specific error, but this field allows for a general understanding of the category of the error.

See Also:

• DefaultOrbitalApprovalStatusCodes

avsRespCode

String avsRespCode

Response code describing the result of address verification.

See Also:

• DefaultOrbitalAvsRespCodes

cardBrand

String cardBrand

The card brand of the card submitted by the customer.

ctiCommercialCard

String ctiCommercialCard

If "Y", the card submitted by the customer is a commercial card and supports Level 2 data.

customerRefNum

String customerRefNum

If the HPS submission was successful and a profile was successfully created, this is the reference number of the profile. This is important to harvest, as it's the value necessary to provide in subsequent transaction requests.

cvvRespCode

String cvvRespCode

Response code describing the result of CVV verification.

See Also:

• DefaultOrbitalCvvRespCodes

procStatus

String procStatus

The Orbital Gateway runs various validations on every request message, to ensure the request is valid in format and business logic. These validations happen prior to communication with the Hosts (Tandem / Stratus) and should therefore be verified first. The procStatus element is returned in all response types to communicate the result of all validations done by the Orbital Gateway.

This is the only element that is returned in all response scenarios.

procStatusMessage

String procStatusMessage

Text message associated with GatewayResponse.getProcStatus()

profileProcStatus

String profileProcStatus

Communicates the success or failure of a Profile Management request. 0 means success, >0 is an error.

profileProcStatusMsg

String profileProcStatusMsg

Text message associated with GatewayResponse.getProfileProcStatus()

respCode

String respCode

If all the Orbital-local validations pass in GatewayResponse.getProcStatus(), then the transaction will proceed to the 'Host', AKA Stratus or Tandem.

Chase provides normalized response data from the Host in this field (for consistency between Stratus and Tandem). This will identify approval, or the reason for decline or error. Business logic should always use this field for its normalized representation.

respCodeMessage

String respCodeMessage

Text message associated with GatewayResponse.getRespCode().

Package com.broadleafcommerce.vendor.chasepayment.service.hps.exception

Exception com.broadleafcommerce.vendor.chasepayment.service.hps.exception.UnexpectedHPSFailureException

class UnexpectedHPSFailureException extends RuntimeException implements Serializable

Package com.broadleafcommerce.vendor.chasepayment.service.orbital.domain

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.OrbitalCaptureRequest

class OrbitalCaptureRequest extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

level2

LevelTwoPaymentInfo level2

Captures Level 2 information on the transaction. From Chase: Level 2 and Level 3 data are supported for Purchasing and Commercial Cards. These additional data fields are typically used in a business-to-business environment. The BIN range assigned by the card associations can identify purchasing cards or commercial cards.

merchant

Merchant merchant

Captures details around the platform the merchant is using.

order

Order order

Captures details about the order this transaction is being executed for.

version

String version

The feature version of the Orbital API.

See Also:

• OrbitalGatewayProviderGlobalProperties.getOrbitalApiFeatureVersion()

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.OrbitalCaptureResponse

class OrbitalCaptureResponse extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

merchant

Merchant merchant

Captures details around the platform the merchant is using.

order

Order order

Captures details about the order this transaction is being executed for.

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.OrbitalCreatePaymentRequest

class OrbitalCreatePaymentRequest extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

avsBilling

AvsBilling avsBilling

Captures details about the AVS billing address for this transaction.

emvInfo

EmvInfo emvInfo

Captures details around the location data captured for the customer.

level2

LevelTwoPaymentInfo level2

Captures Level 2 information on the transaction. From Chase: Level 2 and Level 3 data are supported for Purchasing and Commercial Cards. These additional data fields are typically used in a business-to-business environment. The BIN range assigned by the card associations can identify purchasing cards or commercial cards.

merchant

Merchant merchant

Captures details around the platform the merchant is using.

merchantInitiatedTransaction

MerchantInitiatedTransaction merchantInitiatedTransaction

Captures CIT/MIT data about this transaction.

order

Order order

Captures details about the order this transaction is being executed for.

paymentInstrument

PaymentInstrument paymentInstrument

Captures details about the payment instrument used to transact.

transType

String transType

The transaction type to execute.

See Also:

• DefaultOrbitalTransactionTypes

version

String version

The feature version of the Orbital API.

See Also:

• OrbitalGatewayProviderGlobalProperties.getOrbitalApiFeatureVersion()

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.OrbitalCreatePaymentResponse

class OrbitalCreatePaymentResponse extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

avsBilling

AvsBilling avsBilling

Captures details about the AVS billing address for this transaction.

merchant

Merchant merchant

Captures details around the platform the merchant is using.

order

Order order

Captures details about the order this transaction is being executed for.

paymentInstrument

PaymentInstrument paymentInstrument

Captures details about the payment instrument used to transact.

transType

String transType

The transaction type.

See Also:

• DefaultOrbitalTransactionTypes

version

String version

The feature version of the Orbital API.

See Also:

• OrbitalGatewayProviderGlobalProperties.getOrbitalApiFeatureVersion()

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.OrbitalErrorResponse

class OrbitalErrorResponse extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

procStatus

String procStatus

Similar to Status.getProcStatus()

procStatusMessage

String procStatusMessage

Text message associated with OrbitalErrorResponse.getProcStatus()

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.OrbitalPaymentRequestWrapper

class OrbitalPaymentRequestWrapper extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

paymentRequest

com.broadleafcommerce.paymentgateway.domain.PaymentRequest paymentRequest

Request details to use when executing the transaction.

transactionType

com.broadleafcommerce.paymentgateway.domain.enums.TransactionType transactionType

The transaction type, typically set by ChaseOrbitalGatewayTransactionService depending on the transaction being requested.

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.OrbitalRefundRequest

class OrbitalRefundRequest extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

level2

LevelTwoPaymentInfo level2

Captures Level 2 information on the transaction. From Chase: Level 2 and Level 3 data are supported for Purchasing and Commercial Cards. These additional data fields are typically used in a business-to-business environment. The BIN range assigned by the card associations can identify purchasing cards or commercial cards.

merchant

Merchant merchant

Captures details around the platform the merchant is using.

order

Order order

Captures details about the order this transaction is being executed for.

version

String version

The feature version of the Orbital API.

See Also:

• OrbitalGatewayProviderGlobalProperties.getOrbitalApiFeatureVersion()

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.OrbitalRefundResponse

class OrbitalRefundResponse extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

merchant

Merchant merchant

Captures details around the platform the merchant is using.

order

Order order

Captures details about the order this transaction is being executed for.

transType

String transType

The transaction type.

See Also:

• DefaultOrbitalTransactionTypes

version

String version

The feature version of the Orbital API.

See Also:

• OrbitalGatewayProviderGlobalProperties.getOrbitalApiFeatureVersion()

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.OrbitalReversalRequest

class OrbitalReversalRequest extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

merchant

Merchant merchant

Captures details around the platform the merchant is using.

order

Order order

Captures details about the order this transaction is being executed for.

version

String version

The feature version of the Orbital API.

See Also:

• OrbitalGatewayProviderGlobalProperties.getOrbitalApiFeatureVersion()

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.OrbitalReversalResponse

class OrbitalReversalResponse extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

merchant

Merchant merchant

Captures details around the platform the merchant is using.

order

Order order

Captures details about the order this transaction is being executed for.

version

String version

The feature version of the Orbital API.

See Also:

• OrbitalGatewayProviderGlobalProperties.getOrbitalApiFeatureVersion()

Package com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.ApplePayEncryptedPaymentBundle

class ApplePayEncryptedPaymentBundle extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

data

String data

Apple Pay encrypted payment data (payment data dictionary, Base64 encoded as a string).

header

ApplePayHeader header

Additional version-dependent information used to decrypt and verify the payment.

signature

String signature

Signature of the payment and header data (detached PKCS #7 signature, Base64 encoded as a string).

version

String version

Version information about the payment token. The token uses EC_v1 for ECC-encrypted data and RSA_v1 for RSA-encrypted data.

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.ApplePayHeader

class ApplePayHeader extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

applicationData

String applicationData

Hash of the applicationData property of the original PKPaymentRequest object for transactions that initiate in apps. For transactions that initiate in Apple Pay on the Web, the value is the hash of applicationData in ApplePayPaymentRequest or of applicationData in ApplePayRequest.

ephemeralPublicKey

String ephemeralPublicKey

Ephemeral public key bytes (X.509 encoded key bytes, Base64 encoded as a string). EC_v1 only.

publicKeyHash

String publicKeyHash

Hash of the X.509 encoded public key bytes of the merchant’s certificate.

transactionId

String transactionId

Transaction identifier, generated on the device.

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.AvsBilling

class AvsBilling extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

avsAddress1

String avsAddress1

The first line of the cardholder's billing address used in AVS.

avsAddress2

String avsAddress2

The second line of the cardholder's billing address used in AVS.

avsCity

String avsCity

The city of the cardholder's billing address used in AVS.

avsCountryCode

String avsCountryCode

The standard two-character ISO country code of the cardholder's billing address used in AVS.

avsName

String avsName

The full name of the cardholder as depicted on the billing address used in AVS.

avsPhone

String avsPhone

The phone number for the cardholder as depicted on the billing address used in AVS.

avsPhoneType

String avsPhoneType

The phone type indicator for the cardholder's billing address used in AVS.

avsRespCode

String avsRespCode

Address verification request response code. This value is conditional on AVS being requested.

avsState

String avsState

The state of the cardholder's billing address used in AVS.

avsZip

String avsZip

The zip code of the cardholder's billing address used in AVS.

hostAVSRespCode

String hostAVSRespCode

Exact address verification response sent by host authorization system (non-normalized by the Gateway).

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.EmvInfo

class EmvInfo extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

latitudeLongitude

String latitudeLongitude

Geographic latitude and longitude coordinates of the device at the time of transaction. Only used in wallet transactions by the gateway to generate a map on receipts.

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.LevelTwoPaymentInfo

class LevelTwoPaymentInfo extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

amexTranAdvAddn1

String amexTranAdvAddn1

Amex Purchasing Card Data – Transaction Advice Addendum #1 The TAA Record further identifies the purchase associated with the charge to the cardholder. It is also used in Purchasing/Procurement card transactions to provide specific details about the transaction to the cardholder for tracking purposes. TAAs should be as concise as possible, while still providing adequate information. For example, a TAA of Merchandise would not be acceptable.

amexTranAdvAddn2

String amexTranAdvAddn2

Amex Purchasing Card Data – Transaction Advice Addendum #2 The original transaction can be updated with purchasing card information during a Capture.

amexTranAdvAddn3

String amexTranAdvAddn3

Amex Purchasing Card Data – Transaction Advice Addendum #3 The original transaction can be updated with purchasing card information during a Capture.

amexTranAdvAddn4

String amexTranAdvAddn4

Amex Purchasing Card Data – Transaction Advice Addendum #4 The original transaction can be updated with purchasing card information during a Capture.

pCardCommodityCode

String pCardCommodityCode

Commodity Code used to categorize purchases for VAT reporting. Applicable for BIN 000001 Canadian merchants only. Supported MOPs: Visa and Mastercard Valid values:

• LID = Line Item Detail
• SUMM = Summary Tax
• “ ” = Blanks (MC only)

pCardCustomerVatRegNumber

String pCardCustomerVatRegNumber

Customer VAT Tax Registration Number. Applicable for BIN 00001 and BIN 000002 merchants for Visa only.

pCardDestAddress

String pCardDestAddress

Amex Purchasing Card Data Cardholder Ship To: Address line 1 Applicable to BIN 000001 only.

pCardDestAddress2

String pCardDestAddress2

Amex Purchasing Card Data Cardholder Ship To: Address line 2 Applicable to BIN 000001 only.

pCardDestCity

String pCardDestCity

Amex Purchasing Card Data Cardholder Ship To: City Applicable to BIN 000001 only.

pCardDestName

String pCardDestName

Amex Purchasing Card Data Cardholder Ship To: Name Applicable to BIN 000001 only.

pCardDestStateCd

String pCardDestStateCd

Amex Purchasing Card Data Cardholder Ship To: State Applicable to BIN 000001 only

pCardDestZip

String pCardDestZip

The zip/postal code of the ship to location. This field is equal to the ship from zip/postal code when the customer takes possession of the items at the merchant’s site. Allows for 5-digit, 9-digit, or Canadian zip

pCardDtlTaxAmount1

String pCardDtlTaxAmount1

No Chase docs on this property.

pCardDtlTaxAmount1Ind

String pCardDtlTaxAmount1Ind

No Chase docs on this property.

pCardDtlTaxAmount2

String pCardDtlTaxAmount2

No Chase docs on this property.

pCardDtlTaxAmount2Ind

String pCardDtlTaxAmount2Ind

No Chase docs on this property.

pCardLocalTaxAmount

String pCardLocalTaxAmount

Local Tax (PST or QST) on the invoice. Can be all zeros, depending on the Canadian province of origin for the transaction. Applicable for BIN 000001 and BIN 000002 merchants. Supported MOP: Mastercard Canadian transactions only

pCardLocalTaxRate

String pCardLocalTaxRate

Supported MOP: Visa Rate of local tax. Format: three decimals implied. Example: 06250 is 6.25%

pCardMerchantVatRegNumber

String pCardMerchantVatRegNumber

Canadian registration ID. If this field is blank or all zeros, the transaction may not qualify for the best interchange rate. Applicable to BIN 000001 and BIN 000002 Canadian merchants. Supported MOP: Visa and Mastercard

pCardNationalTax

String pCardNationalTax

Must reflect the amount of National Tax (GST or HST) appearing on the invoice. Format: two decimals implied Example: 0625 is $6.25 Supported MOP: Visa Canadian transactions

pCardNationalTaxRate

String pCardNationalTaxRate

Must reflect the National Tax Rate (GST or HST) appearing on the invoice. If this field is blank, the transaction may not qualify for the best interchange rate. For BIN 000001 and BIN 000002 merchants. Format: three decimals implied Example: 06250 is 6.25% Supported MOP: Mastercard Canadian transactions only

pCardOrderID

String pCardOrderID

Purchase order or other number used by the merchant's customer to track the order. Do not include the following characters: < > ? ; ’ : ” [] \ { } | ` = ~ ! @ # % ^ & * ( ) _ + Max size is 17 characters.

pCardPstTaxRegNumber

String pCardPstTaxRegNumber

Canadian provincial sales tax registration number. Send if local tax applies (PST or QST). Applicable to BIN 000001 and BIN 000002 Canadian merchants. Supported MOP: Visa and Mastercard

pCardRequestorName

String pCardRequestorName

Name of the customer that ordered or purchased the product or service if not the cardmember. Cannot be null or blank space filled. Blank spaces can be included for merchants in the US, but cannot be included for merchants in Canada. If a blank space is included in the value for Canada merchants, a procStatus code of 19771 will be returned.

pCardTotalTaxAmount

String pCardTotalTaxAmount

Total sales tax amount applied to the transaction

taxAmount

String taxAmount

Amount of sales tax assessed to the transaction. Format: two decimals implied, including those currencies that are a zero exponent. Example: 1000 is $10.00

taxInd

String taxInd

Tax Type Visa does not allow level 2 transactions to be tax exempt. Tax exempt merchants should attempt level 3 processing. Note: Tax-exempt transactions require a value of "2"

• "0" = Not provided
• "1" = Included
• "2" = Non-Taxable

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.Merchant

class Merchant extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

bin

String bin

See Also:

• DefaultOrbitalPlatformBins

terminalID

String terminalID

See Also:

• DefaultOrbitalTerminalIds

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.MerchantInitiatedTransaction

class MerchantInitiatedTransaction extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

mitMsgType

String mitMsgType

See Also:

• DefaultCITMITMessageCodes

mitStoredCredentialInd

String mitStoredCredentialInd

Indicates that the cardholder credentials are on file with the merchant. 'Y' if so, 'N' otherwise.

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.Order

class Order extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

adjustedAmount

String adjustedAmount

For OrbitalReversalRequest, this field is optionally used to specify the amount that needs to be reversed/voided. OrbitalReversalRequest uses this field instead of Order.getAmount() to specify the amount.

From Chase documentation:

• When a specific amount is included with this field, that amount will be voided/reversed (assuming that the amount is not greater than the transaction amount remaining).
• If the amount is equal to the original transaction amount then a full void/reversal is performed
• If the amount is greater than the original amount then an error will be generated

amount

String amount

Only provided in requests.

A special-format string representing the amount of the transaction. The last two digits of this value are interpreted as the decimal. For example, to represent $1.00, the value would be "100", and to represent $123.00, the value would be "12300".

From Chase documentation: "Note: Currency and currency code are not passed in the request. It is implied by the Currency setup for the Merchant ID."

See Also:

• Order.getRequestAmount()
• Order.getRedeemedAmount()

industryType

String industryType

The industry type for the transaction.

See Also:

• DefaultOrbitalIndustryTypes

orderID

String orderID

The ID of the order this transaction is being executed for. This is a merchant-provided value.

redeemedAmount

String redeemedAmount

Only returned in responses.

Indicates the amount returned in the response from the host. Essentially, the actual amount transacted.

See Also:

• Order.getAmount()

requestAmount

String requestAmount

Only returned in responses.

Echoes the amount from the request.

See Also:

• Order.getAmount()

retryTrace

String retryTrace

Merchant generated number to determine the uniqueness of a refund transaction by recognizing subsequent retries of the same request.

splitTxRefIdx

String splitTxRefIdx

In partial DefaultTransactionTypes.CAPTURE transactions, Orbital will return a value in this field which is the "Transaction Reference Number of Split Transaction", or "the transaction reference number of the partial capture request". This is different from the main Order.getTxRefNum() that would have been submitted in the original request.

At the time of writing, this value is recorded mainly for auditing purposes, and is not leveraged anywhere for business logic.

status

Status status

Only received in responses from the gateway. Not used in requests.

txRefIdx

String txRefIdx

Gateway Transaction Index - used to identify the unique components of transactions adjusted more than once.

txRefNum

String txRefNum

Orbital Gateway Transaction Reference Number - a unique Orbital-generated value for each transaction.

Can be supplied in a request (for example, when attempting to capture/reverse/refund against a previous transaction). Requests that don't need to reference a previous transaction should leave this blank (Chase docs state it will be ignored anyway).

The Orbital gateway will return a value in this field for the value it generates for this transaction.

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.PaymentInstrument

class PaymentInstrument extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

encryptedPaymentBundle

EncryptedPaymentBundle encryptedPaymentBundle

The encrypted payment data for the wallet.

See Also:

• EncryptedPaymentBundle
• ApplePayEncryptedPaymentBundle

useProfile

UseProfilePaymentInstrument useProfile

Relevant when the intent is to transact using payment information already stored in an existing Chase Orbital Profile. For example, when using HPS, upon form submission, a Chase Profile will be created with the card information the user provided. The created profile's reference number can be provided here, which will result in the transaction being executed against that saved card data.

walletType

String walletType

The wallet type used when making this request. Only applicable for wallet-based transactions, in conjunction with the PaymentInstrument.getEncryptedPaymentBundle().

See Also:

• DefaultOrbitalWalletTypes

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.Status

class Status extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

approvalStatus

String approvalStatus

This field is used to communicate an overall status for the transaction. The Status.getRespCode() might have the specific error, but this field allows for a general understanding of the category of the error.

See Also:

• DefaultOrbitalApprovalStatusCodes

hostRespCode

String hostRespCode

This field contains the actual, raw response code from the 'Host', AKA Stratus or Tandem. This is provided for completeness, but generally speaking any logic should target the normalized value in Status.getRespCode() instead.

procStatus

String procStatus

The Orbital Gateway runs various validations on every request message, to ensure the request is valid in format and business logic. These validations happen prior to communication with the Hosts (Tandem / Stratus) and should therefore be verified first. The procStatus element is returned in all response types to communicate the result of all validations done by the Orbital Gateway.

This is the only element that is returned in all response scenarios.

procStatusMessage

String procStatusMessage

Text message associated with Status.getProcStatus()

respCode

String respCode

If all the Orbital-local validations pass in Status.getProcStatus(), then the transaction will proceed to the 'Host', AKA Stratus or Tandem.

Chase provides normalized response data from the Host in this field (for consistency between Stratus and Tandem). This will identify approval, or the reason for decline or error. Note that Status.getHostRespCode() will contain the raw value from the host in case the consumer needs that info, but business logic should almost always use Status.getRespCode() instead for its normalized representation.

respCodeMessage

String respCodeMessage

Text message associated with Status.getRespCode().

Class com.broadleafcommerce.vendor.chasepayment.service.orbital.domain.subschemas.UseProfilePaymentInstrument

class UseProfilePaymentInstrument extends AbstractAdditionalPropertiesAwareDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

useCustomerRefNum

String useCustomerRefNum

This is the 'customerRefNum' used to identify the existing Chase Orbital Profile that should be used to transact.

Package com.broadleafcommerce.vendor.chasepayment.service.orbital.external.transformer.exception

Exception com.broadleafcommerce.vendor.chasepayment.service.orbital.external.transformer.exception.OrbitalRequestCreationException

class OrbitalRequestCreationException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.vendor.chasepayment.service.orbital.external.transformer.exception.OrbitalRequestResponseTransformerNotFoundException

class OrbitalRequestResponseTransformerNotFoundException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.vendor.chasepayment.service.orbital.external.transformer.exception.OrbitalResponseInterpretationException

class OrbitalResponseInterpretationException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.vendor.chasepayment.service.orbital.external.transformer.exception.UnexpectedOrbitalRequestResponseException

class UnexpectedOrbitalRequestResponseException extends RuntimeException implements Serializable

Package com.broadleafcommerce.vendor.chasepayment.service.support.exception

Exception com.broadleafcommerce.vendor.chasepayment.service.support.exception.MissingRequiredConfigurationException

class MissingRequiredConfigurationException extends RuntimeException implements Serializable

Package com.broadleafcommerce.vendor.chasepayment.service.wallet.domain

Class com.broadleafcommerce.vendor.chasepayment.service.wallet.domain.ChasePaymentCreateApplePaySessionRequest

class ChasePaymentCreateApplePaySessionRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

displayName

String displayName

See Also:

• ChasePaymentApplePayConfigurationProperties.getDisplayName(String, String)

initiative

String initiative

See Also:

• ChasePaymentApplePayConfigurationProperties.getInitiative(String, String)

initiativeContext

String initiativeContext

See Also:

• ChasePaymentApplePayConfigurationProperties.getInitiativeContext(String, String)

merchantIdentifier

String merchantIdentifier

See Also:

• ChasePaymentApplePayConfigurationProperties.getMerchantIdentifier(String, String)

Package com.broadleafcommerce.vendor.chasepayment.service.wallet.exception

Exception com.broadleafcommerce.vendor.chasepayment.service.wallet.exception.ChasePaymentApplePayCertificateException

class ChasePaymentApplePayCertificateException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.vendor.chasepayment.service.wallet.exception.ChasePaymentCreateApplePaySessionException

class ChasePaymentCreateApplePaySessionException extends RuntimeException implements Serializable