Guides

Suspend customer [Private]

After executing of request to this endpoint, the customer whose ID was used for this is going to be marked as "Suspended". This means that any actions (financial or non-financial) in the future are not possible for this customer. In fact, assigning this status means removing it from the active list.

Suggest Edits
Method name:/v2/customer/suspend
Request type:POST

The counterparty will not be displayed as a result of executing a request on /v2/customer/find, /v2/customer/detail, /v2/customer/update.

📘

To call private endpoints, you need to get a JWT token or an API key for authentication.

Here you can learn in detail how to successfully authenticate.

Data dictionary

NameTypeParameter typeRequiredRangeDescription
idstringBODYNO-Customer ID.

Exemplary request

const url = BASE_URL;
const path = "/v2/customer/suspend";

const body = {
  id: "6d962783-f0cf-420d-a511-3a48c71c5595"
};

const options = {
  method: "POST",
  headers: {
    accept: "application/json",
    "Content-Type": "application/json",
    "Authorization": `Bearer ${data.accessToken}` // data.accessToken - generated a JWT token via /v2/auth/login.
  },
  body: JSON.stringify(body),
};

fetch(url + path, options)
  .then((response) => response.json())
  .then((showResponse) => console.log(showResponse.data));

import requests

url = BASE_URL
path = "/v2/customer/suspend"
headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "Authorization": "Bearer " + data.accessToken # data.accessToken - generated a JWT token via /v2/auth/login.
}
body = {
    "id": "6d962783-f0cf-420d-a511-3a48c71c5595"
};

request = requests.post(url + path, headers=headers, json=body)
print(request.json())

How to call private endpoints here

Swagger here

Response

{
  "data": {
    "success": true
  }
}

Updated 6 months ago