Finxera

Back to documentation index

getClientAccounts

Use the getClientAccounts method to get a list of all the Finxera accounts created under a specific client.The getClientAccounts API supports pagination.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
+ clientId Y Object Specify either the bancBoxId or subscriberReferenceId parameter.
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.
+ warnings   Object A Warning object containing a code and description.
+ errors   Object Request failed, error response.
+ clientId   Object Client Id
+ accounts   Object This lists all the Finxera accounts and their details under the specified client..
currentPage   Int Current Page Number
totalPages   Int Total pages in the response
totalRecords   Int Total no of records in the response

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:getClientAccounts>
         <getClientAccountsRequest>
            <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Optional:-->
            <ascending>false</ascending>
            <!--Optional:-->
            <pageNo>?</pageNo>
            <!--Optional:-->
            <resultsPerPage>?</resultsPerPage>
         </getClientAccountsRequest>
      </sch:getClientAccounts>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
   <soapenv:Header/>
   <soapenv:Body>
      <sch:getClientAccountsResponse>
         <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:-->
            <currentPage>?</currentPage>
            <!--Optional:-->
            <totalPages>?</totalPages>
            <!--Optional:-->
            <totalRecords>?</totalRecords>
            <!--Optional:-->
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Zero or more repetitions:-->
            <accounts>
               <!--Optional:-->
               <id>
                  <!--Optional:-->
                  <bancBoxId>?</bancBoxId>
                  <!--Optional:-->
                  <subscriberReferenceId>?</subscriberReferenceId>
               </id>
               <!--Optional:-->
               <accountType>?</accountType>
               <!--Optional:-->
               <routable>
                  <!--Optional:-->
                  <credits>?</credits>
                  <!--Optional:-->
                  <debits>?</debits>
               </routable>
               <!--Optional:-->
               <routingNumber>?</routingNumber>
               <!--Optional:-->
               <current_balance>?</current_balance>
               <!--Optional:-->
               <pending_balance>?</pending_balance>
               <!--Optional:-->
               <status>?</status>
            </accounts>
         </return>
      </sch:getClientAccountsResponse>
   </soapenv:Body>
</soapenv:Envelope> 

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
	"subscriberId":,
	"clientId":
	{
	"bancBoxId":
	"subscriberReferenceId": ""

	},
	"ascending":"false",
	"pageNo":,
	"resultsPerPage":
}

Sample Response

{
   "currentPage": ,
   "totalPages": ,
   "totalRecords": ,
   "clients" : [ { 
    "clientId" : { 
      "bancBoxId" : ?, 
      "subscriberReferenceId" : "?" 
    }, 
    "firstName" : "?", 
    "lastName" : "?", 
    "middleInitial" : "?", 
    "ssn" : "?", 
    "address" : { 
      "line1" : "?", 
      "line2" : "?", 
      "city" : "?", 
      "state" : "?", 
      "zipcode" : "?" 
    }, 
    "homePhone" : "?", 
    "mobilePhone" : "?", 
    "workPhone" : "?", 
    "email" : "?", 
    "username" : "?", 
    "clientStatus" : "?",
    "cipStatus" : "?",
    "modifiedOn" : "?", 
    "modifiedBy" : ?, 
    "createdOn" : "?", 
    "createdBy" : ? 
  } ], 
  "requestId" : ?, 
  "status" : ?, 
   "warnings" : [ { 
    "code" : "?", 
    "message" : "?" 
  } ], 
  "errors" : [ { 
    "code" : "?", 
    "message" : "?" 
  } ] 
}

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