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

List pay system handlers

GET /v1/pay-systems/handlers

Choose a registered REST handler when creating a pay system in your Bitrix24 account.

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

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

const { success, data, meta } = await response.json()
console.log(data)

JavaScript — OAuth application

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

const { success, data, meta } = await response.json()
console.log(data)

Response fields

Field Type Required Description
Fieldsuccess Typeboolean Requiredyes Descriptiontrue for a successful request
Fielddata Typearray Requiredyes DescriptionList of registered REST handlers for pay systems
Fielddata[].id Typeinteger Requiredno DescriptionHandler ID
Fielddata[].name Typestring Requiredno DescriptionHandler name
Fielddata[].code Typestring Requiredno DescriptionHandler code
Fielddata[].sort Typeinteger Requiredno DescriptionHandler sort value
Fielddata[].description Typestring Requiredno DescriptionHandler description
Fielddata[].settings Typeobject / array Requiredno DescriptionHandler settings definition. The structure and nested keys depend on the handler
Fielddata[].profiles Typearray Requiredno DescriptionHandler profile definitions
Fieldmeta Typeobject Requiredyes DescriptionList metadata
Fieldmeta.total Typeinteger Requiredyes DescriptionNumber of handlers in data

Handler fields are included in the response if they are present in the handler definition. An empty data array means there are no registered REST handlers.

Response example

The example shows the main handler fields. See the response fields table for the full structure.

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "code": "my_payment_handler",
      "sort": 100
    },
    {
      "id": 3,
      "code": "my_qr_handler",
      "sort": 100
    }
  ],
  "meta": {
    "total": 2
  }
}

Error response example

400 — the request includes the query parameter limit=1:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Handlers have no query parameters"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionThe request includes query parameters. This method accepts none
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionBitrix24 denied access to the handlers
HTTP422 CodeBITRIX_ERROR DescriptionThe operation failed in Bitrix24. See error.message for details
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionThe response has an invalid structure
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured Bitrix24 access tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the pay_system scope

For the full list of common API errors, see Errors.

See also