BancBox

sendFunds

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

Parameters

Request Parameters
Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
sourceAccount Y Object The source account is where the funds are getting sent out of.
  printer bancBoxId N Long client ID used by Finxera, 6 digit number.
  printer subscriberReferenceId N String subscriber created ID for client (Max length:45)
destination Y Object Where the funds are going to from the source account.
  printer linkedExternalAccountId N Object Linked External Account Id
    printer bancBoxId Y long BancboxId
    printer subscriberReferenceId N string subscriber Reference Id (Max length:45)
  printer account N Object If the destination is a Finxera account, specify the account number (Finxera generated Account Number or the subscriber defined account number) or the reference ID.
    printer bancBoxId Y long Either the Finxera generated account number or the subscriber defined account number
    printer subscriberReferenceId N string ID for the destination account created by the subscriber (Max length:45)
  printer bancBoxPayeeId N Long If the destination is payee, then specify the Finxera Payee Id.
  printer newPayee N Object If the destination is payee that has not yet been created, then fill out the newPayee parameters.
    printer payeeAccountNumber Y String Payee Account Number (Max Length:45)
    printer memo N String Memo (Max Length:128)
    printer payee N Object Specify the payment details for the new payee. {check, paypal, ach}.
      printer check Y Object Payee Account Number
        printer name Y String Name (Max length:45)
        printer address Y Object Address
          printer line1 Y String Line1 (Max length:128)
          printer line2 N String Line2 (Max length:128)
          printer city Y String City (Max length:45)
          printer state Y String State
          printer zipcode Y String Zipcode
      printer paypal Y Object Paypal details
        printer id Y String Paypal account Id (Max length:45)
      printer ach Y Object Ach
        printer routingNumber Y String Routing Number (Max length:45)
        printer accountNumber Y String Account Number (Max Length:45)
        printer holderName Y String Holder Name (Max length:45)
        printer bankAccountType Y String specify one of the following bankAccountType {'SAVING','CHECKING'}
  printer newExternalAccount N Object If the destination is a new external account that has not yet been linked previously, then fill out the newExternalAccount parameters.
    printer account N Object Specify details for the new external account, {bankAccount, paypalAccount, creditCardAccount}
      printer bankAccount N Object Bank Account
        printer routingNumber Y String Routing Number (Max length:45)
        printer accountNumber Y String Account Number (Max Length:45)
        printer holderName Y String Holder Name (Max length:45)
        printer bankAccountType Y String specify one of the following bankAccountType {'SAVING','CHECKING'}
      printer paypalAccount Y Object Paypal
        printer id Y String Paypal account Id (Max length:45)
  printer linkedPayeeId N Object If the destination is to a linked payee, then specify either the bancBoxId or the subscriberReferenceId.
    printer bancBoxId Y long ID used by Finxera for this linked payee.
    printer subscriberReferenceId N string ID for the linked payee created by the subscriber (Max length:45)
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)
method Y Object Specify a method as an empty parameter, {'check', 'wire' ,'book', 'ach', 'paypal', 'billpay'}
  printer paypal Y Object Paypal
  printer ach Y Object Ach
  printer book Y Object Book
  printer billpay Y Object Billpay
  printer check Y Object Check
    printer type Y String specify one of the following types { 'STD', 'TWODAY', 'OVERNIGHT', 'PLUS' }
  printer wire Y Object Wire
items Y Object Items
  printer referenceId N String Subscriber created reference ID for the send fee transaction (Max length:45)
  printer memo N String Memo (Max Length:128)
  printer amount Y double Amount (Max Value:9999999999999.995)
  printer scheduled Y Object If scheduled parameter is included, the transaction will take place on the specified date. Otherwise, it will be executed immediately. Repeat for several transactions.
    printer scheduleDate Y date Schedule Date[YYYY-MM-DD]
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
  printer id   Object The ID for the send funds transaction.
    printer bancBoxId   long The ID for the transaction used by Finxera.
    printer subscriberReferenceId   string ID for the transaction specified by the subscriber in the request.
  printer status   int Describes status of the transaction, pending or scheduled.
  printer messageCode   String Message code
  printer messageDesc   String Message description
  printer code   String Error code
  printer message   String Error message
  printer itemStatus   int Status of transaction, 0 for fail, 1 for pass.
Related Errors
Parameter Short error messge Description
No records
XML Examples
Request XML
Response XML
© 2013 BancBox.com. All Rights Reserved.