Finxera

Back to documentation index

searchMerchants

Use searchMerchants to lookup merchants under a particular subscriber. You can use a BancBox issued subscriber ID, your own reference identifier, or even date range on when the merchant was created or updated

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when BancBox account is created
+ linkedClientId N Object Specify either the bancBoxId or subscriberReferenceId parameter.
merchantFirstName N Char Enter First Name (Max Length 20)
merchantLastName N Char Enter Last Name (Max Length 20)
merchantTaxId N String Enter the Tax ID(Max Length 9)
createdOnFromDate N dateTime created On From Date[YYYY-MM-DDTHH:MM:S] "T" is not a number value, it is the letter "T"
createdOnToDate N dateTime created On To Date[YYYY-MM-DDTHH:MM:S] "T" is not a number value, it is the letter "T"
modifiedOnFromDate N dateTime modified On From Date[YYYY-MM-DDTHH:MM:S] "T" is not a number value, it is the letter "T"
modifiedOnToDate N dateTime modified On To Date[YYYY-MM-DDTHH:MM:S] "T" is not a number value, it is the letter "T"
ascending N Boolean Results listed in ascending order {true} or descending order {false}
pageNo N Int Page number of the list, see resultsPerPage.
resultsPerPage N Int Specify how many results would be listed in a page

Response Parameters

  Parameter   Type Description
requestId   Long 13 digit ID for the API request being made
currentPage   Int Current Page Number
totalPages   Int Total pages in the response
totalRecords   Int Total no of records in the response
+ merchants   Object Merchant details
+ bankBusinessAccount   Object Bank business account details
createdOn   datetime Created on Date
createdBy   String Created By

WSDL URL (Production) :  https://api.bancbox.com/v3/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/v3/BBXPort?wsdl

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
  <soapenv:Header>
     <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="XWSSGID-1261544568770-474929336" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
           <wsse:Username>PSP@bancbox.com</wsse:Username>
           <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">abcd1234</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security></soapenv:Header>
   <soapenv:Body>
      <sch:searchMerchants>
         <searchMerchantsRequest>
            <subscriberId>200134</subscriberId>
            <!--Optional:-->
            <linkedClientId>
               
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </linkedClientId>
            <!--Optional:-->
            <merchantFirstName>?</merchantFirstName>
            <!--Optional:-->
            <merchantLastName>?</merchantLastName>
            <!--Optional:-->
            <merchantTaxId>?</merchantTaxId>
            <!--Optional:-->
            <createdOnFromDate>?</createdOnFromDate>
            <!--Optional:-->
            <createdOnToDate>?</createdOnToDate>
            <!--Optional:-->
            <modifiedOnFromDate>?</modifiedOnFromDate>
            <!--Optional:-->
            <modifiedOnToDate>?</modifiedOnToDate>
            <!--Optional:-->
            <ascending>false</ascending>
            <!--Optional:-->
            <pageNo>?</pageNo>
            <!--Optional:-->
            <resultsPerPage>?</resultsPerPage>
         </searchMerchantsRequest>
      </sch:searchMerchants>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:searchMerchantsResponse xmlns:ns1="schema.bancbox.com">
         <searchMerchantsResponse xsi:type="ns3:searchMerchantsResponse" xmlns:ns3="schema.bancbox.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <requestId>?</requestId>
            <status>?</status>
            <currentPage>?</currentPage>
            <totalPages>?</totalPages>
            <totalRecords>?</totalRecords>
            <merchants>
               <firstName>?</firstName>
               <lastName>?</lastName>
               <ssn>?</ssn>
               <dob>?</dob>
               <address>
                  <address1>?</address1>
                  <address2>?</address2>
                  <city>?</city>
                  <state>?</state>
                  <zipcode>?</zipcode>
               </address>
               <email>?</email>
               <bankBusinessAccount>
                  <routingNumber>?</routingNumber>
                  <accountNumber>?</accountNumber>
                  <holderName>?</holderName>
                  <bankAccountType>?</bankAccountType>
               </bankBusinessAccount>
               <modifiedOn>?</modifiedOn>
               <modifiedBy>?</modifiedBy>
               <createdOn>?</createdOn>
               <createdBy>?</createdBy>
            </merchants>
                        <merchants>
               <firstName>?</firstName>
               <lastName>?</lastName>
               <ssn>?</ssn>
               <dob>?</dob>
               <address>
                  <address1>?</address1>
                  <address2>?</address2>
                  <city>?</city>
                  <state>?</state>
                  <zipcode>?</zipcode>
               </address>
               <email>?</email>
               <bankBusinessAccount>
                  <routingNumber>?</routingNumber>
                  <accountNumber>?</accountNumber>
                  <holderName>?</holderName>
                  <bankAccountType>?</bankAccountType>
               </bankBusinessAccount>
               <modifiedOn>?</modifiedOn>
               <modifiedBy>?</modifiedBy>
               <createdOn>?</createdOn>
               <createdBy>?</createdBy>
            </merchants>
                        <merchants>
               <firstName>?</firstName>
               <lastName>?</lastName>
               <ssn>?</ssn>
               <dob>?</dob>
               <address>
                  <address1>?</address1>
                  <address2>?</address2>
                  <city>?</city>
                  <state>?</state>
                  <zipcode>?</zipcode>
               </address>
               <email>?</email>
               <bankBusinessAccount>
                  <routingNumber>?</routingNumber>
                  <accountNumber>?</accountNumber>
                  <holderName>?</holderName>
                  <bankAccountType>?</bankAccountType>
               </bankBusinessAccount>
               <modifiedOn>?</modifiedOn>
               <modifiedBy>?</modifiedBy>
               <createdOn>?</createdOn>
               <createdBy>?</createdBy>

