Finxera

Back to documentation index

getAccountActivity

Get all transaction activity on a specified account. The getAccountActivity API supports Pagination

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created
+ accountId Y Object Specify either the account Id(Finxera generated Account Number or the subscriber defined account number) or the subscriberReference ID for the account
fromDate N date List transaction activity starting from date[YYYY-MM-DD].
toDate N date List transaction activity ending on date[YYYY-MM-DD].
type N String Specify one of the following types (DEBIT, CREDIT)
method N String Specify one of the following Methods (ACH,WIRE,CHECK,CREDITCARD,EBP)
fromAmount N Float Enter From Amount
toAmount N Float Enter To Amount
status N Float Specify one of the following statuses (COMPLETED, FAILED)
ascending N boolean Results listed in ascending order {true} or descending order {false}
pageNo N Int Enter the Page No
resultsPerPage N Int Specify how many results would be listed in a page

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.
currentPage   Int Current Page Number.
totalPages   Int Total pages in the response.
totalRecords   Int Total no of records in the response.

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:getAccountActivity>
         <getAccountActivityRequest>
            <subscriberId>?</subscriberId>
            <accountId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </accountId>
            <!--Optional:-->
            <fromDate>?</fromDate>
            <!--Optional:-->
            <toDate>?</toDate>
            <!--Optional:-->
            <type>?</type>
            <!--Optional:-->
            <method>?</method>
            <!--Optional:-->
            <fromAmount>?</fromAmount>
            <!--Optional:-->
            <toAmount>?</toAmount>
            <!--Optional:-->
            <status>?</status>
            <!--Optional:-->
            <ascending>false</ascending>
            <!--Optional:-->
            <pageNo>?</pageNo>
            <!--Optional:-->
            <resultsPerPage>?</resultsPerPage>
         </getAccountActivityRequest>
      </sch:getAccountActivity>
   </soapenv:Body>
</soapenv:Envelope> 

Sample Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
   <soapenv:Header/>
   <soapenv:Body>
      <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>
            <!--Optional:-->
            <currentPage>?</currentPage>
            <!--Optional:-->
            <totalPages>?</totalPages>
            <!--Optional:-->
            <totalRecords>?</totalRecords>
            <!--Zero or more repetitions:-->
            <activities>
               <!--Optional:-->
               <traceId>?</traceId>
               <!--Optional:-->
               <type>?</type>
               <!--Optional:-->
               <activityDate>?</activityDate>
               <!--Optional:-->
               <description>?</description>
               <!--Optional:-->
               <debitAmount>?</debitAmount>
               <!--Optional:-->
               <creditAmount>?</creditAmount>
               <!--Optional:-->
               <balance>?</balance>
               <!--Optional:-->
               <transactionLedgerId>?</transactionLedgerId>
               <!--Optional:-->
               <activityId>?</activityId>
               <!--Optional:-->
               <subTransactionReferenceId>?</subTransactionReferenceId>
            </activities>
         </return>
      </sch:getAccountActivityResponse>
   </soapenv:Body>
</soapenv:Envelope>

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
	"subscriberId":,
	 "accountId":
	  {
	"bancBoxId":
	"subscriberReferenceId":""
	  },
	"fromDate":"",
	"toDate":"",
	"type":"",
	"method":"",
	"fromAmount":,
	"toAmount":,
	"status":"",
	"ascending":"false",
	"pageNo":"",
	"resultsPerPage":
}

Sample Response

{ "activities" : [ {
	"activityDate" : "",
        "activityId" : "",
        "balance" : "",
        "creditAmount" : "",
        "debitAmount" : "",
        "description" : "",
        "subTransactionReferenceId" : "",
        "traceId" : "",
        "transactionLedgerId" : "",
        "type" : ""
      } ],
  "currentPage" : "",
  "requestId" : "",
  "status" : "",
  "totalPages" : "",
  "totalRecords" : "",
  "warnings" : null
}

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