Finxera

Back to documentation index

getSchedules

Use the getSchedules API to get a list of transactions that are scheduled or in process. Create a list of transactions for a single client, a single account, according to type, or when it was modified or scheduled.

Request Parameters

  Parameter Required Type Description
subscriberId Y long Specify subscriber ID issued when Finxera account is created.
+ clientId N Object Define either bancBoxId or subscriberReferenceId parameter
+ accountId N Object If a list of transactions for a single account is desired, then specify either bancBoxId or subscriberReferenceId.
type N String Specify one of the following types { 'COLLECT', 'SEND', 'TRANSFER', 'FEE' }
+ scheduleId N Object Specify the schedule ID parameter to create a list of information on a specific schedule. Define either bancBoxId or subscriberReferenceId.
scheduleStartDate N dateTime List the transactions scheduled starting from date[YYYY-MM-DDTHH:MM:S]
scheduleEndDate N dateTime List the transactions scheduled ending on date[YYYY-MM-DDTHH:MM:S]
modifiedOnStartDate N dateTime List the transactions modified starting from date[YYYY-MM-DDTHH:MM:S]
modifiedOnEndDate N dateTime List the transactions modified ending on date[YYYY-MM-DDTHH:MM:S]
status N String Specify the status of the transaction, { 'SCHEDULED', 'COMPLETED', 'FAILED', 'PENDING', 'IN_PROCESS' }
order N String Specify the order of the list is desired, {'ID' ,'SCHEDULED_DATE', 'MODIFIED_ON'}
ascending N boolean Schedules listed in ascending order {true} or descending order {false}
pageNo N int Page number of the list, see resultsPerPage.
resultsPerPage N Int Specify how many schedules will be listed at a time.

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.
+ schedules   Object Schedules

WSDL URL (Production) :  https://api.bancbox.com/v1/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/v1/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:getClientSchedules>
          <getClientSchedulesRequest>
             <subscriberId>?</subscriberId>
            <!--Optional:-->
             <clientId>
                <!--Optional:-->
                <bancBoxId>?</bancBoxId>
                <!--Optional:-->
                <subscriberReferenceId>?</subscriberReferenceId>
             </clientId>
             <!--Optional:-->
             <accountId>
                <!--Optional:-->
                <bancBoxId>?</bancBoxId>
                <!--Optional:-->
                <subscriberReferenceId>?</subscriberReferenceId>
             </accountId>
             <!--Optional:-->
             <type>?</type>
             <!--Optional:-->
             <scheduleId>
                <!--Optional:-->
                <bancBoxId>?</bancBoxId>
                <!--Optional:-->
                <subscriberReferenceId>?</subscriberReferenceId>
             </scheduleId>
             <!--Optional:-->
             <scheduleStartDate>?</scheduleStartDate>
             <!--Optional:-->
             <scheduleEndDate>?</scheduleEndDate>
             <!--Optional:-->
             <modifiedOnStartDate>?</modifiedOnStartDate>
             <!--Optional:-->
             <modifiedOnEndDate>?</modifiedOnEndDate>
             <!--Optional:-->
             <status>?</status>
            <!--Optional:--> 
            <order>?</order> 
            <!--Optional:--> 
            <ascending>true</ascending> 
            <!--Optional:--> 
            <pageNo>?</pageNo> 
            <!--Optional:--> 
            <resultsPerPage>?</resultsPerPage> 
          </getClientSchedulesRequest>
       </sch:getClientSchedules>
    </soapenv:Body>
 </soapenv:Envelope>

Sample Response

<sch:getSchedulesResponse>
         <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:-->
            <schedules>
               <!--Optional:-->
               <id>
                  <!--Optional:-->
                  <bancBoxId>?</bancBoxId>
                  <!--Optional:-->
                  <subscriberReferenceId>?</subscriberReferenceId>
               </id>
               <!--Optional:-->
               <type>?</type>
               <!--Optional:-->
               <amount>?</amount>
               <!--Optional:-->
               <scheduleDate>?</scheduleDate>
               <!--Optional:-->
               <modifiedOn>?</modifiedOn>
               <!--Optional:-->
               <createdOn>?</createdOn>
               <!--Optional:-->
               <status>?</status>
	       <!--Optional:-->
               <externalReferenceId>?</externalReferenceId>
            </schedules>
         </return>
</sch:getSchedulesResponse>

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": ? ,
    "clientId" : {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "accountId": {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "type": "?",
    "scheduleId": {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "scheduleStartDate": "?",
    "scheduleEndDate": "?",
    "modifiedOnStartDate": "?",
    "modifiedOnEndDate": "?",
    "status": "?",
    "order": "?",
    "ascending": ? ,
    "pageNo" : ? ,
    "resultsPerPage" : ?
}

Sample Response

{
    "schedules": [{
        "id": {
            "bancBoxId": ? ,
            "subscriberReferenceId" : "?"
        },
        "type": "",
        "amount": ? ,
        "scheduleDate" : "?",
        "modifiedOn": "?",
        "createdOn": "?",
        "status": "?",
        "externalReferenceId" : "?"
    }],
    "requestId": ? ,
    "status" : ? ,
    "warnings" : [{
        "code": "?",
        "message": "?"
    }],
    "errors": [{
        "code": "?",
        "message": "?"
    }]
}