BancBox

Use the updateClient API to change the details of an already existing client..

Parameters

Parameter	Required	Type	Description
subscriberId	Y	Long	Specify subscriber ID issued when BancBox account is created
clientId	Y		Specify either the bancBoxId or subscriberReferenceId parameter.
bancBoxId	N	Long	Client ID used by BancBox, 6 digit number.
subscriberReferenceId	N	String	Subscriber created reference ID for client (Max length:45)
firstName	N	String	First Name
lastName	N	String	Last Name
middleInitial	N	String	Middle Initial
ssn	N	String	SSN
dob	N	date	Date of birth[YYYY-MM-DD]
address	N		Address
line1	Y	String	Address Line1 (Max length:128)
line2	N	String	Address Line2 (Max length:128)
city	Y	String	City (Max length:45)
state	Y	String	State
zipcode	Y	String	Zipcode
homePhone	N	String	Home Phone
mobilePhone	N	String	Mobile Phone
workPhone	N	String	Work Phone
email	N	String	Email
username	N	String	User Name

Parameter	Type	Description
status	Int	Status of completed request, either 1 for pass, or 0 for fail.
warnings		A Warning object containing a code and description
code	String	A Short code for the warning message
message	String	Warning message descrption as string
errors		Request failed, error response.
code	String	Code of specific error.
message	String	Message appears under error code, which describes the error that occurred.
clientStatus	enum	enum { 'ACTIVE', 'INACTIVE', 'CANCELLED', 'SUSPENDED', 'DELETED' }
requestId	long	13 digit ID for the API request being made.

Parameter	Short error messge	Description
No records

XML Examples

<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:updateClient>
         <updateClientRequest>
           <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Optional:-->
            <firstName>?</firstName>
            <!--Optional:-->
            <lastName>?</lastName>
            <!--Optional:-->
            <middleInitial>?</middleInitial>
            <!--Optional:-->
            <ssn>?</ssn>
            <!--Optional:-->
            <dob>?</dob>
            <!--Optional:-->
            <address>
               <line1>?</line1>
               <!--Optional:-->
               <line2>?</line2>
               <city>?</city>
               <state>?</state>
               <zipcode>?</zipcode>
            </address>
            <!--Optional:-->
            <homePhone>?</homePhone>
            <!--Optional:-->
            <mobilePhone>?</mobilePhone>
            <!--Optional:-->
            <workPhone>?</workPhone>
            <!--Optional:-->
            <email>?</email>
            <!--Optional:-->
            <username>?</username>
         </updateClientRequest>
      </sch:updateClient>
   </soapenv:Body>
</soapenv:Envelope>

<sch:updateClientResponse>
       <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:-->
            <clientStatus>?</clientStatus>
         </return>
</sch:updateClientResponse>