Finxera

Back to documentation index

getClientLinkedExternalAccounts

Use the getClientLinkedExternalAccounts method to get all the linked external accounts associated with a specified client.The getClientLinkedExternalAccounts 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
+ linkedExternalAccounts   Object This lists all the linked external account and their details associated with a 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:getClientLinkedExternalAccounts>
         <getClientLinkedExternalAccountsRequest>
            <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Optional:-->
            <ascending>false</ascending>
            <!--Optional:-->
            <pageNo>?</pageNo>
            <!--Optional:-->
            <resultsPerPage>?</resultsPerPage>
         </getClientLinkedExternalAccountsRequest>
      </sch:getClientLinkedExternalAccounts>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> 
   <soap:Body> 
      <ns1:getClientLinkedExternalAccountsResponse xmlns:ns1="schema.bancbox.com"> 
         <return xsi:type="ns3:getClientLinkedExternalAccountsResponse" xmlns:ns3="schema.bancbox.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 
            <requestId>?</requestId> 
            <status>?</status> 
            <currentPage>?</currentPage> 
            <totalPages>?</totalPages> 
            <totalRecords>?</totalRecords> 
            <clientId> 
               <bancBoxId>?</bancBoxId> 
            </clientId> 
            <linkedExternalAccounts> 
               <id> 
                  <bancBoxId>?</bancBoxId> 
                  <subscriberReferenceId>?</subscriberReferenceId> 
               </id> 
               <externalAccountStatus>?</externalAccountStatus> 
               <account> 
                  <wireAccount> 
                     <bankAccountDetails> 
                        <routingNumber>?</routingNumber> 
                        <accountNumber>?</accountNumber> 
                        <holderName>?</holderName> 
                        <bankAccountType>?</bankAccountType> 
                     </bankAccountDetails> 
                     <address> 
                        <line1>?</line1> 
                        <line2>?</line2> 
                        <city>?</city> 
                        <state>?</state> 
                        <zipcode>?</zipcode> 
                     </address> 
                  </wireAccount> 
               </account> 
            </linkedExternalAccounts> 
            <linkedExternalAccounts> 
               <id> 
                  <bancBoxId>?</bancBoxId> 
                  <subscriberReferenceId>?</subscriberReferenceId> 
               </id> 
               <externalAccountStatus>?</externalAccountStatus> 
               <account> 
                  <wireAccount> 
                     <bankAccountDetails> 
                        <routingNumber>?</routingNumber> 
                        <accountNumber>?</accountNumber> 
                        <holderName>?</holderName> 
                        <bankAccountType>?</bankAccountType> 
                     </bankAccountDetails> 
                     <address> 
                        <line1>?</line1> 
                        <line2>?</line2> 
                        <city>?</city> 
                        <state>?</state> 
                        <zipcode>?</zipcode> 
                     </address> 
                  </wireAccount> 
               </account> 
            </linkedExternalAccounts> 
            <linkedExternalAccounts> 
               <id> 
                  <bancBoxId>?</bancBoxId> 
                  <subscriberReferenceId> ?</subscriberReferenceId> 
               </id> 
               <externalAccountStatus>?</externalAccountStatus> 
               <account> 
                  <wireAccount> 
                     <bankAccountDetails> 
                        <routingNumber>?</routingNumber> 
                        <accountNumber>?</accountNumber> 
                        <holderName>?</holderName> 
                        <bankAccountType>?</bankAccountType> 
                     </bankAccountDetails> 
                     <address> 
                        <line1>?</line1> 
                        <line2>?</line2> 
                        <city>?</city> 
                        <state>?</state> 
                        <zipcode>?</zipcode> 
                     </address> 
                  </wireAccount> 
               </account> 
            </linkedExternalAccounts> 
            <linkedExternalAccounts> 
               <id> 
                  <bancBoxId>?</bancBoxId> 
                  <subscriberReferenceId>? </subscriberReferenceId> 
               </id> 
               <externalAccountStatus>?</externalAccountStatus> 
               <account> 
                  <wireAccount> 
                     <bankAccountDetails> 
                        <routingNumber>?</routingNumber> 
                        <accountNumber>?</accountNumber> 
                        <holderName>?</holderName> 
                        <bankAccountType>?</bankAccountType> 
                     </bankAccountDetails> 
                     <address> 
                        <line1>?</line1> 
                        <line2>?</line2> 
                        <city>?</city> 
                        <state>?</state> 
                        <zipcode>?</zipcode> 
                     </address> 
                  </wireAccount> 
               </account> 
            </linkedExternalAccounts> 
            <linkedExternalAccounts> 
               <id> 
                  <bancBoxId>?</bancBoxId> 
                  <subscriberReferenceId> ?</subscriberReferenceId> 
               </id> 
               <externalAccountStatus>?</externalAccountStatus> 
               <account> 
                  <wireAccount> 
                     <bankAccountDetails> 
                        <routingNumber>?</routingNumber> 
                        <accountNumber>?</accountNumber> 
                        <holderName>?</holderName> 
                        <bankAccountType>?</bankAccountType> 
                     </bankAccountDetails> 
                     <address> 
                        <line1>?</line1> 
                        <line2>?</line2> 
                        <city>?</city> 
                        <state>?</state> 
                        <zipcode></zipcode> 
                     </address> 
                  </wireAccount> 
               </account> 
            </linkedExternalAccounts> 
         </return> 
      </ns1:getClientLinkedExternalAccountsResponse> 
   </soap:Body> 
