Close Account

Last changes: 10-28-2022

The API request 1.73 Close Account will set the status of the account to "CLOSED" and no further interaction with the account will be possible following closure.

Closing an account is an irreversible action, following the closure of an account it cannot be used any longer.

When Closing an Account will automatically add a new GUID to the Email Address and External Account Reference, so the same user can later be registered again, if necessary.

In the example below, we close the account associated with the External Account Reference KDNR0001.

Additionally, state reason for the closing the account under the parameter “closingReason”.

Close Account Request

Path:: POST {baseURL}/account/KDNR0001/close
Header:: Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
    "partnerReference": "DEV-SVR001-DE_CUSTID-VW7T78J33B_CARTID-32RKRCWCR2_CY46K6X9VV",
    "programCode": "COMPANYDE",
    "accnoType": "00",
    "closingReason": "Account holder requesting closure of account.",
    "localDate": "2018-11-06",
    "localTime": "104915"
}

Close Account Response

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
    "accno": "KDNR0001",
    "statusCode": "CLOSED",
    "dateClosed": "2018-11-06",
    "programCode": "COMPANYDE",
    "partnerReference": "DEV-SVR001-DE_CUSTID-VW7T78J33B_CARTID-32RKRCWCR2_CY46K6X9VV",
    "localDate": "2018-11-06",
    "localTime": "104915",
    "sysDate": "2018-11-06",
    "sysTime": "094915",
    "responseCode": "0000",
    "responseDescription": "Successful execution",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

The response includes the account status under the return parameter “statusCode”, which at this point should be set to “CLOSED”. The "responseCode" 0000 and the “responseDescription” indicate that the account has been successfully closed.

Previous

Next