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.
The getSchedules API supports Pagination.Please refer the request and response packet for details.

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 Specify either the account Id(Finxera generated Account Number or the subscriber defined account number) or the subscriberReference ID for the account.
type N String Select one of the following type { 'COLLECT', 'SEND', 'TRANSFER', 'FEE', 'CHARGEBACK' }
+ 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]
fromAmount N Float Enter from Amount
toAmount N Float Enter To Amount
method N String Enter Method [ACH, WIRE, CHECK, CREDITCARD, EBP]
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 Results 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 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.
+ schedules   Object Schedules
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:getSchedules>
         <getSchedulesRequest>
            <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:-->
            <fromAmount>?</fromAmount>
            <!--Optional:-->
            <toAmount>?</toAmount>
            <!--Optional:-->
            <method>?</method>
            <!--Optional:-->
            <status>?</status>
            <!--Optional:-->
            <order>?</order>
            <!--Optional:-->
            <ascending>true</ascending>
            <!--Optional:-->
            <pageNo>?</pageNo>
            <!--Optional:-->
            <resultsPerPage>?</resultsPerPage>
         </getSchedulesRequest>
      </sch:getSchedules>
   </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: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>
            <!--Optional:-->
            <currentPage>?</currentPage>
            <!--Optional:-->
            <totalPages>?</totalPages>
            <!--Optional:-->
            <totalRecords>?</totalRecords>
            <!--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:-->
               <messageCode>?</messageCode>
               <!--Optional:-->
               <messageDesc>?</messageDesc>
               <!--Optional:-->
               <externalReferenceId>?</externalReferenceId>
               <!--Optional:-->
               <merchantId>?</merchantId>
               <!--Optional:-->
               <parentScheduleId>?</parentScheduleId>
               <!--Optional:-->
               <source>
                  <!--Optional:-->
                  <account>
                     <!--Optional:-->
                     <bancBoxId>?</bancBoxId>
                     <!--Optional:-->
                     <subscriberReferenceId>?</subscriberReferenceId>
                  </account>
                  <!--Optional:-->
                  <sourceType>?</sourceType>
                  <!--Optional:-->
                  <linkedExternalAccountId>
                     <!--Optional:-->
                     <bancBoxId>?</bancBoxId>
                     <!--Optional:-->
                     <subscriberReferenceId>?</subscriberReferenceId>
                  </linkedExternalAccountId>
                  <!--Optional:-->
                  <newExternalAccount>
                     <account>
                        <!--Optional:-->
                        <bankAccount>
                           <routingNumber>?</routingNumber>
                           <accountNumber>?</accountNumber>
                           <holderName>?</holderName>
                           <bankAccountType>?</bankAccountType>
                        </bankAccount>
                        <!--Optional:-->
                        <paypalAccount>
                           <id>?</id>
                        </paypalAccount>
                        <!--Optional:-->
                        <creditCardAccount>
                           <number>?</number>
                           <type>?</type>
                           <name>?</name>
                           <address>
                              <line1>?</line1>
                              <!--Optional:-->
                              <line2>?</line2>
                              <city>?</city>
                              <state>?</state>
                              <zipcode>?</zipcode>
                           </address>
                        </creditCardAccount>
                     </account>
                  </newExternalAccount>
               </source>
               <!--Optional:-->
               <destination>
                  <!--Optional:-->
                  <account>
                     <!--Optional:-->
                     <bancBoxId>?</bancBoxId>
                     <!--Optional:-->
                     <subscriberReferenceId>?</subscriberReferenceId>
                  </account>
                  <!--Optional:-->
                  <destinationType>?</destinationType>
                  <!--Optional:-->
                  <linkedExternalAccountId>
                     <!--Optional:-->
                     <bancBoxId>?</bancBoxId>
                     <!--Optional:-->
                     <subscriberReferenceId>?</subscriberReferenceId>
                  </linkedExternalAccountId>
                  <!--Optional:-->
                  <linkedPayeeId>
                     <!--Optional:-->
                     <bancBoxId>?</bancBoxId>
                     <!--Optional:-->
                     <subscriberReferenceId>?</subscriberReferenceId>
                  </linkedPayeeId>
                  <!--Optional:-->
                  <bancBoxPayeeId>?</bancBoxPayeeId>
                  <!--Optional:-->
                  <payeeAccountNumber>?</payeeAccountNumber>
                  <!--Optional:-->
                  <newExternalAccount>
                     <account>
                        <!--Optional:-->
                        <bankAccount>
                           <routingNumber>?</routingNumber>
                           <accountNumber>?</accountNumber>
                           <holderName>?</holderName>
                           <bankAccountType>?</bankAccountType>
                        </bankAccount>
                        <!--Optional:-->
                        <paypalAccount>
                           <id>?</id>
                        </paypalAccount>
                        <!--Optional:-->
                        <creditCardAccount>
                           <number>?</number>
                           <type>?</type>
                           <name>?</name>
                           <address>
                              <line1>?</line1>
                              <!--Optional:-->
                              <line2>?</line2>
                              <city>?</city>
                              <state>?</state>
                              <zipcode>?</zipcode>
                           </address>
                        </creditCardAccount>
                     </account>
                  </newExternalAccount>
                  <!--Optional:-->
                  <newPayee>
                     <payeeAccountNumber>?</payeeAccountNumber>
                     <!--Optional:-->
                     <memo>?</memo>
                     <payee>
                        <!--Optional:-->
                        <ach>
                           <routingNumber>?</routingNumber>
                           <accountNumber>?</accountNumber>
                           <holderName>?</holderName>
                           <bankAccountType>?</bankAccountType>
                        </ach>
                        <!--Optional:-->
                        <paypal>
                           <id>?</id>
                        </paypal>
                        <!--Optional:-->
                        <check>
                           <name>?</name>
                           <address>
                              <line1>?</line1>
                              <!--Optional:-->
                              <line2>?</line2>
                              <city>?</city>
                              <state>?</state>
                              <zipcode>?</zipcode>
                           </address>
                        </check>
                     </payee>
                  </newPayee>
               </destination>
               <isCancellationAllowed>?</isCancellationAllowed>
            </schedules>
         </return>
      </sch:getSchedulesResponse>
   </soapenv:Body>
</soapenv:Envelope>

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

Sample Request

{
 "authentication": 
    { 
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
        }, 
    "subscriberId":,
    "type":""
    "scheduleId":"",
    "scheduleStartDate":""
    "scheduleEndDate":""
    "modifiedOnStartDate":""
    "modifiedOnEndDate":""
    "fromDate":"",
    "toDate":"",
    "type":"",
    "method":"",
    "fromAmount":,
    "toAmount":,
    "status":"",
    "order":"",
    "Ascending":"true",
    "pageNo":"",
    "resultsPerPage":


}

Sample Response

{
   "currentPage":,
   "totalPages": ,
   "totalRecords":,
   "schedules": [   {
      "id":       {
         "bancBoxId":,
         "subscriberReferenceId": ""
      },
      "type": "",
      "amount":,
      "scheduleDate": "",
      "modifiedOn": "",
      "createdOn": "",
      "status": "",
      "externalReferenceId": "",
      "merchantId": "",
      "source":       {
         "sourceType": "",
         "newExternalAccount": {"account": {"creditCardAccount":          {
            "number": "",
            "type": "",
            "name": "",
            "address":             {
               "line1": "",
               "line2": "",
               "city": "",
               "state": "",
               "zipcode": ""
            }
         }}}
      },
      "destination": {"account": {"bancBoxId": }}
 "isCancellationAllowed": "" 
   }],
   "requestId":,
   "status": ,
   "warnings": null
}

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