SOAP API Reference

Manage Merchant Profiles

 

 

IsMerchantProfileInitialized

The IsMerchantProfileInitialized operation can be used to verify that a specific Merchant Profile has been saved at least once, or “initialized”, for a specific Tender Type.

Operation

Parameters

Parameter Data Type Description
sessionToken String The limited-life token used to authenticate to CWS.
serviceId String Unique identifier for available services returned in the ServiceInformation object when invoking the GetServiceInformation operation.
merchantProfileId String The specific Merchant Profile to verify.
tenderType TenderType The tender type associated with the Merchant Profile.

Return Type

Data Type Description
Boolean Returns ‘true’ if the Merchant Profile has been initialized.

Exceptions

CWSFault AuthenticationFault
ExpiredTokenFault CWSServiceInformationUnavailableFault
InvalidTokenFault CWSValidationResultFault
For additional details about each fault, refer to Service Information Faults in the CWS Developer API Reference.

 

Code Snippets

C#

PHP

Note: The HTTP Authorization Header must contain the required sessionToken value.

Back to the top
 

GetMerchantProfile

The GetMerchantProfile operation retrieves a specific Merchant Profile and associated profile data (MerchantProfile) for a specific Service ID and Tender Type. To retrieve all profiles in a list, refer to the GetMerchantProfiles operation.

Operation

Parameters

Parameter Data Type Description
sessionToken String The limited-life token used to authenticate to CWS.
merchantProfileId String The specific Merchant Profile to retrieve.
serviceId String Unique identifier for available services returned in the ServiceInformation object when invoking the GetServiceInformation operation.
Note: Not specifying the serviceId will return all merchantProfileIds associated with all serviceIds.
tenderType <codeTenderType The tender type associated with the Merchant Profile.

Return Type

Data Type Description
MerchantProfile The requested Merchant Profile and associated profile data.

Exceptions

CWSFault AuthenticationFault
ExpiredTokenFault CWSServiceInformationUnavailableFault
InvalidTokenFault CWSValidationResultFault
For additional details about each fault, refer to Service Information Faults in the CWS Developer API Reference.

 

Code Snippets

PHP

Back to the top
 

GetMerchantProfiles

The GetMerchantProfiles operation retrieves all merchantProfileId‘s and associated profile data (MerchantProfile) for a specific Service ID and Tender Type. This is useful in multi-merchant application scenarios to allow for the update of a specific Merchant Profile by passing the merchantProfileId with the GetMerchantProfile operation.

Operation

Parameters

Parameter Data Type Description
sessionToken String The limited-life token used to authenticate to CWS.
serviceId String Unique identifier for available services returned in the ServiceInformation object when invoking the GetServiceInformation operation.
Note: Not specifying the serviceId will return all merchantProfileIds associated with all serviceIds.
tenderType <code”>TenderType The tender type associated with the Merchant Profile.

Return Type

Data Type Description
List<MerchantProfile> A collection of Merchant Profiles with associated profile data.

Exceptions

CWSFault AuthenticationFault
ExpiredTokenFault CWSServiceInformationUnavailableFault
InvalidTokenFault CWSValidationResultFault
For additional details about each fault, refer to Service Information Faults in the CWS Developer API Reference.

 

Code Snippets

C#

PHP

Back to the top
 

GetMerchantProfileIds

The GetMerchantProfileIds operation retrieves a list of all merchantProfileId’s associated with a specific Service ID and Tender Type, without returning any merchant profile data (MerchantProfile).
Once retrieved, the application should invoke either GetMerchantProfile or GetMerchantProfiles to retrieve profile data associated with specific merchantProfileId’s.

Operation

Parameters

Parameter Data Type Description
sessionToken String The limited-life token used to authenticate to CWS.
serviceId String Unique identifier for available services returned in the ServiceInformation object when invoking the GetServiceInformation operation.
Note: Not specifying the serviceId will return all merchantProfileIds associated with
all serviceIds.
tenderType TenderType The tender type associated with the Merchant Profile.

Return Type

Data Type Description
List<String> A list of Merchant Profiles only.

Exceptions

CWSFault AuthenticationFault
ExpiredTokenFault CWSServiceInformationUnavailableFault
InvalidTokenFault CWSValidationResultFault
For additional details about each fault, refer to Service Information Faults in the CWS Developer API Reference.

 

Code Snippets

None

Back to the top
 

GetMerchantProfilesById

The GetMerchantProfilesByProfileId operation retrieves all merchant specific Merchant Profiles and associated profile data (MerchantProfile) by merchantProfileid.

Operation

Parameters

Parameter Data Type Description
sessionToken String The limited-life token used to authenticate to CWS.
merchantProfileId String The specific merchant profile to retrieve.

Return Type

Data Type Description
List<String> MerchantProfile A list of merchant specific Merchant Profiles with associated profile data.

Exceptions

CWSFault AuthenticationFault
ExpiredTokenFault CWSServiceInformationUnavailableFault
InvalidTokenFault CWSValidationResultFault
For additional details about each fault, refer to Service Information Faults in the CWS Developer API Reference.

 

Code Snippets

None

Back to the top