Pay systems

Select a payment system or a delivery service. Create your own records using a registered REST handler. Scope: pay_system.

Built-in services are readable. Bitrix24 permits updates and deletion only for REST-handler records; OAuth applications are also checked against handler ownership. The sale scope alone is insufficient.

GET /v1/pay-systems

GET /v1/pay-systems

Bitrix24: sale.paysystem.list. Scope: pay_system.

Parameters

Optional filter (JSON or bracket), sort (comma-separated fields, minus for DESC), select (comma-separated fields or *). Only section fields; unknown fields return 400 before dispatch. Filters support equality, $eq, and arrays of values/$in. Other operators return 400 INVALID_FILTER_OPERATOR because Bitrix24 silently drops them and applies equality. No pagination.

Examples

cURL personal key

curl -X GET "https://vibecode.bitrix24.com/v1/pay-systems" -H "X-Api-Key: $VIBE_API_KEY"

cURL OAuth

curl -X GET "https://vibecode.bitrix24.com/v1/pay-systems" -H "X-Api-Key: $VIBE_API_KEY" -H "Authorization: Bearer $APP_SESSION"

JavaScript personal key

const response = await fetch("https://vibecode.bitrix24.com/v1/pay-systems", {
  method: "GET",
  headers: {"X-Api-Key": "YOUR_API_KEY"},
});
console.log(await response.json());

JavaScript OAuth

const response = await fetch("https://vibecode.bitrix24.com/v1/pay-systems", {
  method: "GET",
  headers: {"X-Api-Key": "YOUR_API_KEY", "Authorization": "Bearer YOUR_APP_SESSION"},
});
console.log(await response.json());

Response fields

success is true. data is a record or an array of fields; DELETE returns true. Delivery creation returns parent and profiles. List meta.total equals data length. This example illustrates the shape; record IDs depend on the account.

{
  "success": true,
  "data": [
    {
      "id": 10,
      "name": "VIBE-PROBE example",
      "active": "N"
    }
  ],
  "meta": {
    "total": 1
  }
}

Errors

422 for an unknown handler (error shape example):

{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Handler not found"
  }
}

Errors

See also

• Pay systems
• Handlers