Back to documentation index


The closeAccount method allows you to close an account for a client. This method will not let you close an account that has a current balance. If you wish to close an account that has a current balance, you can sweep the account prior to invoking closeAccount using sendFunds, or you can specify a withdrawal method and destination in the request itself.

Request Parameters

  Parameter Required Type Description
subscriberId Y long Specify subscriber ID issued when Finxera account is created.
+ accountId Y Object Specify either bancBoxId or subscriberReferenceId for the account desired.
withdrawalMethod Y String If it is necessary to sweep an account before it is cancelled, then specify the type of withdrawal desired { 'ACH', 'CHECK', 'PAYPAL' }
checkMethodType N string Specify the speed of the withdrawal { 'STD', 'TWODAY', 'OVERNIGHT', 'PLUS' }
+ withdrawalAccount Y Object Fill in the information for the destination of the withdrawal, choose one of: linkedAccountId, bankAccount, checkAddress.

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.
balance   double Balance
withdrawalAmount   double Withdrawal amount
expectedDate   date Expected date[YYYY-MM-DD]
withdrawalMethod   String Responds with one of the following withdrawalMethods { 'ACH', 'CHECK', 'PAYPAL' }
checkMethodType   String Responds with one of the following checkMethodType { 'STD', 'TWODAY', 'OVERNIGHT', 'PLUS' }

WSDL URL (Production) :
WSDL URL (SandBox) :

Sample Request

<soapenv:Envelope xmlns:soapenv="" xmlns:sch="">
<wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="">
<wsse:UsernameToken wsu:Id="XWSSGID-1261544568770-474929336" xmlns:wsu="">
<wsse:Password Type="">sample</wsse:Password>
               <!--You have a CHOICE of the next 3 items at this level--> 

Sample Response

            <!--Zero or more repetitions:-->
            <!--Zero or more repetitions:-->
            <!--Zero or more repetitions:-->


Note:For REST, Content-type should be set to application/json
URL (Production) :
URL (SandBox) :

Sample Request


Sample Response

    "balance": ? ,
    "withdrawalAmount" : ? ,
    "expectedDate" : "?",
    "withdrawalMethod": "?",
    "requestId": ? ,
    "status" : ? ,
    "warnings" : [{
        "code": "?",
        "message": "?"
    "errors": [{
        "code": "?",
        "message": "?"