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

Get a payment system

GET /v1/pay-systems/:id

Retrieves a payment system by its ID. Use this method to check its settings before creating an order payment.

Scope: pay_system.

Parameters

Parameter Type Required Description
Parameterid (path) Typeinteger Requiredyes DescriptionPositive integer payment system ID. Source: List payment systems

This method takes no query parameters after ?.

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "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 response = await fetch('https://vibecode.bitrix24.com/v1/pay-systems/41', {
  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/41', {
  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 Typeobject DescriptionPayment system object. For all fields, see Payment system fields

Response example

Main fields are shown. For all fields, see Payment system fields.

JSON 
{
  "success": true,
  "data": {
    "id": 41,
    "name": "Invoice payment",
    "psaName": "Invoice payment",
    "description": null,
    "newWindow": "N",
    "sort": 100,
    "active": "N",
    "entityRegistryType": "ORDER",
    "personTypeId": 5,
    "xmlId": "invoice-20261014"
  }
}

Error response example

404 — payment system 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 within the JavaScript safe integer range, or query parameters after ? were supplied
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo payment system with the specified id was found
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionBitrix24 denied access to the payment system
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