developer:soap:methods:searchmerchantscustom

Differences

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

Link to this comparison view

Next revision
Previous revision
developer:soap:methods:searchmerchantscustom [2009/07/23 23:50]
tem created
developer:soap:methods:searchmerchantscustom [2009/07/27 08:24]
tem
Line 1: Line 1:
-<embed ..:contents />+<embed ..:​contents/>​
  
 ====== searchMerchantsCustom ====== ====== searchMerchantsCustom ======
Line 12: Line 12:
  
 See also [[getMerchant]],​ [[updateMerchant]],​ [[getMerchantSummary]],​ [[searchMerchantsCount]] See also [[getMerchant]],​ [[updateMerchant]],​ [[getMerchantSummary]],​ [[searchMerchantsCount]]
 +
 ===== Search Fields ===== ===== Search Fields =====
  
Line 20: Line 21:
   * Company ​   * Company ​
   * Street ​   * Street ​
-  * Street 2 +  * Street2 ​
   * City    * City 
   * State    * State 
Line 26: Line 27:
   * Email    * Email 
   * Fax    * Fax 
-  * Phone Number ​+  * Phone 
  
- 
-===== Return Fields ===== 
- 
-Fields that can be requested in the FieldList: 
- 
-  *transactiontype 
-  *response.authcode 
-  *response.avsresult 
-  *response.avsresultcode 
-  *response.batchnum 
-  *response.cardcoderesult 
-  *response.cardcoderesultcode 
-  *response.conversionrate 
-  *response.convertedamount 
-  *response.convertedamountcurrency 
-  *response.error 
-  *response.errorcode 
-  *response.refnum 
-  *response.result 
-  *response.resultcode 
-  *response.status 
-  *response.statuscode 
- 
-  *checktrace.trackingnum 
-  *checktrace.effective 
-  *checktrace.processed 
-  *checktrace.settled 
-  *checktrace.returned 
-  *checktrace.banknote 
-  *datetime 
-  *accountholder 
- 
-  *details.invoice 
-  *details.ponum 
-  *details.orderid 
-  *details.clerk 
-  *details.terminal 
-  *details.table 
-  *details.description 
-  *details.amount 
-  *details.currency 
-  *details.tax 
-  *details.tip 
-  *details.nontax 
-  *details.shipping 
-  *details.discount 
-  *details.subtotal 
- 
-  *creditcarddata.cardtype 
-  *creditcarddata.cardnumber 
-  *creditcarddata.cardexpiration 
-  *creditcarddata.cardcode 
-  *creditcarddata.avsstreet 
-  *creditcarddata.avszip 
-  *creditcarddata.cardpresent 
-  *checkdata.checknumber 
-  *checkdata.routing 
-  *checkdata.account 
-  *checkdata.ssn 
-  *checkdata.driverslicense 
-  *checkdata.driverslicensestate 
-  *checkdata.recordtype 
-  *user 
-  *source 
-  *serverip 
-  *clientip 
-  *customerid 
-  *billingaddress.firstname 
-  *billingaddress.lastname 
-  *billingaddress.company 
-  *billingaddress.street 
-  *billingaddress.street2 
-  *billingaddress.city 
-  *billingaddress.state 
-  *billingaddress.zip 
-  *billingaddress.country 
-  *billingaddress.phone 
-  *billingaddress.fax 
-  *billingaddress.email 
-  *shippingaddress.firstname 
-  *shippingaddress.lastname 
-  *shippingaddress.company 
-  *shippingaddress.street 
-  *shippingaddress.street2 
-  *shippingaddress.city 
-  *shippingaddress.state 
-  *shippingaddress.zip 
-  *shippingaddress.country 
-  *shippingaddress.phone 
-  *shippingaddress.fax 
-  *shippingaddress.email 
  
 ===== Syntax ===== ===== Syntax =====
  
-string **searchTransactionsCustom** (  +string **searchMerchants** ( [[..:​objects:​ueSecurityToken]] Token, [[..:​objects:​SearchParam]] Search, boolean MatchAll, integer Start, integer Limit, string FieldList, string Format, string Sort) 
-[[..:​objects:​ueSecurityToken]] Token, ​ +
-[[..:​objects:​SearchParam]] Search, ​ +
-boolean MatchAll, ​ +
-integer Start, integer Limit, string FieldList, string Format, string Sort ) +
  
 ===== Arguments ===== ===== Arguments =====
  
 ^Type   ​^Name ​  ​^Description ​  ^ ^Type   ​^Name ​  ​^Description ​  ^
