BancBox

Ver 0 Ver 1 Ver 3

API Reference

APIs for creating accounts and making payments

updateClientStatus

Use to update the status of a client. The status can be ACTIVE, INACTIVE, SUSPENDED or DELETED.

Parameters

Request Parameters

	Parameter	Required	Type	Description
	subscriberId	Y	Long	Specify subscriber ID issued when BancBox account is created.
- +	clientId	N	Id	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)
	clientStatus	Y	enum	The new status of the client specified enum{'ACTIVE', 'INACTIVE', 'SUSPENDED', 'DELETED'}

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	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	error	Request failed, error response.
	code	String	Code of specific error.
	message	String	Message appears under error code, which describes the error that occurred.
	newStatus	clientStatus	The new status that the client status has been changed to.

Related Errors

Parameter	short error message	Description
No records

Request and Response formats

SOAP REST

WSDL URL (Production) : https://api.bancbox.com/BBXPort?wsdl
WSDL URL (SandBox) : https://sandbox-api.bancbox.com/BBXPort?wsdl

<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>test.test@test.com</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">PASSWORD</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
   <soapenv:Body>
      <sch:updateClientStatus>
         <updateClientStatusRequest>
            <subscriberId>?</subscriberId>
            <!--Optional:-->
            <clientId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <clientStatus>?</clientStatus>
         </updateClientStatusRequest>
      </sch:updateClientStatus>
   </soapenv:Body>
</soapenv:Envelope>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:updateClientStatusResponse xmlns:ns1="schema.bancbox.com">
         <return xsi:type="ns3:updateClientStatusResponse" xmlns:ns3="schema.bancbox.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <requestId>?</requestId>
            <status>?</status>
            <newStatus>?</newStatus>
         </return>
      </ns1:updateClientStatusResponse>
   </soap:Body>
</soap:Envelope>