developer:soap-1.2:methods:deletemerchant

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.2:methods:deletemerchant [2010/02/12 11:42] (current)
hmcgowan created
Line 1: Line 1:
 +<embed ..:​contents/>​====== deleteMerchant ======
  
 +**Reseller only method.**
 +
 +Request deletion of merchant account.
 +
 +===== Description =====
 +
 +This method will flag a merchant for deletion. Once the deletion request is verified and approved by the gateway, the merchant account will be closed and the merchant will no longer be able to process transactions or log in to the Merchant Console.
 +
 +The reason argument should include any details, such as contact request details, reason for deletion, etc. that may speed up the deletion request verification process.
 +
 +See also [[addMerchantApplication]],​ [[getMerchantApplicationStatus]],​ [[getMerchant]],​ [[updateMerchant]],​ [[searchMerchants]],​ [[getMerchantSummary]] ​
 +
 +===== Syntax =====
 +
 +boolean **deleteMerchant** ( [[..:​objects:​ueSecurityToken]] Token, integer MerchantID, string Reason ) 
 +
 +
 +===== Arguments =====
 +
 +^Type    ^Name    ^Description ​   ^
 +|[[..:​objects:​ueSecurityToken]] |Token |Reseller security token, used to identify reseller and validate request.|
 +|integer |MerchantID |Merchant ID number assigned by the gateway to an active merchant|
 +|string |Reason |Any information relevant to the delete merchant account request. You may wish to include the following: contact request details, reason for deletion request, any other relevant information. |
 +
 +
 +
 +===== Return Value =====
 +
 +|boolean |Returns confirmation of your request only if successful. If request fails, an exception will be thrown. |
 +
 +===== Examples =====
 +
 +==== PHP ====
 +
 +For directions on how to set up the WSDL link, create "​$token"​ and "​$client",​ go to [[..:​howto:​php|PHP Soap How-to]].
 +
 +<code php>
 +<?​php ​
 +
 +try { 
 +
 +  $MerchantID=2; ​
 +  $Reason='​Testing Soap API'; ​    
 +
 +  $res=$client->​deleteMerchant($restoken,​$MerchantID,​$Reason); ​
 +  print_r($res); ​    
 +
 +  $this->​assertEquals($res,​true); ​
 +
 +  $this->​assertEquals($res->​Zip,​ '​12311'​); ​
 +
 +
 +
 +catch (SoapFault $e) { 
 +  echo $client->​__getLastRequest(); ​
 +  echo $client->​__getLastResponse(); ​
 +  die("​deleteMerchant failed: " .$e->​getMessage()); ​
 +
 +
 +?> 
 +</​code>​
developer/soap-1.2/methods/deletemerchant.txt ยท Last modified: 2010/02/12 11:42 by hmcgowan

Page Tools