</soap:Envelope>

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

Sample Request

{ 
  "authentication": 
    { 
        "apiKey":"YOUR_API_KEY_HERE", 
        "secret":"SECRET_PASSPHRASE" 
    },
  	"subscriberId":,
  	"clientId":
    	{
     	"bancBoxId":?, 
	"subscriberReferenceId": "?" 
    
    	},
    	"ascending":"false",
    	"pageNo":,
    	"resultsPerPage":
}

Sample Response

{
    "requestId": ,
    "status": ,
    "warnings": [
        {
            "code": "?",
            "message": "?"
        }
    ],
    "errors": [
        {
            "code": "?",
            "message": "?"
        }
    ],
    "currentPage": ,
    "totalPages": ,
    "totalRecords": ,
    "clientId": {
        "bancBoxId": ?,
        "subscriberReferenceId": "?"
    },
    "linkedExternalAccounts": [
        {
            "id": {
                "bancBoxId": ?,
                "subscriberReferenceId": "?"
            },
            "externalAccountStatus": "?",
            "account": {
                "bankAccount": {
                    "routingNumber": "?",
                    "accountNumber": "?",
                    "holderName": "?",
                    "bankAccountType": "?",
                    "prenoteStatus": "?",
                    "prenoteDate": "?"
                },
                "cardAccount": {
                    "creditCardAccount": {
                        "number": "?",
                        "expiryDate": "?",
                        "type": "?",
                        "name": "?",
                        "cvv": "?",
                        "address": {
                            "line1": "?",
                            "line2": "?",
                            "city": "?",
                            "state": "?",
                            "zipcode": "?"
                        }
                    },
                    "debitCardAccount": {
                        "number": "?",
                        "type": "?",
                        "pin": "?"
                    },
                    "giftCardAccount": {
                        "number": "?",
                        "pin": "?"
                    }
                },
                "paypalAccount": {
                    "id": "?"
                },
                "wireAccount": {
                    "bankAccountDetails": {
                        "routingNumber": "?",
                        "accountNumber": "?",
                        "holderName": "?",
                        "bankAccountType": "?",
                        
                    },
                    "address": {
                        "line1": {
                            "line2": "?",
                            "city": "?",
                            "state": "?",
                            "zipcode": "?",
                            
                        }
                    }
                }
            }
        ]
    }

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