BancBox

Ver 0 Ver 1 Ver 3

API Reference

APIs for creating accounts and making payments

openAccount

This method allows a subscriber to open a BancBox account under a specified client.

View Demo

Parameters

Request 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)
	referenceId	N	String	Subscriber created reference ID for the account (Max length:45)
	title	N	String	Name of the BancBox account (Max length:45)
- +	routable	N	routable	Routable Status
	credits	N	String	Routable Status {YES/NO}
	debits	N	String	Routable Status {YES/NO}

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	warning	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	errors	Request failed, error response.
	code	String	Code of specific error.
	message	String	Message appears under error code, which describes the error that occurred.
- +	account	account	Account
- +	id		The IDs for the newly opened account are shown here.
	bancBoxId	Long	ID used by BancBox for this account.
	subscriberReferenceId	String	ID for the account created by the subscriber.
- +	routable	routable	Routable Status
	credits	String	Routable Status {YES/NO}
	debits	String	Routable Status {YES/NO}
	routingNumber	String	Routing Number
	status	accountStatus	enum { 'OPEN', 'CLOSED' }

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>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:openAccount>
         <openAccountRequest>
            <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Optional:-->
            <referenceId>?</referenceId>
            <!--Optional:-->
            <title>?</title>
            <!--Optional:-->
	    <routable>
               <!--Optional:-->
               <credits>?</credits>
               <!--Optional:-->
               <debits>?</debits>
            </routable>
         </openAccountRequest>
      </sch:openAccount>
   </soapenv:Body>
</soapenv:Envelope>

<sch:openAccountResponse>
        <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:-->
            <account>
               <!--Optional:-->
               <id>
                  <!--Optional:-->
                  <bancBoxId>?</bancBoxId>
                  <!--Optional:-->
                  <subscriberReferenceId>?</subscriberReferenceId>
               </id>
               <!--Optional:-->
	       <routable>
		  <!--Optional:-->
                  <credits>?</credits>
		  <!--Optional:-->
                  <debits>?</debits>
               </routable>
               <routingNumber>?</routingNumber>
               <!--Optional:-->
               <status>?</status>
            </account>
         </return>
</sch:openAccountResponse>