Finxera

Back to documentation index

sendFunds

Use the sendFunds API to send funds out of a Finxera client's account.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
+ method Y Object Specify a method as an empty parameter, {'check', 'wire' ,'book', 'ach', 'paypal', 'billpay'}
+ sourceAccount Y Object The source account is where the funds are getting sent out of.
+ destination Y Object Where the funds are going to from the source account.
payeeAccountNumber N String If the destination is to a linked payee, then specify the payee account number (Max Length:45).
memo N String Memo (Max Length:128)
+ 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:sendFunds>
         <sendFundsRequest>
             <subscriberId>?</subscriberId>
            <method>
               <!--You have a CHOICE of the next 7 items at this level--> 
               <book/> 
               <ach/> 
               <check> 
                  <type>?</type> 
               </check> 
               <wire/> 
               <billpay/> 
               <paypal/>
           </method>
            <sourceAccount>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </sourceAccount>
             <destination> 
               <!--You have a CHOICE of the next 6 items at this level--> 
               <account> 
                  <!--Optional:--> 
                  <bancBoxId>?</bancBoxId> 
                  <!--Optional:--> 
                  <subscriberReferenceId>?</subscriberReferenceId> 
               </account> 
               <linkedPayeeId> 
                  <!--Optional:--> 
                  <bancBoxId>?</bancBoxId> 
                  <!--Optional:--> 
                  <subscriberReferenceId>?</subscriberReferenceId> 
               </linkedPayeeId> 
               <linkedExternalAccountId> 
                  <!--Optional:--> 
                  <bancBoxId>?</bancBoxId> 
                  <!--Optional:--> 
                  <subscriberReferenceId>?</subscriberReferenceId> 
               </linkedExternalAccountId> 
               <bancBoxPayeeId>?</bancBoxPayeeId> 
               <newPayee> 
                  <payeeAccountNumber>?</payeeAccountNumber> 
                  <!--Optional:--> 
                  <memo>?</memo> 
                  <payee> 
                     <!--You have a CHOICE of the next 3 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> 
                  </payee> 
               </newPayee> 
               <newExternalAccount> 
                  <account> 
                     <!--You have a CHOICE of the next 3 items at this level--> 
                     <bankAccount> 
                        <routingNumber>?</routingNumber> 
                        <accountNumber>?</accountNumber> 
                        <holderName>?</holderName> 
                        <bankAccountType>?</bankAccountType> 
                     </bankAccount> 
                     <paypalAccount> 
                        <id>?</id> 
                     </paypalAccount> 
                     </account> 
               </newExternalAccount> 
            </destination> 
            <!--Optional:-->
            <payeeAccountNumber>?</payeeAccountNumber>
            <!--Optional:-->
            <memo>?</memo>
            <!--Zero or more repetitions:-->
            <items>
               <!--Optional:-->
               <referenceId>?</referenceId>
               <!--Optional:-->
               <memo>?</memo>
               <amount>?</amount>
               <!--Optional:-->
               <scheduled>
                  <scheduleDate>?</scheduleDate>
               </scheduled>
            </items>
         </sendFundsRequest>
      </sch:sendFunds>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

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

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": ? ,
    "sourceAccount" : {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "method": "?",
    "check": {
        "type": "?"
    },
    "payeeAccountNumber": "?",
    "memo": "?",
    "destinationAccount": {
        "account": {
            "bancBoxId": ? ,
            "subscriberReferenceId" : "?"
        },
        "linkedPayeeId": {
            "bancBoxId": ? ,
            "subscriberReferenceId" : "?"
        },
        "linkedExternalAccountId": {
            "bancBoxId": ? ,
            "subscriberReferenceId" : "?"
        },
        "bancBoxPayeeId": ? ,
        "newPayee" : {
            "payeeAccountNumber": "?",
            "memo": "?",
            "ach": {
                "routingNumber": "?",
                "accountNumber": "?",
                "holderName": "?",
                "bankAccountType": "?"
            },
            "paypalAccount": {
                "id": "?"
            },
            "check": {
                "name": "?",
                "address": {
                    "line1": "?",
                    "line2": "?",
                    "city": "?",
                    "state": "?",
                    "zipcode": "?"
                }
            }
        },
        "newExternalAccount": {
            "bankAccount": {
                "routingNumber": "?",
                "accountNumber": "?",
                "holderName": "?",
                "bankAccountType": "?"
            },            
            "paypalAccount": {
                "id": "?"
            }
        }
    },
    "items": [{
        "referenceId": "?",
        "amount": ? ,
        "memo" : "?",
        "scheduleDate": "?"
    }]
}

Sample Response

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