Finxera

Back to documentation index

cancelSchedules

The cancelSchedules method allows you to cancel any scheduled transaction items that have not yet been executed. This method gives you the ability to cancel one or more items in a single request by passing in either the Finxera schedule id (issued when the scheduled item was created) or the reference identifier you assigned to the item when you scheduled it.

Request Parameters

  Parameter Required Type Description
subscriberId Y long Specify subscriber ID issued when Finxera account is created.
+ scheduleId Y Object Specify the schedule ID parameter to create a list of information on a specific schedule. Define either bancBoxId or subscriberReferenceId. Repeat several times to cancel more than one schedule.

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 cancelled by 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:cancelSchedules>
         <cancelSchedulesRequest>
             <subscriberId>?</subscriberId>
            <!--1 or more repetitions:-->
            <scheduleIds>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </scheduleIds>
         </cancelSchedulesRequest>
      </sch:cancelSchedules>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<sch:cancelSchedulesResponse>
         <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:-->
               <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>
            </schedules>
         </return>
</sch:cancelSchedulesResponse>

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": ? ,
    "scheduleIds" : [{
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    }]
}

Sample Response

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