Finxera

Back to documentation index

searchBancBoxPayees

Use the search BancBox payees API to search for a specific payee associated to Finxera.

Request Parameters

  Parameter Required Type Description
payeeName N String Payee name (Max length:45)
accountNumber N String Account number for the linked payee specified by the subscriber. (Max Length:45)
billerClass N String Biller Class
billerType N String Biller Type

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.
+ 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/v1/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/v1/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>sample@email.com</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">sample</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
      <sch:searchBancBoxPayees>
         <searchBancBoxPayeesRequest>
            <!--Optional:-->
            <payeeName>?</payeeName>
            <!--Optional:-->
            <accountNumber>?</accountNumber>
            <!--Optional:-->
            <billerClass>?</billerClass>
            <!--Optional:-->
            <billerType>?</billerType>
         </searchBancBoxPayeesRequest>
      </sch:searchBancBoxPayees>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<sch:searchBancBoxPayeesResponse>
          <return>
            <!--Optional:-->
            <requestId>?</requestId>
            <status>?</status>
             <!--Zero or more repetitions:-->
            <warnings>
               <!--Optional:-->
               <code>?</code>
               <!--Optional:-->
               <message>?</message>
            </warnings>
            <!--Zero or more repetitions:-->
            <errors>
               <!--Optional:-->
               <code>?</code>
               <!--Optional:-->
               <message>?</message>
            </errors>
            <!--Optional:-->
	   <bancBoxPayees> 
               <id></id> 
               <payeeName></payeeName> 
               <payeeAddress> 
                  <line1></line1> 
                  <city></city> 
                  <state></state> 
                  <zipcode></zipcode> 
               </payeeAddress> 
               <mask></mask> 
            </bancBoxPayees>
              <request>
               <payeeName>?</payeeName>
               <accountNumber>?</accountNumber>
               <billerClass>?</billerClass>
               <billerType>?</billerType>
            </request>

          </return>
</sch:searchBancBoxPayeesResponse>

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "payeeName": "",
    "accountNumber": ""
    "billerClass":"",
    "billerType":""
}

Sample Response

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