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)

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/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/BBXPort?wsdl

Sample Request

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:sch="schema.bancbox.com"><soapenv:Header><wsse:Securitysoapenv:mustUnderstand="1"xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><wsse:UsernameTokenwsu:Id="XWSSGID-1261544568770-474929336"xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"><wsse:Username>ORCC09</wsse:Username><wsse:PasswordType="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:searchBancBoxPayees><searchBancBoxPayeesRequest><!--Optional:--><payeeName>ALLI</payeeName><!--Optional:--><accountNumber>4053731234567890</accountNumber><!--Optional:--></searchBancBoxPayeesRequest></sch:searchBancBoxPayees></soapenv:Body></soapenv:Envelope>

Sample Response

<soap:Envelopexmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns1:searchBancBoxPayeesResponsexmlns:ns1="schema.bancbox.com"><returnxsi:type="ns3:searchBancBoxPayeesResponse"xmlns:ns3="schema.bancbox.com"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><requestId>1396257754688</requestId><status>1</status><currentPage>1</currentPage><totalPages>1</totalPages><totalRecords>9</totalRecords><bancBoxPayees><id>22982</id><payeeName>THEEVANGELICALALLIANCEMISSION</payeeName><payeeAddress><line1>POBOX969</line1><city>WHEATON</city><state>IL</state><zipcode>60189</zipcode></payeeAddress><mask>@@@@@@@@@@@@@@@@</mask></bancBoxPayees><bancBoxPayees><id>22981</id><payeeName>THEEVANGELICALALLIANCEMISSION</payeeName><payeeAddress><line1>POBOX969</line1><city>WHEATON</city><state>IL</state><zipcode>60187</zipcode></payeeAddress><mask>@@@@@@@@@@@@@@@@</mask></bancBoxPayees><bancBoxPayees><id>22980</id><payeeName>THEEVANGELICALALLIANCEMISSION</payeeName><payeeAddress><line1>400SMAINPLACE</line1><city>CAROLSTREAM</city><state>IL</state><zipcode>60188</zipcode></payeeAddress><mask>@@@@@@@@@@@@@@@@</mask></bancBoxPayees><bancBoxPayees><id>13442</id><payeeName>HEALTHALLIANCEPLAN</payeeName><payeeAddress><line1>POBOX55000</line1><city>DETROIT</city><state>MI</state><zipcode>48255</zipcode></payeeAddress><mask>@@@@@@@@@@@@@@@@</mask></bancBoxPayees><bancBoxPayees><id>13441</id><payeeName>HEALTHALLIANCEPLAN</payeeName><payeeAddress><line1>DEPT271101</line1><city>DETROIT</city><state>MI</state><zipcode>48255</zipcode></payeeAddress><mask>@@@@@@@@@@@@@@@@</mask></bancBoxPayees><bancBoxPayees><id>1024</id><payeeName>ALLIANTCUCREDITCARDS</payeeName><payeeAddress><line1>POBOX66945</line1><city>CHICAGO</city><state>IL</state><zipcode>60666</zipcode></payeeAddress><mask>405373##########</mask></bancBoxPayees><bancBoxPayees><id>1023</id><payeeName>ALLIANTCUCREDITCARDS</payeeName><payeeAddress><line1>POBOX2387</line1><city>DESPLAINES</city><state>IL</state><zipcode>60017</zipcode></payeeAddress><mask>405373##########</mask></bancBoxPayees><bancBoxPayees><id>1022</id><payeeName>ALLIANTCUCREDITCARDS</payeeName><payeeAddress><line1>11545WTOUHYAVENUE</line1><city>CHICAGO</city><state>IL</state><zipcode>60666</zipcode></payeeAddress><mask>405373##########</mask></bancBoxPayees><bancBoxPayees><id>1010</id><payeeName>ALLIANCE</payeeName><payeeAddress><line1>POBOX64803</line1><city>PHOENIX</city><state>AZ</state><zipcode>85082</zipcode></payeeAddress><mask>@@@@@@@@@@@@@@@@</mask></bancBoxPayees><request><payeeName>ALLI</payeeName><accountNumber>4053731234567890</accountNumber></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/BBXPortRest/searchBancBoxPayees
URL (SandBox) :  https://sandbox-api.bancbox.com/BBXPortRest/searchBancBoxPayees

Sample Request

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

Sample Response

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