Finxera

Back to documentation index

searchBancBoxPayees

Use the search BancBox payees API to search for a specific payee associated to Finxera.The searchBancboxPayees API supports pagination

Request Parameters

  Parameter Required Type Description
payeeName N String Payee name (Max length:45)
billerClass N String Biller Class
billerType N String Biller Type
accountNumber N String Account number for the linked payee specified by the subscriber. (Max Length:45)
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.
status   Int Status of completed request, either 1 for pass, or 0 for fail.
currentPage   Int Current Page Number
totalPages   Int Total pages in the response
totalRecords   Int Total no of records in the response
+ warnings   Object A Warning object containing a code and description.
+ errors   Object Request failed, error response.
+ bancBoxPayees   Object Response parameter gives details on specified payee.
+ request   Object Request

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/>
   <soapenv:Body>
      <sch:searchBancBoxPayees>
         <searchBancBoxPayeesRequest>
            <!--Optional:-->
            <payeeName>?</payeeName>
            <!--Optional:-->
            <accountNumber>?</accountNumber>
            <!--Optional:-->
            <billerClass>?</billerClass>
            <!--Optional:-->
            <billerType>?</billerType>
            <!--Optional:-->
            <ascending>false</ascending>
            <!--Optional:-->
            <pageNo>?</pageNo>
            <!--Optional:-->
            <resultsPerPage>?</resultsPerPage>
         </searchBancBoxPayeesRequest>
      </sch:searchBancBoxPayees>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<sch:searchBancBoxPayeesResponse> 
             <requestId></requestId> 
             <status></status> 
            <currentPage></currentPage> 
            <totalPages></totalPages> 
            <totalRecords></totalRecords> 
            <bancBoxPayees> 
               <id></id> 
               <payeeName> </payeeName> 
               <payeePrevName> </payeePrevName> 
               <payeeAKA> </payeeAKA> 
               <payeeAddress> 
                  <line1> </line1> 
                  <city> </city> 
                  <state> </state> 
                  <zipcode></zipcode> 
               </payeeAddress> 
               <mask></mask> 
            </bancBoxPayees> 
 <request>
<payeeName> </payeeName> 
<accountNumber></accountNumber >
<billerClass></billerClass >
<billerType></billerType>
            </request> 
           </return> 
       </ns1:searchBancBoxPayeesResponse> 
    </soap:Body> 
 </soap:Envelope>

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "payeeName": "",
    "accountNumber": "",
    "billerClass":"",
    "billerType":"",
    "ascending":"false", 
    "pageNo":"",
    "resultsPerPage": ""
}

Sample Response

{
    "currentPage": ?,
    "totalPages": ?,
    "totalRecords": ?,
    "bancBoxPayees" : [ { 
     "id" : ?, 
     "payeeName" : "?", 
     "payeePrevName" : "?", 
     "payeeAKA" : "?", 
     "payeeAddress" : { 
       "line1" : "?", 
       "city" : "?", 
       "state" : "?", 
       "zipcode" : "?" 
     }, 
     "mask" : "?" 
   }], 
   "request" : { 
     "payeeName" : "?", 
     "accountNumber" : "?" ,
     "billerClass":"",
     "billerType":""
      
   }, 
   "requestId" : ?, 
   "status" : ?, 
   "warnings" : [ { 
     "code" : "?", 
     "message" : "?" 
   } ], 
   "errors" : [ { 
     "code" : "?", 
     "message" : "?" 
   } ] 
 }

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