Para agentes de IA: markdown desta página — /docs-content-en/entities/pay-systems.md índice da documentação — /llms.txt

Os artigos da documentação estão disponíveis atualmente em inglês.

Pay systems

Select a pay system for orders and invoices. Create your own records using a registered REST handler. Scope: pay_system.

Built-in pay systems 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.

List payment systems

GET /v1/pay-systems

Finds payment systems in a Bitrix24 account that match the specified conditions. Use this method to choose a system for an order payment.

Scope: pay_system.

Parameters

Parameter Type Required Description
Parameterfilter (query) Typeobject / string Requiredno DescriptionFilter by payment system fields. Accepts a JSON object encoded as a string or bracket parameters. Supports equality, $eq, arrays of values, and $in.
Filtering syntax. Example: ?filter[id]=1
Parametersort (query) Typestring Requiredno DescriptionComma-separated field names. Prefix a field with - for descending order. Example: ?sort=-id
Parameterselect (query) Typestring Requiredno DescriptionComma-separated names of fields to return, or * for all fields. Example: ?select=id,name,active

Pagination: the method retrieves the complete list matching the filter. It does not accept limit or offset.

Examples

curl — personal key

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/pay-systems?filter[id]=1&select=id,name,active&sort=-id" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/pay-systems?filter[id]=1&select=id,name,active&sort=-id" \
  -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?filter%5Bid%5D=1&select=id,name,active&sort=-id',
  {
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
    },
  },
);

console.log(await response.json());

JavaScript — OAuth application

javascript 
const response = await fetch(
  'https://vibecode.bitrix24.com/v1/pay-systems?filter%5Bid%5D=1&select=id,name,active&sort=-id',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  },
);

console.log(await response.json());

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata Typearray DescriptionArray of payment systems. For record fields, see Payment system fields. When select is provided, only the selected fields are returned
Fieldmeta.total Typeinteger DescriptionNumber of records in the data array

Response example

Response to a request with filter[id]=1, select=id,name,active, and sort=-id:

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Bank transfer (Companies)",
      "active": "Y"
    }
  ],
  "meta": {
    "total": 1
  }
}

Error response example

400 — the request includes limit:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Only filter, sort and select are supported; the full list has no pagination"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionA parameter other than filter, sort, or select was supplied, sort or select was repeated or malformed, or a sort field was specified more than once
HTTP400 CodeINVALID_FILTER DescriptionJSON and bracket parameters were mixed, or a filter condition was repeated
HTTP400 CodeINVALID_FILTER_SHAPE DescriptionThe filter, its conditions, or an array of values has an invalid structure
HTTP400 CodeINVALID_FILTER_OPERATOR DescriptionAn operator other than equality or selection from an array of values was supplied
HTTP400 CodeINVALID_DUPLICATE_FILTER_FIELD DescriptionThe same filter field was specified in more than one way
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionUnknown filter field. For available names, see Payment system fields
HTTP400 CodeUNKNOWN_SELECT_FIELD DescriptionUnknown field in select
HTTP400 CodeUNKNOWN_SORT_FIELD DescriptionUnknown field in sort
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionBitrix24 denied access to payment systems
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 refused the operation. The reason is provided in error.message
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionThe Bitrix24 response has an invalid structure
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeINVALID_API_KEY DescriptionThe API key is invalid
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured Bitrix24 tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the pay_system scope

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

See also