-| [[..:​objects:​ueSecurityToken]] | Token  |Merchant ​security tokenused to identify ​merchant ​and validate ​transaction. | +|[[..:​objects:​ueSecurityToken]] |Token |Reseller ​security tokenused to identify ​reseller ​and validate ​request.| 
-| [[..:​objects:​SearchParam]] ​ | Search ​ | Array of search parameters ​(SearchParam objects) available. | +|[[..:​objects:​SearchParam]] |Search |Array of search parameters.| 
-| boolean | MatchAll | If set to "​true,"​ only results matching all search criteria will be returned, if set to "​false,"​ results matching any of the search criteria will be returned. | +|boolean |MatchAll |If set to "​true,"​ only results matching all search criteria will be returned, if set to "​false,"​ results matching any of the search criteria will be returned.| 
-| integer | Start | Sequence number ​to start returning on. | +|integer |Start |Start position, defaults ​to 0 (first merchant found).| 
-| integer | Limit | Maximum number of transactions ​to return in result ​set. | +|integer |Limit |Maximum number of merchants ​to return in result. | 
-| string ​ | FieldList | String Array of fields to return in search. | +|string ​ |FieldList | String Array of fields to return in search. | 
-| string ​ | Format | Specify format of return data. Possible formats include: csv, tab, xml. | +|string ​ |Format | Specify format of return data. Possible formats include: csv, tab, xml. | 
-| string ​ | Sort | Field name to sort search ​results |+|string |Sort |Field name to sort the results ​by | 
  
  
 ===== Return Value ===== ===== Return Value =====
  
