Developer API Reference
Enumeration Reference
The following enumerations should be used to interpret response parameters after making calls to CWS.
The following Service Information enumerations are supported by CWS SOAP and REST integrations.
| Enumeration | Description | Valid Values |
|---|---|---|
| ApplicationLocation | Location of the application relative to the merchant. |
|
| BatchAssignmentSupport | Indicates level of batch assignment supported by the service. |
|
| CloseBatch | Defines the level of support for batch release functionality. Future Use. |
|
| CreditAuthorizeSupportType | Indicates the level of credit authorization support on a service. |
|
| CreditReturnSupportType | Indicates the types of Return transactions supported by the service for credit transactions. |
|
| CreditReversalSupportType | Indicates the level of credit authorization support on a service. |
|
| CustomerPresent | Presence of cardholder relative to the transaction point of service. |
|
| EncryptionType | Indicates the type of encryption block used by the card reader. |
|
| EntryMode | DEPRECATED: This must now be set on each individual transaction. Indicates how the cardholder data was retrieved. When authorizing with stored card data, either locally or with PaymentAccountDataToken, indicates that the card data was manually collected (Keyed or one of its variants). |
|
| HardwareType | Type of device running the application. |
|
| IndustryType | The industry type of the transaction. This is saved in the MerchantProfile (default) but may be overridden on each transaction. |
|
| PartialApprovalSupportType | Specifies whether the service supports partial approval capability at the transaction level. If not present, defaults to ‘DisabledAlwaysSupported’. Expected. |
|
| PINCapability | Support for cardholder Personal Identification Number (PIN). |
|
| PINDebitReturnSupportType | Indicates if Return is supported by the service for PIN Debit transactions. |
|
| PinDebitUndoSupportType | Indicates if Undo is supported by the service for PIN Debit transactions. |
|
| PurchaseCardLevel | Indicates the highest level of purchase card data supported by the service. Level 3 support is inclusive of Level 2 data, and Level 2 support is inclusive of Level 1 data. |
|
| QueryRejectedSupportType | Indicates if date ranges are supported for QueryRejected on a service. |
|
| ReadCapability | Capability of the device to read cardholder data. |
|
| RequestACI | Authorization Characteristics Indicator. Identifies the request as potentially qualifying for the Visa CPS or MasterCard Merit programs. | Note: Please refer to Address Verification Service under "General Guidelines" in Integration Guidelines for more information.
|
| RequestAdvice | Indicates whether to include advice on declined recurring payment transactions. |
|
| TenderType | The type of tender used for the transaction. |
|
| TrackDataSupportType | Indicates what track data is supported. |
|
| TypeISOCountryCodeA3 | Country code as defined by the International Standards Organization (ISO). | Refer to WSDL for valid values. For information about proxy generation and viewing the WSDL, refer to the CWS Developer's Guide. |
| TypeISOCurrencyCodeA3 | Currency code as defined by the International Standards Organization (ISO). | Refer to WSDL for valid values. For information about proxy generation and viewing the WSDL, refer to the CWS Developer's Guide. |
| TypeISOLanguageCodeA3 | Language code as defined by the International Standards Organization (ISO). Used for the response text message. | Refer to WSDL for valid values. For information about proxy generation and viewing the WSDL, refer to the CWS Developer's Guide. |
| TypeStateProvince | State or Province. | Refer to WSDL for valid values. For information about proxy generation and viewing the WSDL, refer to the CWS Developer's Guide. |
The following Base Transaction enumerations are supported by CWS SOAP and REST integrations.
| Enumeration | Description | Valid Values |
|---|---|---|
| CaptureState | Defines the state of the transaction as it relates to capture. |
|
| CVDataProvided | Indicates whether or not CV data was provided. Conditional, required for keyed transactions. Recommended for card-not-present authorizations. Not used in settlement. |
|
| CVResult | Response code returned by the card issuer indicating the result of Card Verification (CVV2/CVC2/CID). |
|
| EntryMode | Indicates how the cardholder data was retrieved. When authorizing with stored card data, either locally or with PaymentAccountDataToken, indicates that the card data was manually collected (keyed or one of its variants). |
|
| IndustryType | The industry type of the transaction. |
|
| Status | Indicates the authorization status of the transaction. |
|
| TenderType | Indicates the tender type of the transaction. |
|
| TransactionState | Indicates the current state of the transaction. |
|
| TypeISOCountryCodeA3 | Country code as defined by the International Standards Organization (ISO). | Refer to WSDL for valid values. For information about proxy generation and viewing the WSDL, refer to the CWS Developer's Guide. |
| TypeISOCurrencyCodeA3 | Currency code as defined by the International Standards Organization (ISO). | Refer to WSDL for valid values. For information about proxy generation and viewing the WSDL, refer to the CWS Developer's Guide. |
| TypeISOLanguageCodeA3 | Language code as defined by the International Standards Organization (ISO). Used for the response text message. | Refer to WSDL for valid values. For information about proxy generation and viewing the WSDL, refer to the CWS Developer's Guide. |
| TypeStateProvince | State or Province. | Refer to WSDL for valid values. For information about proxy generation and viewing the WSDL, refer to the CWS Developer's Guide. |
The following Bankcard Transaction enumerations are supported by CWS SOAP and REST integrations.
Note: The following enumerations are shared by the Bankcard Transaction Pro class.
| Enumeration | Description | Valid Values |
|---|---|---|
| AccountType | Indicates the bank account type. |
|
| AddressResult | Specifies the result of AVS as it pertains to address matching. |
|
| AdviceResponse | Specifies the reason for issuer decline of recurring payment transactions. |
|
| ApplicationLocation | Location of the application relative to the merchant. |
|
| BillPayment | Indicates the nature of a deferred, recurring, or installment transaction. |
|
| CardholderNameResult | Specifies the result of AVS as it pertains to cardholder name matching. |
|
| ChargeType | Indicates the type of charge. In most retail environments this value is set to ‘RetailOther’, but if other enumerations are applicable they should be used. Required for Retail transactions. |
|
| CityResult | Specifies the result of AVS as it pertains to city matching. |
|
| CommercialCardResponse | Indicates the status of the card with respect to its ability to utilize purchase card data. When the card is a Business, Corporate or Purchase card, providing purchase card data can result in improved interchange rates. |
|
| CountryResult | Specifies the result of AVS as it pertains to country matching. |
|
| CustomerPresent | Presence of cardholder relative to the transaction point of service. |
|
| ExistingDebt | Indicates recurring or installment transaction is on existing debt. Required if BillPayment is set. |
|
| GoodsType | Type of goods purchased. |
|
| HardwareType | Type of device running the application. |
|
| IIASDesignation | Type of goods purchased. |
|
| Interval | Unit used in calculating the period. |
|
| IsTaxExempt | Indicates tax exempt status of the transaction. |
|
| PartialApprovalSupportType | Indicateswhether the service supports partial approvals (authorizations) at the transaction level. |
|
| Specifies the result of AVS as it pertains to phone matching. |
|
|
| PINCapability | Indicates support for cardholder Personal Identification Number (PIN). |
|
| PINDebitUndoReason | Specifies the reason for the undo. Required for PIN Debit transactions. |
|
| PostalCodeResult | Specifies the result of AVS as it pertains to postal code matching. |
|
| PrepaidCard | Specifies whether or not the card is a prepaid card. The identification of prepaid cards is at the discretion of the payment brand or issuer. Optional. |
|
| ReadCapability | Capability of the device to read cardholder data. |
|
| RequestACI | Authorization Characteristics Indicator. Identifies the request as potentially qualifying for the Visa CPS or MasterCard Merit programs. |
|
| RequestAdvice | Indicates whether to include advice on declined recurring payment transactions. |
|
| RequestCommercialCard | Request commercial card status for the transaction. |
|
| Resubmit | Specifies whether resubmission is supported for PIN Debit transactions. |
|
| ReturnedACI | Provides information concerning the status of a transaction's CPS qualification. |
|
| StateResult | Specifies the result of AVS as it pertains to state matching. |
|
| TokenIndicator | Specifies VPAS, UCAF, or SET certificate S/N. |
|
| TypeCardType | Type of card used in the transaction. |
|
| TypeTaxType | Type of tax applied. |
|
| TypeUnitOfMeasure | Units used to measure quantity. | Refer to WSDL for valid values. For information about proxy generation and viewing the WSDL, refer to the CWS Developer's Guide. |
The following Electronic Checking Transaction enumerations are supported by CWS SOAP and REST integrations.
| Enumeration | Description | Valid Values |
|---|---|---|
| CheckCountryCode | Bank account country of origin for receiver deposit. |
|
| OwnerType | Indicates the type of entity which owns the account. |
|
| SECCode | The three letter code that indicates what NACHA regulations the transaction must adhere to. |
|
| ServiceType | Indicates the Electronic Checking service type: ACH, RDC or ECK. |
|
| TransactionType | Indicates the transaction type. |
|
| UseType | Indicates the type of account. |
|