BancBox

Use the linkExternalAccount API to link an external bank, card, or paypal account to a client..

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	ID created by the subscriber for the newly linked external account (Max length:45)
account	Y		Link a paypalAccount, creditcardAccount, or a bankAccount. Choose one of these three.
paypalAccount	Y	paypalAccount	Paypal Account
id	Y	string	Id (Max length:45)
cardAccount	Y	Long	BancBox Id
creditCardAccount	Y	creditCardAccount	Credit Card Account
number	Y	String	Number
expiryDate	Y	date	Credit Card Expiry Date[MM/YY]
type	Y	creditCardType	enum { 'VISA', 'MASTERCARD', 'AMERICANEXPRESS' }
name	Y	String	Name (Max length:45)
cvv	Y	String	CVV
address	Y	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	N	String	State
zipcode	Y	String	Zip Code
debitCardAccount	Y	debitCardAccount	Debit Card Account
number	Y	String	Number (max length:45)
type	Y	enum { 'MASTERCARD' }	Type
pin	Y	String	Pin (max length:45)
giftCardAccount	Y	giftCardAccount	Gift Card Account
number	Y	String	Gift Card Account number (Max length:45)
pin	Y	String	Gift Card Account pin (Max length:45)
bankAccount	Y	bankAccount	Bank Account
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'}

Parameter	Type	Description
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	Message appears under error code, which describes the error that occurred.
Id		Newly created IDs for the linked external account, both the bancbox ID and the reference ID
bancBoxId	Long	ID used by BancBox for this external account.
subscriberReferenceId	string	ID for the external account created by the subscriber.
requestId	Long	13 digit ID for the API request being made.

Parameter	Short error messge	Description
No records

XML Examples

<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:linkExternalAccount>
            <sch:linkExternalAccount>
                <linkExternalAccountRequest>
                    <subscriberId>?</subscriberId>
                    <clientId>
                        <!--Optional:-->
                        <bancBoxId>?</bancBoxId>
                        <!--Optional:-->
                        <subscriberReferenceId>?</subscriberReferenceId>
                    </clientId>
                    <!--Optional:-->
                    <referenceId>?</referenceId>
                    <account>
                        <!--You have a CHOICE of the next 3 items at this level-->
                        <bankAccount>
                            <routingNumber>?</routingNumber>
                            <accountNumber>?</accountNumber>
                            <holderName>?</holderName>
                            <bankAccountType>?</bankAccountType>
                        </bankAccount>
                        <cardAccount>
                            <!--You have a CHOICE of the next 3 items at this level-->
                            <creditCardAccount>
                                <number>?</number>
                                <expiryDate>?</expiryDate>
                                <type>?</type>
                                <name>?</name>
                                <cvv>?</cvv>
                                <address>
                                    <line1>?</line1>
                                    <!--Optional:-->
                                    <line2>?</line2>
                                    <city>?</city>
                                    <state>?</state>
                                    <zipcode>?</zipcode>
                                </address>
                            </creditCardAccount>
                            <debitCardAccount>
                                <number>?</number>
                                <type>?</type>
                                <pin>?</pin>
                            </debitCardAccount>
                            <giftCardAccount>
                                <number>?</number>
                                <pin>?</pin>
                            </giftCardAccount>
                        </cardAccount>
                        <paypalAccount>
                            <id>?</id>
                        </paypalAccount>
                    </account>
                </linkExternalAccountRequest>
            </sch:linkExternalAccount>
    </soapenv:Body>
</soapenv:Envelope>

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