BancBox

Ver 0 Ver 1 Ver 3

API Reference

APIs for creating accounts and making payments

linkFile

Use the linkFile API to attach a file to a 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
	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 set ID for the file being created (Max length:45)
- +	file	Y		File
	name	N	string	Name (Max length:45)
	fileClass	N	fileClass	enum { 'AUTHORIZED', 'IDENTIFICATION', 'OTHER' }
	url	N	string	url
	content	N	string	encoded file content
	comment	N	string	comment (Max length:128)

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		A Warning object containing a code and description.
	code	String	Short code for the warning message.
	message	String	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.
- +	id		id
	bancBoxId	Long	Banc Box Id
	subscriberReferenceId	String	Sub Ref Id

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:linkFile>
         <linkFileRequest>
             <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Optional:-->
            <referenceId>?</referenceId>
            <file>
               <!--Optional:-->
               <name>?</name>
               <!--Optional:-->
               <fileClass>?</fileClass>
               <!--Optional:-->
               <url>?</url>
               <!--Optional:-->
               <content>cid:912263605697</content>
               <!--Optional:-->
               <comment>?</comment>
            </file>
         </linkFileRequest>
      </sch:linkFile>
   </soapenv:Body>
</soapenv:Envelope>

<sch:linkFileResponse>
      <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:-->
            <id>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </id>
       </return>

</sch:linkFileResponse>