Finxera

Back to documentation index

deleteLinkedExternalAccount

Use the delete linked external account API to delete a linked external account.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
+ linkedExternalAccountId Y Object Specify either the bancBoxId or the subscriberReferenceId for the linked external account.

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.

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>
<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:deleteLinkedExternalAccount>
         <deleteLinkedExternalAccountRequest>
            <subscriberId>?</subscriberId>
            <linkedExternalAccountId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </linkedExternalAccountId>
         </deleteLinkedExternalAccountRequest>
      </sch:deleteLinkedExternalAccount>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

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

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

Sample Request

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

Sample Response

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

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