Note:For REST, Content-type should be set to application/json
URL (Production) :  https://api.bancbox.com/v3/BBXPortRest/searchMerchants
URL (SandBox) :  https://sandbox-api.bancbox.com/v3/BBXPortRest/searchMerchants

Sample Request

{
    "authentication": 
    {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    
    "subscriberId": "",

    "linkedClientId":
    {

       "bancBoxId":"",
       
       "subscriberReferenceId":""

    },

    "merchantFirstName":"",

    "merchantLastName":"",

    "merchantTaxId":"",

    "createdOnFromDate":"",

    "createdOnToDate":"",

    "modifiedOnFromDate":"",

    "modifiedOnToDate":"",

    "ascending":"",

    "pageNo:"",

    "resultsPerPage":""
   
}

Sample Response

{
   "currentPage": "?",
   "totalPages": "?",
   "totalRecords": "?",
   "merchants":    [
            {
         "firstName": "?",
         "lastName": "?",
         "ssn": "?",
         "dob": "?",
         "address":          {
            "address1": "?",
            "city": "?",
            "state": "?",
            "zipcode": "?"
         },
         "bankBusinessAccount":          {
            "routingNumber": "?",
            "accountNumber": "?",
            "holderName": "?",
            "bankAccountType": "?"
         },
         "createdOn": "?",
         "createdBy": "?"
      },
            {
         "firstName": "?",
         "lastName": "?",
         "ssn": "?",
         "dob": "?",
         "address":          {
            "address1": "?",
            "city": "?",
            "state": "?",
            "zipcode": "?"
         },
         "bankBusinessAccount":          {
            "routingNumber": "?",
            "accountNumber": "?",
            "holderName": "?",
            "bankAccountType": "?"
         },
         "createdOn": "?",
         "createdBy": "?"
      },
           {
         "firstName": "?",
         "lastName": "?",
         "ssn": "?",
         "dob": "?",
         "address":          {
            "address1": "?",
            "city": "?",
            "state": "?",
            "zipcode": "?"
         },
         "bankBusinessAccount":          {
            "routingNumber": "?",
            "accountNumber": "?",
            "holderName": "?",
            "bankAccountType": "?"
         },
         "createdOn": "?",
         "createdBy": "?"
      },
            
   ],
   "requestId": "",
   
"warnings" : [{
        "code": "?",
        "message": "?"
    }],
    "errors": [{
        "code": "?",
        "message": "?"
    }]
}

Note: This is a beta version. The api listed here are likely to change.