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/v1/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/v1/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>
			<!--You have a CHOICE of the next 3 items at this level-->
			<tokenizedId>?</tokenizedId>
			<trackdata>?</trackdata>
			<creditCardDetails>
			   <number>?</number>
			   <expiryDate>?</expiryDate>
			   <type>?</type>
			   <name>?</name>
			   <cvv>?</cvv>
			   <address>
				  <line1>?</line1>
				  <!--Optional:-->
				  <line2>?</line2>
				  <city>?</city>
				  <state>?</state>
				  <zipcode>?</zipcode>
			   </address>
			</creditCardDetails>
		     </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

<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>
     <!--Optional:-->
     <externalReferenceId>?</externalReferenceId> 
   </itemStatuses> 
</sch:collectFundsResponse>

Note:For REST, Content-type should be set to application/json
URL (Production) :  https://api.bancbox.com/v1/BBXPortRest/collectFunds
URL (SandBox) :  https://sandbox-api.bancbox.com/v1/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": "?",
                "tokenizedId": "?",
                "creditCardDetails": {
                    "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" : ?,
    "externalReferenceId": "?"
  } ], 
  "requestId" : ?, 
  "status" : ? 
 }