BancBox

Ver 0 Ver 1 Ver 3

API Reference

APIs for creating accounts and making payments

linkPayee

Use the linkPayee API to link a new payee 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 ID for client (Max length:45)
	referenceId	N	String	This is a subscriber created ID for the new linked payee (Max length:45)
- +	payee	Y		Payee
	payeeAccountNumber	Y	String	Number assigned to the new payee account designated by subscriber (Max Length:45)
	memo	N	String	Memo (Max length:128)
- +	payee	Y	payee	Fill out the details for the new payee account,{'ach', 'check', 'paypal'}
- +	ach	N	bankAccount	Bank account details
	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	enum (SAVINGS, CHECKING)	Bank Account Type
- +	paypal	Y	paypalAccount	Paypal details
	id	Y	String	Paypal account Id (Max length:45)
- +	check	Y	checkDestination	Check
	name	Y	String	Name (Max length:45)
- +	address	Y	address	address
	line1	Y	String	Address line1 (Max length:128)
	line2	N	String	Address line2 (Max length:128)
	city	Y	String	City (Max length:45)
	state	Y	String	State
	zipcode	Y	String	Zipcode
- +	bancbox	Y	bancBox	bancBox
	bancboxPayeeId	Y	long	Bancbox Payee Id

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	error	Request failed, error response.
	code	String	Code of specific error.
	message	String	Error message
- +	id		The IDs for the new linked payee.
	bancBoxId	long	The ID for the payee used by BancBox.
	subscriberReferenceId	string	ID for the linked payee specified by the subscriber in the request.

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:linkPayee>
         <linkPayeeRequest>
            <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Optional:-->
            <referenceId>?</referenceId>
            <payee>
               <payeeAccountNumber>?</payeeAccountNumber>
               <!--Optional:-->
               <memo>?</memo>
               <payee>
                  <!--You have a CHOICE of the next 4 items at this level-->
                  <ach>
                     <routingNumber>?</routingNumber>
                     <accountNumber>?</accountNumber>
                     <holderName>?</holderName>
                     <bankAccountType>?</bankAccountType>
                  </ach>
                  <paypal>
                     <id>?</id>
                  </paypal>
                  <check>
                     <name>?</name>
                     <address>
                        <line1>?</line1>
                        <!--Optional:-->
                        <line2>?</line2>
                        <city>?</city>
                        <state>?</state>
                        <zipcode>?</zipcode>
                     </address>
                  </check>
		  <bancbox>
                     <bancboxPayeeId>?</bancboxPayeeId>
                  </bancbox>
                </payee>
            </payee>
         </linkPayeeRequest>
      </sch:linkPayee>
   </soapenv:Body>
</soapenv:Envelope>

<sch:linkPayeeResponse>
       <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:linkPayeeResponse>