BancBox

Ver 0 Ver 1 Ver 3

API Reference

APIs for creating accounts and making payments

collectFunds

The collectFunds method allows you to bring funds into your client's BancBox account from an external source, another BancBox acount, or credit card . Possible methods include funding using ACH, Credit Card and internal Book transfers. You can schedule funds movement in the future by specifying a date, give multiple dates for recurring payments, or have BancBox execute immediately by not specifying a date.

Parameters

Request Parameters

	Parameter	Required	Type	Description
	subscriberId	Y	long	Specify subscriber ID issued when BancBox account is created
- +	method	Y		The method must include only one of {book, ach, creditcard} as an empty parameter.
	book	N	book	Book method moves funds from one BancBox account into another BancBox account.
	ach	N	ach	ach method moves funds from an external account to a BancBox account.
	creditcard	N	creditcard	Creditcard method moves funds from a credit card account to a BancBox account.
- +	source	Y		Must choose from linkedExternalAccountId, newExternalAccount, or account parameters. Do not include more than one.
- +	linkedExternalAccountId	Y		Choose either the BancboxId or subscriberReferenceId parameter.
	bancBoxId	N	long	BancBox issued ID for the linked External Account.
	subscriberReferenceId	N	string	Reference ID for the external account chosen by subscriber (Max length:45)
- +	newExternalAccount	Y		Using the newExternalAccount parameter allows the subscriber to create a new linked external account without having to use the linkExternalAccount API.
- +	account	Y	id	Account
- +	bankaccount	Y	bankaccount	Bankaccount
	routingNumber	Y	string	Routing Number (Max length:45)
	accountNumber	Y	string	Account Number (Max length:45)
	holderName	Y	string	Holder Name (Max length:45)
	bankAccountType	Y	bankAccountType	enum{'SAVING','CHECKING'}
- +	creditCardAccount	Y	creditCardAccount	Credit Card Account
	trackdata	N	String	Track data
	number	N	String	Number
	expiryDate	N	date	Credit Card Expiry Date[MM/YY]
	type	N	creditCardType	enum { 'VISA', 'MASTERCARD', 'AMERICANEXPRESS' }
	name	N	String	Name (Max length:45)
	cvv	N	String	CVV
- +	address	N	address	Address
	line1	Y	String	Line 1 (Max length:128)
	line2	N	String	Line 2 (Max length:128)
	city	Y	String	City (Max length:45)
	state	Y	String	State
	zipcode	Y	String	Zip Code
- +	account	Y		The account parameter is a BancBox account for a client.
	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		The funds will move from the source to the destination account specified in this parameter.
	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)
- +	items	Y		items
	referenceId	N	String	Subscriber specified reference ID for the transaction being completed (Max length:45)
	amount	Y	double	How much money is being transferred (Max Value:9999999999999.995)
	memo	N	String	Memo (Max length:128)
- +	scheduled	Y	scheduled	If scheduled parameter is included, the transaction will take place on the specified date. Otherwise, it will be executed immediately.
	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	itemStatuses	Item Statuses
- +	id		ID's of the collectFunds transaction.
	bancBoxId	long	ID of the transaction used by BancBox.
	subscriberReferenceId	string	ID of the transaction created by the subscriber.
	status	int	RThis status shows the state of the transaction, IN_PROCESS or SCHEDULED.
	messageCode	String	Message code
	messageDesc	String	Message description
	code	String	Error code
	message	String	Error message
	itemStatus	int	This status shows if the transaction itself went through, 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:collectFunds>
         <collectFundsRequest>
            <subscriberId>?</subscriberId>
            <method>
               <!--You have a CHOICE of the next 3 items at this level-->
               <book/>
               <ach/>
               <creditcard/>
            </method>
	    <source>
               <!--You have a CHOICE of the next 3 items at this level-->
               <account>
                  <!--Optional:-->
                  <bancBoxId>?</bancBoxId>
                  <!--Optional:-->
                  <subscriberReferenceId>?</subscriberReferenceId>
               </account>
               <linkedExternalAccountId>
                  <!--Optional:-->
                  <bancBoxId>?</bancBoxId>
                  <!--Optional:-->
                  <subscriberReferenceId>?</subscriberReferenceId>
               </linkedExternalAccountId>
               <newExternalAccount>
                  <account>
                     <!--You have a CHOICE of the next 2 items at this level-->
                     <bankAccount>
                        <routingNumber>?</routingNumber>
                        <accountNumber>?</accountNumber>
                        <holderName>?</holderName>
                        <bankAccountType>?</bankAccountType>
                     </bankAccount>
                     <creditCardAccount>
                        <!--Optional:-->
                        <trackdata>?</trackdata>
                        <!--Optional:-->
                        <number>?</number>
                        <!--Optional:-->
                        <expiryDate>?</expiryDate>
                        <!--Optional:-->
                        <type>?</type>
                        <!--Optional:-->
                        <name>?</name>
                        <!--Optional:-->
                        <cvv>?</cvv>
                        <!--Optional:-->
                        <address>
                           <line1>?</line1>
                           <!--Optional:-->
                           <line2>?</line2>
                           <city>?</city>
                           <state>?</state>
                           <zipcode>?</zipcode>
                        </address>
                     </creditCardAccount>
                  </account>
               </newExternalAccount>
            </source>
            <destinationAccount>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </destinationAccount>
            <!--1 or more repetitions:-->
            <items>
               <!--Optional:-->
               <referenceId>?</referenceId>
               <amount>?</amount>
               <!--Optional:-->
               <memo>?</memo>
               <!--Optional:-->
               <scheduled>
                  <scheduleDate>?</scheduleDate>
               </scheduled>
            </items>
         </collectFundsRequest>
      </sch:collectFunds>
   </soapenv:Body>
</soapenv:Envelope>

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

Note : For REST, Content-type should be set to application/json
URL (Production) : https://api.bancbox.com/BBXPortRest/collectFunds
URL (SandBox) : https://sandbox-api.bancbox.com/BBXPortRest/collectFunds

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": ? ,
    "method" : "?",
    "source": {
        "account": {
            "bancBoxId": ? ,
            "subscriberReferenceId" : "?"
        },
        "linkedExternalAccount": {
            "bancBoxId": ? ,
            "subscriberReferenceId" : "?"
        },
        "newExternalAccount": {
            "bankAccount": {
                "routingNumber": "?",
                "accountNumber": "?",
                "holderName": "?",
                "bankAccountType": "?"
            },
            "creditCardAccount": {
                "trackdata":"?",
                "number": "?",
                "expiryDate": "?",
                "type": "?",
                "name": "?"
                "cvv": "?",
                "address": {
                    "line1": "?",
                    "line2": "?",
                    "city": "?",
                    "state": "?",
                    "zipcode": "?"
                }
            }
        }
    },
    "destinationAccount": {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "items": [{
        "referenceId": "?",
        "amount": ? ,
        "memo" : "?",
        "scheduleDate": "?"
    }]
}

Sample Response

{ 
  "itemStatuses" : [ { 
    "id" : { 
      "bancBoxId" : ?, 
      "subscriberReferenceId" : "?", 
    }, 
    "status" : "?", 
    "messageCode" : "?", 
    "messageDesc" :"?", 
    "code" : "?", 
    "message" : "?", 
    "itemStatus" : ? 
  } ], 
  "requestId" : ?, 
  "status" : ? 
 }