How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bitrix24 Payment Systems API

The Payment Systems API from Bitrix24 — 14 operation(s) for payment systems.

Bitrix24 Payment Systems API is one of 36 APIs that Bitrix24 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Systems. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 14 operations across 14 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://{portal}.bitrix24.com/rest, https://{host}/rest.

14 operations 14 paths 3 schemas 14 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://{installation}.bitrix24.com/rest/
Authentication
API Key, OAuth 2.0
License
Resource Areas
1

Authentication & Security 2

Bitrix24 Payment Systems API declares 2 security schemes for authenticating requests. An API key is passed in the query as auth (AccessToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 45 scopes. By default, every request must be authenticated.

  • AccessToken — OAuth 2.0 accesstoken or incoming webhook token
  • OAuth2 — OAuth 2.0 authorization

Paths & Operations 14

Across 14 paths, the API surfaces 14 operations — 14 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Systems 14
POST
/sale.paysystem.add
Add Payment System sale.paysystem.add
sale_paysystem_add body → 2004XX
POST
/sale.paysystem.delete
Delete Payment System sale.paysystem.delete
sale_paysystem_delete body → 2004XX
POST
/sale.paysystem.handler.add
Add REST Handler for Payment System sale.paysystem.handler.add
sale_paysystem_handler_add body → 2004XX
POST
/sale.paysystem.handler.delete
Delete the REST handler for the payment system sale.paysystem.handler.delete
sale_paysystem_handler_delete body → 2004XX
POST
/sale.paysystem.handler.list
Get a List of REST Handlers for the Payment System sale.paysystem.handler.list
sale_paysystem_handler_list body → 2004XX
POST
/sale.paysystem.handler.update
Update REST Handler for Payment System sale.paysystem.handler.update
sale_paysystem_handler_update body → 2004XX
POST
/sale.paysystem.list
Get a List of Payment Systems sale.paysystem.list
sale_paysystem_list body → 2004XX
POST
/sale.paysystem.pay.invoice
Pay Invoice Through a Specific Payment System sale.paysystem.pay.invoice
sale_paysystem_pay_invoice body → 2004XX
POST
/sale.paysystem.pay.payment
Pay for an Order via a Specific Payment System sale.paysystem.pay.payment
sale_paysystem_pay_payment body → 2004XX
POST
/sale.paysystem.settings.get
Get Payment System Settings sale.paysystem.settings.get
sale_paysystem_settings_get body → 2004XX
POST
/sale.paysystem.settings.invoice.get
Get Payment System Settings for a Specific Invoice sale.paysystem.settings.invoice.get
sale_paysystem_settings_invoice_get body → 2004XX
POST
/sale.paysystem.settings.payment.get
Get Payment System Settings for a Specific Payment sale.paysystem.settings.payment.get
sale_paysystem_settings_payment_get body → 2004XX
POST
/sale.paysystem.settings.update
Update Payment System Settings sale.paysystem.settings.update
sale_paysystem_settings_update body → 2004XX
POST
/sale.paysystem.update
Update Payment System sale.paysystem.update
sale_paysystem_update body → 2004XX

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BitrixTime (8 properties), BitrixResponse (4 properties), BitrixError (2 properties). Each schema is shown below with its type and property counts.

BitrixError
object
Bitrix24 REST API error response
2 properties 2 required
BitrixTime
object
Request execution time information
8 properties
BitrixResponse
object
Standard Bitrix24 REST API response
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitrix24-payment-systems-api-openapi.yml Raw ↑

Other APIs Bitrix24 publishes across the network.

Bitrix24 REST API
Bitrix24 BIconnector API
Bitrix24 Business Processes API
Bitrix24 Calendar API
Bitrix24 Chatbots API
Bitrix24 Chats API
Bitrix24 Company Structure API
Bitrix24 CoPilot / AI API
Bitrix24 CRM API
Bitrix24 Data Storage API
Bitrix24 Deprecated Methods API
Bitrix24 Document Generator API
Where this information came from

This is an independent, third-party profile of Bitrix24 Payment Systems API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.