developer:soap:methods:getbatchuploadstatus

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
developer:soap:methods:getbatchuploadstatus [2008/03/13 12:01]
vladg
developer:soap:methods:getbatchuploadstatus [2009/07/24 17:26]
tem Renamed BatchNum parameter to UploadRefNum
Line 1: Line 1:
 +<embed ..:​contents/>​
 +
 ====== getBatchUploadStatus ====== ====== getBatchUploadStatus ======
  
Line 16: Line 18:
 ===== Syntax =====  ===== Syntax ===== 
  
-BatchUploadStatus **getBatchUploadStatus** ( [[developer:​soap:​objects:​ueSecurityToken]] Token, integer ​BatchNum ​+BatchUploadStatus **getBatchUploadStatus** ( [[..:​objects:​ueSecurityToken]] Token, integer ​UploadRefNum ​
  
  
Line 23: Line 25:
  
 ^Type   ​^Name ​  ​^Description ​  ^ ^Type   ​^Name ​  ​^Description ​  ^
-|[[developer:​soap:​objects:​ueSecurityToken]] |Token |Merchant security token: used to identify merchant and validate transaction.| +|[[..:​objects:​ueSecurityToken]] |Token |Merchant security token: used to identify merchant and validate transaction.| 
-|integer |BatchNum ​|A unique ​batch reference number assigned by the gateway.|+|integer |UploadRefNum ​|A unique ​upload ​reference number assigned by the gateway.|
  
  
 ===== Return Value ===== ===== Return Value =====
  
-|[[developer:​soap:​objects:​BatchUploadStatus]] |Returns the status of the currently running batch. Possible results include: open, closing, closed. |+|[[..:​objects:​BatchUploadStatus]] |Returns the status of the currently running batch. Possible results include: open, closing, closed. |
  
 ===== Examples ===== ===== Examples =====
Line 35: Line 37:
  
 ==== PHP ==== ==== 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> <code php>
 <?​php ​ <?​php ​
- 
-// for directions on how to set up the  ​ 
-// WSDL link and create "​$token"​ and "​$client," ​ 
-// see: http://​wiki.usaepay.com/​developer/​soap/​howto/​php ​ 
  
 try {  try { 
  
-    ​$batchnum='​127';​  +  ​$uploadrefnum='​127';​  
-    print_r($tran->​getBatchUploadStatus($sourcekey,​$batchnum)); +  print_r($tran->​getBatchUploadStatus($sourcekey,​$uploadrefnum));  
 + 
 +
  
-catch(SoapFault $e) { +catch(SoapFault $e) { 
            
-    ​echo $e->​getMessage();​  +  ​echo $e->​getMessage();​  
-    echo "​\n\nRequest:​ " . $tran->​__getLastRequest();​  +  echo "​\n\nRequest:​ " . $tran->​__getLastRequest();​  
-    echo "​\n\nResponse:​ " . $tran->​__getLastResponse(); ​+  echo "​\n\nResponse:​ " . $tran->​__getLastResponse(); ​
        
  
Line 80: Line 82:
 <​SourceKey xsi:​type="​xsd:​string">​HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</​SourceKey> ​ <​SourceKey xsi:​type="​xsd:​string">​HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</​SourceKey> ​
 </​Token> ​ </​Token> ​
-<BatchNum ​xsi:​type="​xsd:​integer">​288</​BatchNum+<UploadRefNum ​xsi:​type="​xsd:​integer">​288</​UploadRefNum
 </​ns1:​getBatchUploadStatus> ​ </​ns1:​getBatchUploadStatus> ​
 </​SOAP-ENV:​Body> ​ </​SOAP-ENV:​Body> ​
Line 87: Line 89:
  
  
 +===== Change History =====
  
 +^Version ^Change ^
 +|1.2 | Renamed BatchNum parameter to UploadRefNum |
 +|[[developer:​soap-1.1:​methods:​getbatchuploadstatus|1.1]] | Soap 1.1 Release |
  
  
developer/soap/methods/getbatchuploadstatus.txt · Last modified: 2009/07/24 17:26 by tem

Page Tools