Payments in the Online Store: Overview of Methods

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Payments contain information about payments for orders: payment system, status and date of payment, payer identifier.

Quick navigation: all methods

User documentation: Track the payment status in the deal form

Connection of Payments with Other Objects

Order. Specify the order for which you are creating the payment. You can get a list of orders using the sale.order.list method.

Payment Systems. Specify the payment system. You can get a list of payment systems using the sale.paysystem.list method.

Linking Cart Items to Payment. Select the cart items for which you want to create a payment. Use the sale.paymentitembasket.* methods.

Linking Payments to Shipments. Specify which shipments have been paid. Use the sale.paymentItemShipment.* methods.

Overview of Methods

Scope: sale

Who can execute the methods: administrator

Method

Description

sale.payment.add

Adds a payment

sale.payment.update

Modifies a payment

sale.payment.get

Returns information about a payment

sale.payment.list

Returns a list of payments

sale.payment.delete

Deletes a payment

sale.payment.getFields

Returns available payment fields