Bankcard Transaction Pro Data Elements

Applications that will support Level 2 and/or Level 3 data may be required to provide the following data elements in addition to the Base Transaction and Bankcard Transaction data elements.

Important! In addition to the Transaction and BankcardTransaction objects, you must also create a BankcardTransactionPro object to support Level 2 and/or Level 3 data elements.

Levels of "Pro" Data

There are three levels of "pro" transaction data supported by Commerce Web Services:

  • Level 2 Data – Contains "Pro" Bankcard transaction data specified in BankcardTransactionDataPro in the Level2Data object.
  • Level 3 Data – Contains "Pro" Bankcard transaction data specified in BankcardTransactionDataPro in the LineItemDetail object.
  • Managed Billing Data – Contains "Pro" Bankcard transaction data specified in BankcardTransactionDataPro in the ManagedBilling object to supporting recurring (installment) payments. Not currently supported.

BankcardCapturePro

Contains information for capturing Bankcard Pro transactions. Required.

 

Parameter Description Data Type
Level2Data Aggregate of elements specific to Level 2/Purchase Card transactions. Conditional, required when LineItemDetails are provided, otherwise optional if Service Information indicates PurchaseCardLevel (ServiceInformation) = 'Level2' or higher and this data was not passed in the authorization. Object
LineItemDetails Collection of transaction line item details. Conditional, optional if service information indicates PurchaseCardLevel (ServiceInformation) = 'Level3'. Object
MultiplePartialCapture If present (true), indicates that this is a partial capture of the authorized funds. Additional captures are made against the same authorization. If omitted (false) then this is the last amount to be captured from the authorization. Any additional authorized funds are released. Conditional, required if MultiplePartialCapture (ServiceInformation) is 'true'. Boolean
ShippingData Customer shipping details. Optional. Object

 


 

BankcardCaptureResponsePro

Response to capturing Bankcard Pro transactions. Expected.

Important! When sending in a BankcardCapture object, BankcardCaptureResponsePro inherits the data elements in BankcardCaptureResponse. The 'Pro' version of this object does not add any new fields.


 

BankcardInterchangeData

Details about a transaction that may lower interchange rates for the transaction. Optional.

Parameter Description Data Type
BillPayment Indicates that the transaction is one in a set of recurring or installment transactions. Conditional, required for recurring or installment transactions. Enum
CurrentInstallmentNumber Number of installment represented by this transaction. Conditional, required for installment transactions. Integer
ExistingDebt Indicates recurring or installment transaction is on existing debt. Conditional, required if BillPayment is set. Enum
RequestACI Authorization Characteristics Indicator. Identifies the request as potentially qualifying for the Visa CPS or MasterCard Merit programs. Optional. Enum
RequestAdvice Indicates whether to include advice on declined recurring payment transactions. Optional. Enum
RequestCommercialCard Request commercial card status for the transaction. Optional. Enum
TotalNumberOfInstallments Number of installments in the series. Conditional, required for installment transactions. Integer

 


 

BankcardReturnPro

Contains information for capturing Bankcard Pro transactions. Required.

Parameter Description Data Type
LineItemDetails Collection of transaction line item details. Conditional, optional if service information indicates PurchaseCardLevel (ServiceInformation) = 'Level3'. List<Object>

 


 

BankcardTransactionDataPro

Contains information about the Bankcard Pro transaction data. Conditional, required to support Level 2 and/or Level 3 transaction data.

Note: Managed Billing is not currently supported.

Parameter Description Data Type
IIASData Inventory Information Approval System (IIAS) data including amounts for Flexible Spending Account (FSA) eligible items. Object
Level2Data Aggregate of elements specific to Level 2/Purchase Card transactions. Conditional, required when LineItemDetails are provided, otherwise optional if Service Information indicates PurchaseCardLevel (ServiceInformation) = 'Level2' or 'Level3'. Object
LineItemDetails Collection of transaction line item details. Conditional, optional if Service Information indicates PurchaseCardLevel (ServiceInformation) = 'Level3'. List<Object>
ManagedBilling Not currently supported.
Configuration to setup and perform an automated recurring payment on the behalf of the merchant. Conditional, optional if ManagedBilling (ServiceInformation) = 'true', otherwise not present.
Object
PINlessDebitData Collection of transaction details related to PINless Debit cards. Conditional, optional when processing a recurring or installment MOTO or Ecommerce transaction with a PIN Debit card without entering a PIN. Object

 


 

BankcardTransactionPro

Contains information required to support recurring, installment, and deferred billing payments. Required.

Parameter Description Data Type
InterchangeData Details about a transaction that may lower interchange rates for the transaction. Optional. Object

 


 

BankcardTransactionResponsePro

Response to Bankcard Pro transactions. Expected.

Note: BankcardTransactionResponsePro inherits the data elements in Response and BankcardTransactionResponse.

For all Bankcard transactions, BankcardTransactionResponsePro is returned even if “Pro” data (Level2, Level3) is not supported.

Parameter Description Data Type
AdviceResponse Specifies the reason for issuer decline of recurring payment transactions. Optional. Enum
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. Optional. Enum
ReturnedACI Provides information concerning the status of a transaction's CPS qualification. Optional. String

 

Updated: 5/25/16 ~DS

Comments