Finxera

Back to documentation index

openAccount

This method allows a subscriber to open a Finxera account under a specified client.
 View Demo

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
+ clientId Y Object Specify either the bancBoxId or subscriberReferenceId parameter.
referenceId N String Subscriber created reference ID for the account (Max length:45)
title N String Name of the Finxera account (Max length:45)
accountType N String Responds with one of the following accountType { 'GENERAL', 'SPECIAL'}
+ routable N Object Routable Status
subscriberAccountNumber N bigInt Enter the account number using the prefix assigned. The min length of the account number should be 7 digits (including prefix) and the max length should be 17 digits (including prefix)

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.
+ warnings   Object A Warning object containing a code and description.
+ errors   Object Request failed, error response.
+ account   Object Account

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

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
 <soapenv:Header/>
   <soapenv:Body>
      <sch:openAccount>
         <openAccountRequest>
            <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Optional:-->
            <referenceId>?</referenceId>
            <!--Optional:-->
            <title>?</title>
            <!--Optional:-->
            <accountType>?</accountType>
            <!--Optional:-->
            <routable>
               <!--Optional:-->
               <credits>?</credits>
               <!--Optional:-->
               <debits>?</debits>
            </routable>
            <!--Optional:-->
            <subscriberAccountNumber>?</subscriberAccountNumber>
         </openAccountRequest>
      </sch:openAccount>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<sch:openAccountResponse>
        <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:-->
            <account>
               <!--Optional:-->
               <id>
                  <!--Optional:-->
                  <bancBoxId>?</bancBoxId>
                  <!--Optional:-->
                  <subscriberReferenceId>?</subscriberReferenceId>
               </id>
		<!--Optional:-->
               <accountType>?</accountType>
               <!--Optional:-->
	       <routable>
		  <!--Optional:-->
                  <credits>?</credits>
		  <!--Optional:-->
                  <debits>?</debits>
               </routable>
               <routingNumber>?</routingNumber>
               <!--Optional:-->
               <status>?</status>
            </account>
         </return>
</sch:openAccountResponse> 

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": ? ,
    "clientId" : {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "referenceId": "?",
    "title": "?",
    "accountType":"?",
    "routable": {
        "credits": "?",
        "debits": "?"
    },
    "subscriberAccountNumber":""
}

Sample Response

{
    "account": {
        "id": {
            "bancBoxId": ? ,
            "subscriberReferenceId" : "?"
        },
       "accountType" : "?",
        "routable": {
            "credits": "?",
            "debits": "?"
        },
        "routingNumber": "?",
        "status": "?"
    },
    "requestId": ? ,
    "status" : ? ,
    "warnings" : [{
        "code": "?",
        "message": "?"
    }],
    "errors": [{
        "code": "?",
        "message": "?"
    }]
}

Note: This is a beta version. The api listed here are likely to change.