For AI agents: markdown of this page — /docs-content-en/entities/pay-systems/delete.md documentation index — /llms.txt

Delete a pay system

DELETE /v1/pay-systems/:id

Deletes a pay system by ID. Deleted records cannot be restored through the API.

Parameters

Parameter Type Required Description
Parameterid (path) Typeinteger Requiredyes DescriptionPositive integer ID of the pay system. Source: GET /v1/pay-systems.

Examples

curl — personal key

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/pay-systems/41" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/pay-systems/41" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/pay-systems/41', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/pay-systems/41', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Response fields

HTTP 200.

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success.
Fielddata Typeboolean Descriptiontrue when deletion is confirmed.

Response example

JSON 
{
  "success": true,
  "data": true
}

Error response example

404 — the pay system was not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Entity not found"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS Descriptionid is not a positive integer.
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe pay system does not exist.
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionInsufficient permissions, a built-in pay system, or the OAuth application does not own the handler.
HTTP422 CodeBITRIX_ERROR DescriptionA business error occurred. Details are in error.message.
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionThe response to the operation has an invalid structure.
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the pay_system scope.
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key is restricted to read operations.
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured Bitrix24 credentials.

For common API errors, see Error codes.

See also