BancBox

Give instruction to Bancbox to cancel a client. This will change the status of the client to CANCELLED if all accounts under this client are closed.Otherwise API response will show details of accounts open under the client..

Parameters

Parameter	Required	Type	Description
subscriberId	Y	Long	Specify subscriber ID issued when BancBox account is created
clientId	Y		Define either 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)
comment	N	String	Comment (Max length:1000)

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.
openAccounts		If accounts are open for the client, the response will list and describe open accounts
id	id	Id
bancBoxId	Long	BancBox Id
subscriberReferenceId	string	Subscriber Reference Id
current_balance	double	Current balance
status	accountStatus	enum { 'OPEN', 'CLOSED' }
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:cancelClient>
         <cancelClientRequest>
            <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Optional:-->
            <comment>?</comment>
         </cancelClientRequest>
      </sch:cancelClient>
   </soapenv:Body>
</soapenv:Envelope>

<sch:cancelClientResponse>
         <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:-->
            <openAccounts>
               <!--Optional:-->
               <id>
                  <!--Optional:-->
                  <bancBoxId>?</bancBoxId>
                  <!--Optional:-->
                  <subscriberReferenceId>?</subscriberReferenceId>
               </id>
               <!--Optional:-->
               <current_balance>?</current_balance>
               <!--Optional:-->
               <status>?</status>
            </openAccounts>
         </return>
</sch:cancelClientResponse>