SOAP API Reference

Refund Transaction

Contents: Click on one of the following topics to learn more!

 

ReturnById

The ReturnById operation is used to perform a linked credit to a cardholder’s account from the merchant’s account based on a previously authorized and settled transaction.

Note: In the Return differenceData object, the Amount parameter represents the amount to be credited back to the cardholder. For example:
Captured Amount = $10.00; ReturnById Amount = $4.00; Settled Amount = $6.00 ($4.00 was returned to the customer, $6.00 remains in the merchant account) Captured Amount = $10.00; ReturnById Amount = $12.00
ERROR: Cannot return for more than the original captured amount.

Operation

Parameters

Parameter Data Type Description
sessionToken String The limited-life token used to authenticate to CWS.
differenceData Return Contains the return details based on the original authorized and captured amount.Note: You must send in BankcardReturn for Bankcard transactions.
applicationProfileId String A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation.
workflowId String Identifies the workflow to use for the transaction. If not supporting custom workflows, pass the serviceId returned by GetServiceInformation.

Return Type

Data Type Description
Response Transaction response data.Note: For Bankcard (BCP) transactions, the response object is BankcardTransactionResponsePro.

Exceptions

CWSFault CWSInvalidOperationFault
AuthenticationFault CWSInvalidServiceInformationFault
ExpiredTokenFault CWSOperationNotSupportedFault
InvalidTokenFault CWSTransactionAlreadySettledFault
CWSConnectionFault CWSTransactionFailedFault
CWSExtendedDataNotSupportedFault CWSTransactionServiceUnavailableFault
CWSInvalidMessageFormatFault CWSValidationResultFault
For additional details about each fault, refer to Transaction Processing Faults in the CWS Developer API Reference.

 

Code Snippets

C#

PHP

Back to the top
 

ReturnUnlinked

The ReturnUnlinked operation is used to perform an “unlinked”, or standalone, credit to a cardholder’s account from the merchant’s account. This operation is useful when a return transaction is not associated with a previously authorized and settled transaction.

Operation

Parameters

Parameter Data Type Description
sessionToken String The limited-life token used to authenticate to CWS.
transaction Transaction Transaction detail data.Note: You must send in BankcardTransaction for Bankcard transactions.
applicationProfileId String A token representing the PTLS Socket ID unique to each Service Key and
configuration data combination. Returned by the SaveApplicationData operation.
merchantProfileId String The specific Merchant Profile Identifier to use.
workflowId String Identifies the workflow to use for the transaction. If not supporting custom
workflows, pass the serviceId returned by GetServiceInformation.

Return Type

Data Type Description
Response Transaction response data.Note: For Bankcard (BCP) transactions, the response object is BankcardTransactionResponsePro.

Exceptions

CWSFault CWSInvalidOperationFault
AuthenticationFault CWSInvalidServiceInformationFault
ExpiredTokenFault CWSOperationNotSupportedFault
InvalidTokenFault CWSTransactionAlreadySettledFault
CWSConnectionFault CWSTransactionFailedFault
CWSExtendedDataNotSupportedFault CWSTransactionServiceUnavailableFault
CWSInvalidMessageFormatFault CWSValidationResultFault
For additional details about each fault, refer to Transaction Processing Faults in the CWS Developer API Reference.

 

Code Snippets

C#

PHP

Back to the top