APIs for creating accounts and making payments
cancelClient
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
Request 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 | |
| comment | N | String | Comment (Max length:1000) |
bancBoxIdResponse 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 | A Warning object containing a code and description. | ||
| + | errors | Request failed, error response. | ||
| + | openAccounts | If accounts are open for the client, the response will list and describe open accounts |
Related Errors
| Parameter | short error message | Description |
| No records | ||
Request and Response formats
WSDL URL (Production) : https://api.bancbox.com/BBXPort?wsdl
WSDL URL (SandBox) : https://sandbox-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>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>
