Finxera

Back to documentation index

updateClientStatus

Use to update the status of a client. The status can be ACTIVE, INACTIVE, SUSPENDED or DELETED.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
+ clientId N Id Define either bancBoxId or subscriberReferenceId parameter.
clientStatus Y String Specify one of the following statuses for the client {'ACTIVE', 'INACTIVE', 'SUSPENDED', 'DELETED'}

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.
newStatus   string The new status that the client status has been changed to.

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>Username</wsse:Username> 
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Password</wsse:Password> 
         </wsse:UsernameToken> 
      </wsse:Security></soapenv:Header> 
   <soapenv:Body> 
   <soapenv:Body> 
      <sch:updateClientStatus> 
         <updateClientStatusRequest> 
            <subscriberId>?</subscriberId> 
            <!--Optional:--> 
            <clientId> 
               <!--Optional:--> 
               <bancBoxId>?</bancBoxId> 
               <!--Optional:--> 
               <subscriberReferenceId>?</subscriberReferenceId> 
            </clientId> 
            <clientStatus>?</clientStatus> 
         </updateClientStatusRequest> 
      </sch:updateClientStatus> 
   </soapenv:Body> 
</soapenv:Envelope>

Sample Response

<sch:updateClientStatusResponse> 
       <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:--> 
            <newStatus>?</newStatus> 
         </return> 
</sch:updateClientStatusResponse>

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": ,
    "clientId": {
        "bancBoxId": ,
        "subscriberReferenceId": ""
    },
    "clientStatus": ""
}

Sample Response

{
    "newStatus": "?",
    "requestId": ? ,
    "status" : ? ,
    "warnings" : [{
        "code": "?",
        "message": "?"
    }],
    "errors": [{
        "code": "?",
        "message": "?"
    }]
}