Finxera

Back to documentation index

linkFile

Use the linkFile API to attach a file to a client.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
+ clientId Y Object Define either bancBoxId or subscriberReferenceId parameter
referenceId N String subscriber set ID for the file being created (Max length:45)
+ file Y Object File

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.
+ id   Object id

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>
<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:linkFile>
         <linkFileRequest>
             <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Optional:-->
            <referenceId>?</referenceId>
            <file>
               <!--Optional:-->
               <name>?</name>
               <!--Optional:-->
               <fileClass>?</fileClass>
               <!--Optional:-->
               <url>?</url>
               <!--Optional:-->
               <content>cid:912263605697</content>
               <!--Optional:-->
               <comment>?</comment>
            </file>
         </linkFileRequest>
      </sch:linkFile>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<sch:linkFileResponse>
      <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:-->
            <id>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </id>
       </return>

</sch:linkFileResponse>

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": "",
    "clientId": {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "referenceId": "?",
    "fileRestRequest": {
        "name": "?",
        "fileClass": "?",
        "url": "",
        "content": "?",
        "comment": "?"
    }
}

Sample Response

{ 
  "id" : { 
    "bancBoxId" : ?, 
    "subscriberReferenceId" : "?" 
  }, 
  "requestId" : ?, 
  "status" : ?, 
  "warnings" : [ { 
    "code" : "?", 
    "message" : "?" 
  } ], 
  "errors" : [ { 
    "code" : "?", 
    "message" : "?" 
  } ] 
}

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