Finxera

Back to documentation index

getClientLinkedPayees

Use the get client linked payees API to get a list of payess linked to a specified client.

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.

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.

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:getClientLinkedPayees>
         <getClientLinkedPayeesRequest>
           <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
         </getClientLinkedPayeesRequest>
      </sch:getClientLinkedPayees>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<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>
            <!--Zero or more repetitions:-->
            <linkedPayees>
               <id>
                  <!--Optional:-->
                  <bancBoxId>?</bancBoxId>
                  <!--Optional:-->
                  <subscriberReferenceId>?</subscriberReferenceId>
               </id>
               <payeeAccountNumber>?</payeeAccountNumber>
	       <payeeName>?</payeeName>
               <!--Optional:-->
               <memo>?</memo>
               <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>

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

Sample Request

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

Sample Response

{
    "requestId": ? ,
    "status" : ? ,
    "warnings" : [{
        "code": "?",
        "message": "?"
    }],
    "errors": [{
        "code": "?",
        "message": "?"
    }],
    "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": "?"
	     } 
        }
    }]
}