Optional Operations

  1. Home
  2. Commerce Web Services
  3. Workflows
  4. Transaction Processing
  5. Optional Operations

Commerce Web Services

Print Friendly, PDF & Email

Transaction Processing Optional Operations

The following optional operations can be implemented based on the the specific requirements of the application:

The Acknowledge operation is used to mark a transaction as ‘acknowledged’ after receiving a successful transaction response. This acknowledgement is useful when performing transaction management functions, such as those provided by the Transaction Management Service API.

 

Once a successful transaction processing response has been received, the Acknowledge operation can be called to set an IsAcknowledged flag to ‘true’ in the transaction database for a specific transactionId. In the event that a transaction response is not received, specific Transaction Management operations can be called to query the transaction database for transactions that have the IsAcknowledged flag set to ‘false’. This is helpful when troubleshooting the reason for a failed transaction.

For more information about transaction reporting and the Transaction Management Service API, refer to the Transaction Management Service Developer’s Guide

The QueryAccount operation is used to perform a balance inquiry on a cardholder’s account to determine the current account balance. It can also be used to perform a balance inquiry on pre-paid credit cards.

Note: The QueryAccount operation is specific to PIN Debit and pre-paid credit card balance inquiries only, based on service provider support.

The Disburse operation is used to submit a disbursement request to the service provider who then electronically disburses funds from the payer’s bank account to the payee’s account.

The Verify operation is used to verify information about a payment account, such as address verification data (AVSData) on a credit card account, without reserving any funds.

Note: The Verify operation is specific to Credit transactions only.

The RequestTransaction operation allows for the retrieval of any transaction matching the supplied tender data. This is useful in situations when the application does not receive a response from CWS indicating the TransactionState.

For more information, refer to Transaction and Capture States in the Transaction Management Developer’s Guide.
Note: Despite being optional operations, the boolean value indicating support for the Acknowledge, and RequestTransaction operations will not be returned in ServiceInformation.Operations.
IMPORTANT! All parameters in each operation are considered ‘required’ unless otherwise noted. For more information, refer to Transaction Processing Guidelines.

 

Best Practices

Below are some recommendations and best practices associated with the integration of the Transaction Processing operations:

  • Support for the operations above is determined based on the Service Information retrieved for the merchant Service Key when invoking the GetServiceInformation operation. When invoked, a Boolean property is returned indicating whether a specific transaction processing operation is supported for an available service.
  • As with Preparing the Application to Transact, serviceId, applicationProfileId, and merchantProfileId should be encrypted and stored locally rather than performing a value lookup for every transaction.
  • As a best practice, the application should track the time duration of the sessionToken. Prior to processing transactions, the application should reference the age of the current sessionToken. If the value is greater than 25 minutes, then a new call to SignOn should be made and the process of tracking the sessionToken repeated.
  • If the application will be supporting custom transaction processing workflows, you will send in the appropriate workflowId in all Transaction Processing operations. If the application is not supporting custom workflows, the application will send in the serviceId returned by the GetServiceInformation operation as the workflowId in each operation.
  • The Adjust, Undo, Capture, and ReturnById operations support differenceData, which allows for updates to transaction amounts in the event of incremental (INCAUTH) and reversal (REVAUTH) authorizations.
  • The following operations are considered optional and their implementation will depend on the specific requirements of the application:
    1. The Acknowledge operation can be invoked after the successful receipt of a transaction response message to flag a transaction as ‘acknowledged’ in the transaction database. This acknowledgement is useful when performing transaction management functions, such as those provided by theTransaction Management Service API.
    2. The RequestTransaction operation allows for the retrieval of any transaction matching the supplied tender data. This is useful in transaction-processing situations when the application does not receive a response from CWS indicating the TransactionState.

 

API Reference

For Supported Operation API reference information, click on the links below: