Finxera

Back to documentation index

getAccountActivity

Get all transaction activity on a specified account.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
+ accountId Y Object Specify either bancBoxId or subscriberReferenceId for the account desired.
fromDate N date List transaction activity ending on date[YYYY-MM-DD].
toDate N date List transaction activity starting from 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.
+ warnings   Object A Warning object containing a code and description.
+ errors   Object Request failed, error response.
+ activities   Object Lists activities for the account specified in the request.

WSDL URL (Production) :  https://api.bancbox.com/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/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:getAccountActivity>
         <getAccountActivityRequest>
            <subscriberId>?</subscriberId>
            <accountId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </accountId>
            <!--Optional:-->
            <fromDate>?</fromDate>
            <!--Optional:-->
            <toDate>?</toDate>
         </getAccountActivityRequest>
      </sch:getAccountActivity>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<sch:getAccountActivityResponse>
         <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>
            <!--Zero or more repetitions:-->
            <activities>
	       <traceId>?</traceId>
               <!--Optional:-->
               <activityDate>?</activityDate>
               <!--Optional:-->
               <description>?</description>
               <!--Optional:-->
               <debitAmount>?</debitAmount>
               <!--Optional:-->
               <creditAmount>?</creditAmount>
               <!--Optional:-->
               <balance>?</balance>
            </activities>
         </return>
</sch:getAccountActivityResponse>

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": ? ,
    "accountId" : {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "fromDate": "?",
    "toDate": "?"
}

Sample Response

{
    "activities": [{
        "traceId": "?",
        "activityDate": "?",
        "description": "?",
        "debitAmount": ? ,
        "creditAmount" : ? ,
        "balance" : ?
    }],
    "requestId": ? ,
    "status" : ? ,
    "warnings" : [{
        "code": "?",
        "message": "?"
    }],
    "errors": [{
        "code": "?",
        "message": "?"
    }]
}