Finxera

Back to documentation index

getClientLinkedPayees

Use the get client linked payees API to get a list of payees linked to a specified client.The getClientLinkedPayees 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.
+ linkedPayees   Object Lists payees and details of payees linked to 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:getClientLinkedPayees>
         <getClientLinkedPayeesRequest>
            <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Optional:-->
            <ascending>false</ascending>
            <!--Optional:-->
            <pageNo>?</pageNo>
            <!--Optional:-->
            <resultsPerPage>?</resultsPerPage>
         </getClientLinkedPayeesRequest>
      </sch:getClientLinkedPayees>
   </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:getClientLinkedPayeesResponse>
         <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>
            <!--Zero or more repetitions:-->
            <linkedPayees>
               <id>
                  <!--Optional:-->
                  <bancBoxId>?</bancBoxId>
                  <!--Optional:-->
                  <subscriberReferenceId>?</subscriberReferenceId>
               </id>
               <payeeAccountNumber>?</payeeAccountNumber>
               <!--Optional:-->
               <payeeName>?</payeeName>
               <!--Optional:-->
               <memo>?</memo>
               <payeeStatus>?</payeeStatus>
               <payee>
                  <!--You have a CHOICE of the next 4 items at this level-->
                  <ach>
                     <routingNumber>?</routingNumber>
                     <accountNumber>?</accountNumber>
                     <holderName>?</holderName>
                     <bankAccountType>?</bankAccountType>
                  </ach>
                  <paypal>
                     <id>?</id>
                  </paypal>
                  <check>
                     <name>?</name>
                     <address>
                        <line1>?</line1>
                        <!--Optional:-->
                        <line2>?</line2>
                        <city>?</city>
                        <state>?</state>
                        <zipcode>?</zipcode>
                     </address>
                  </check>
                  <bancbox>
                     <bancboxPayeeId>?</bancboxPayeeId>
                  </bancbox>
               </payee>
            </linkedPayees>
         </return>
      </sch:getClientLinkedPayeesResponse>
   </soapenv:Body>
</soapenv:Envelope> 

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

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": ,
   "linkedPayees": [{
        "id": {
            "bancBoxId": ? ,
            "subscriberReferenceId" : "?"
        },
        "payeeAccountNumber": "?",
	"payeeName": "?",
        "memo": "?",
        "payeeStatus": "?",
        "payee": {
            "ach": {
                "routingNumber": "?",
                "accountNumber": "?",
                "holderName": "?",
                "bankAccountType": "?"
            },
            "paypal": {
                "id": "?"
            },
            "check": {
                "name": "?",
                "address": {
                    "line1": "?",
                    "line2": "?",
                    "city": "?",
                    "state": "?",
                    "zipcode": "?"
                }
		},
	    "bancbox":{
	           "bancboxPayeeId": "?"
	     } 
        }
    }]
}

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