BancBox

Ver 0 Ver 1 Ver 3

API Reference

APIs for creating accounts and making payments

transferFunds

Use to transfer funds from one BancBox account to another BancBox account.

Parameters

Request Parameters

	Parameter	Required	Type	Description
	subscriberId	Y	long	Specify subscriber ID issued when BancBox account is created.
- +	sourceAccount	Y	Id	The source account is the BancBox account where the funds move from.
	bancBoxId	N	Long	BancBox issued ID for the client account.
	subscriberReferenceId	N	String	Reference ID for the account chosen by subscriber when account is created (Max length:45)
- +	destinationAccount	Y	Id	The source account is the BancBox account where the funds move to.
	bancBoxId	N	Long	Bancbox Id
	subscriberReferenceId	N	String	Subscriber Reference Id (Max length:45)
	memo	N	String	Memo (Max length:128)
- +	items	Y		Items
	referenceId	N	String	Subscriber created ID for the transaction being made (Max length:45)
	memo	N	String	Memo (Max length:128)
	amount	Y	double	Amount (Max Value:9999999999999.995)
- +	scheduled	Y	scheduled	If scheduled parameter is included, the transaction will take place on the specified date. Otherwise, it will be executed immediately. Repeat for several transactions.
	scheduleDate	Y	date	Schedule Date[YYYY-MM-DD]

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.
- +	itemStatuses		Item Statuses
- +	id	long	The ID for the send funds transaction.
	bancBoxId	long	The ID for the transaction used by BancBox.
	subscriberReferenceId	string	ID for the transaction specified by the subscriber in the request.
	status	int	Describes status of the transaction, pending or scheduled
	messageCode	String	Message code
	messageDesc	String	Message description
	code	String	Error code
	message	String	Error message
	itemStatus	int	Status of transaction, 0 for fail, 1 for pass.

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:transferFunds>
         <transferFundsRequest>
            <subscriberId>?</subscriberId>
            <sourceAccount>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </sourceAccount>
            <destinationAccount>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </destinationAccount>
            <!--Optional:-->
            <memo>?</memo>
            <!--Zero or more repetitions:-->
            <items>
               <!--Optional:-->
               <referenceId>?</referenceId>
               <!--Optional:-->
               <memo>?</memo>
               <amount>?</amount>
               <!--Optional:-->
               <scheduled>
                  <scheduleDate>?</scheduleDate>
               </scheduled>
            </items>
         </transferFundsRequest>
      </sch:transferFunds>
   </soapenv:Body>
</soapenv:Envelope>

<requestId></requestId> 
<status></status> 
<itemStatuses> 
	<id> 
		<bancBoxId></bancBoxId> 
		<subscriberReferenceId></subscriberReferenceId> 
	</id> 
	<status></status> 
	<messageCode></messageCode> 
	<messageDesc></messageDesc> 
	<code></code> 
	<message></message>
	<itemStatus></itemStatus> 
</itemStatuses>