-| string | Base64 encode result set. Returns all of the fields from any transactions ​matching your search parameters. | +| string | Base64 encode result set. Returns all of the fields from any merchants ​matching your search parameters. | 
  
  
Line 149: Line 56:
  
  
-==== PHP ==== 
- 
-For directions on how to set up the WSDL link, create "​$token"​ and "​$client",​ go to [[developer:​soap:​howto:​php|PHP Soap How-to]]. 
- 
-<code php> 
-<?​php ​ 
- 
-try {  
- 
-// make sure you prep data to search on  
- 
-  $search=array( ​ 
-    array( ​ 
-      '​Field'​=>'​amount',  ​ 
-      '​Type'​=>'​eq', ​ 
-      '​Value'​=>'​3.83'​), ​ 
-    array( ​ 
-      '​Field'​=>'​created',  ​ 
-      '​Type'​=>'​gt',  ​ 
-      '​Value'​=>'​2007-05-09'​), ​ 
-    array( ​ 
-      '​Field'​=>'​created',  ​ 
-      '​Type'​=>'​lt',  ​ 
-      '​Value'​=>'​2007-05-22'​), ​ 
-    array( ​ 
-      '​Field'​=>'​response',  ​ 
-      '​Type'​=>'​eq',  ​ 
-      '​Value'​=>'​A'​) ​ 
-    );  
- 
-  $start=0; ​ 
-  $limit=100; ​ 
-  $matchall=true; ​ 
- 
-  $fieldList=array( ​ 
-    '​Details.Amount',  ​ 
-    '​AccountHolder',  ​ 
-    '​CheckTrace.TrackingNum'​); ​ 
- 
-  $format ='​csv'; ​ 
-  ​ 
-  $res=$client->​searchTransactionsCustom($token,​$search,​$matchall,​$start,​$limit,​$fieldList,​$format); ​ 
- 
-  $res=base64_decode($res); ​ 
-  print_r($res); ​ 
-              
- 
- 
-catch(SoapFault $e) {  
-  echo $client->​__getLastResponse(); ​ 
-  die("​Serach Transaction Failed :"​.$e->​getMessage()); ​ 
-  }  
- 
-?>  
-</​code>​ 
- 
-==== VB.Net ==== 
- 
-<code vb> 
-        ' instantiate client 
-        Dim client As usaepay.usaepayService = New usaepay.usaepayService 
- 
-        ' build security token using sourcekey and pin 
-        Dim token As usaepay.ueSecurityToken 
-        token = Me.CreateToken("​982lz9VsLm87MA54Sv8E582h8OZMArL6",​ "​443311"​) 
- 
-        ' Search type is AND  (all search parameters must be matched) 
-        Dim MatchAll As Boolean 
-        MatchAll = True 
- 
-        ' List of search parameters 
-        Dim searchParams(1) As usaepay.SearchParam 
-        searchParams(0) = New usaepay.SearchParam 
-        searchParams(0).Field = "​Created"​ 
-        searchParams(0).Type = "​gt"​ 
-        searchParams(0).Value = "​2009-05-13 00:​00:​00"​ 
-        searchParams(1) = New usaepay.SearchParam 
-        searchParams(1).Field = "​reccustid"​ 
-        searchParams(1).Type = "​gt"​ 
-        searchParams(1).Value = "​0"​ 
- 
-        ' Result Record to start on 
-        Dim start As Integer 
-        start = 1 
- 
-        ' List of fields to return 
-        Dim FieldList(2) As String 
-        FieldList(0) = "​Response.RefNum"​ 
-        FieldList(1) = "​Response.ResultCode"​ 
-        FieldList(2) = "​CustomerID"​ 
- 
-        ' limit to 10 results 
-        Dim limit As Integer 
-        limit = "​10"​ 
- 
-        Dim SearchResults As String 
-        SearchResults = client.searchTransactionsCustom(token,​ searchParams,​ MatchAll, 0, 1000, FieldList, "​csv"​) 
- 
-        ' results are base64 encode 
-        Dim binaryData() As Byte 
-        binaryData = Convert.FromBase64String(SearchResults) 
-        MsgBox(Encoding.UTF8.GetString(binaryData)) 
-</​code>​ 
  
-==== XML ====+===== Change History =====
  
-<code xml> +^Version ^Change ^ 
-<?xml version="​1.0" encoding="​UTF-8"?>​  +|1.2 | Method added in soap 1.2 release |
-<​SOAP-ENV:​Envelope xmlns:​SOAP-ENV="​http://​schemas.xmlsoap.org/​soap/​envelope/"​  +
-xmlns:​ns1="​urn:​usaepay"​ xmlns:​xsd="​http://​www.w3.org/​2001/​XMLSchema"​  +
-xmlns:​xsi="​http://​www.w3.org/​2001/​XMLSchema-instance"​  +
-xmlns:​SOAP-ENC="​http://​schemas.xmlsoap.org/​soap/​encoding/"​  +
-SOAP-ENV:​encodingStyle="​http://​schemas.xmlsoap.org/​soap/​encoding/">​  +
-<​SOAP-ENV:​Body>​  +
-<​ns1:​searchTransactionsCustom>​  +
-<Token xsi:​type="​ns1:​ueSecurityToken">​  +
-<​ClientIP xsi:​type="​xsd:​string">​192.168.0.1</​ClientIP>​  +
-<PinHash xsi:​type="​ns1:​ueHash">​  +
-<​HashValue xsi:​type="​xsd:​string">​c5948b425ee3593afc689aa4129b580e64d28fa3</​HashValue>​  +
-<Seed xsi:​type="​xsd:​string">​11936964681053228515</​Seed>​  +
-<Type xsi:​type="​xsd:​string">​sha1</​Type>​  +
-</​PinHash>​  +
-<​SourceKey xsi:​type="​xsd:​string">​HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</​SourceKey>​  +
-</​Token>​  +
-<Search SOAP-ENC:​arrayType="​ns1:​SearchParam[1]"​ xsi:​type="​ns1:​SearchParamArray">​  +
-<item xsi:​type="​ns1:​SearchParam">​  +
-<Field xsi:​type="​xsd:​string">​amount</​Field>​  +
-<Type xsi:​type="​xsd:​string">​eq</​Type>​  +
-<Value xsi:​type="​xsd:​string">​29.00</​Value>​  +
-</​item>​  +
-</​Search>​  +
-<​MatchAll xsi:​type="​xsd:​boolean">​true</​MatchAll>​  +
-<Start xsi:​type="​xsd:​integer">​0</​Start>​  +
-<Limit xsi:​type="​xsd:​integer">​10</​Limit>​  +
-<​FieldList SOAP-ENC:​arrayType="​xsd:​string[5]"​ xsi:​type="​ns1:​stringArray">​  +
-<item xsi:​type="​xsd:​string">​Response.AvsResult</​item>​  +
-<item xsi:​type="​xsd:​string">​Response.AvsResultCode</​item>​  +
-<item xsi:​type="​xsd:​string">​DateTime</​item>​  +
-<item xsi:​type="​xsd:​string">​Response.Error</​item>​  +
-<item xsi:​type="​xsd:​string">​Details.Invoice</​item>​  +
-</​FieldList>​  +
-<Format xsi:​type="​xsd:​string">​xml</​Format>​  +
-</​ns1:​searchTransactionsCustom>​  +
-</​SOAP-ENV:​Body>​  +
-</​SOAP-ENV:​Envelope>​  +
-</​code>​+
  
developer/soap/methods/searchmerchantscustom.txt · Last modified: 2009/07/27 08:24 by tem

Page Tools