Skip to main content

Close Account

The API method Close Account enables you closing an existing account, created previously through a checkout API call, under the provided "customerAccountId" input parameter.

API Request Parameters

FieldMandatoryDescriptionTypeLength
closingReasonYesThe reason why the account is being closed.String255
info

The request must have the following headers:

  • Content-Type: application/json
  • Accept-Language: en-US
  • Origin: { Origin }

Request

Specify the customerAccountId in the URL.

Path:

DELETE {Base URL}/accounts/{customerAccountId}

Header:

Content-Type: application/json
Accept-Language: en-US
{
"merchantKey": "73afeb44-432e-4b91-be37-a6b3d2fb7447",
"closingReason": "test close account"
}

API Response Parameters

Response structure

FieldDescriptionType
responseDescriptionResponse descriptionString
closingDateThe request closing dateString
closingTimeThe request closing timeString

Response Sample

Header:

Content-Type: application/json
Accept-Language: en-US
{
"closingDate": "2022-05-21",
"closingTime": "164500",
"responseDescription": "Successful execution."
}