Finxera

Back to documentation index

collectFunds

The collectFunds method allows you to bring funds into your client's Finxera account from an external source, another Finxera 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 Finxera execute immediately by not specifying a date.

Request Parameters

  Parameter Required Type Description
subscriberId Y long Specify subscriber ID issued when Finxera account is created.
+ method Y Object The method must include only one of {book, ach, creditcard} as an empty parameter.
+ source Y Object Must choose from linkedExternalAccountId, newExternalAccount, or account parameters. Do not include more than one.
+ destinationAccount Y Object The funds will move from the source to the destination account specified in this parameter.
+ items Y Object items

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   Object Item Statuses

WSDL URL (Production) :  https://api.bancbox.com/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/BBXPort?wsdl

Sample Request

<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>

Sample Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> 

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":"fd1c986a29bf5e8bb5d283d426a2b754","secret":"e19d5cd5af0378da05f63f891c7467af"},"subscriberId":200323,"method":"WIRE","sourceAccount":{"subscriberReferenceId":"wire_account"},"destinationAccount":{"newPayee":{"payeeAccountNumber":"2309128722","wire":{"bankAccountDetails":{"routingNumber":"051000017","accountNumber":"2456091872","holderName":"Deepika","bankAccountType":"SAVING"},"address":{"line1":"12 ST","line2":"ROAD","city":"ATLANTA","state":"GA","zipcode":23890}}}},"items":[{"referenceId":"valid_details_bbxid_SCHd","amount":1,"scheduleDate":"2014-09-20"}]}

Sample Response

{"itemStatuses":[{"id":{"bancBoxId":711194,"subscriberReferenceId":"valid_details_bbxid_SCHd"},"status":"SCHEDULED","itemStatus":1}],"requestId":1396249671337,"status":1,"warnings":null}