Get the list of payments sale.payment.list

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: sale

Who can execute the method: administrator

The method sale.payment.list retrieves a list of payments.

Name
type

Description

select
array

An array containing the list of fields to select.

If not provided or an empty array is passed, all available payment fields will be selected.

Possible values for the array elements correspond to the fields of the sale_order_payment object.

filter
object

An object for filtering the selected payments in the format {"field_1": "value_1", ... "field_N": "value_N"}.

Possible values for field correspond to the fields of the sale_order_payment object.

An additional prefix can be specified for the key to clarify the filter behavior. Possible prefix values:

  • = — equals (works with arrays as well)
  • % — LIKE, substring search. The % symbol in the filter value does not need to be passed. The search looks for the substring in any position of the string.
  • > — greater than
  • < — less than
  • != — not equal
  • !% — NOT LIKE, substring search. The % symbol in the filter value does not need to be passed. The search goes from both sides.
  • >= — greater than or equal to
  • <= — less than or equal to
  • =% — LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searching for values starting with "mol"
    • "%mol" — searching for values ending with "mol"
    • "%mol%" — searching for values where "mol" can be in any position
  • %= — LIKE (see description above)
  • !=% — NOT LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searching for values not starting with "mol"
    • "%mol" — searching for values not ending with "mol"
    • "%mol%" — searching for values where the substring "mol" is not present in any position
  • !%= — NOT LIKE (see description above)

order
object

An object for sorting the selected payments in the format {"field_1": "order_1", ... "field_N": "order_N"}.

Possible values for field correspond to the fields of the sale_order_payment object.

Possible values for order:

  • asc — in ascending order
  • desc — in descending order

start
integer

This parameter is used to manage pagination.

The page size of results is always static: 50 records.

To select the second page of results, the value 50 must be passed. To select the third page of results, the value is 100, and so on.

The formula for calculating the start parameter value:

start = (N-1) * 50, where N — the number of the desired page

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["paySystemXmlId","paySystemIsCash","accountNumber","id","orderId","paid","datePaid","empPaidId","paySystemId","psStatus","psStatusCode","psStatusDescription","psStatusMessage","psSum","psCurrency","psResponseDate","payVoucherNum","payVoucherDate","datePayBefore","dateBill","xmlId","sum","currency","paySystemName","companyId","payReturnNum","priceCod","payReturnDate","empReturnId","payReturnComment","responsibleId","empResponsibleId","dateResponsibleId","isReturn","comments","updated1c","id1c","version1c","externalPayment","psInvoiceId","marked","reasonMarked","dateMarked","empMarkedId"],"filter":{"<id":10,"@personTypeId":[3,4],"payed":"N"},"order":{"id":"desc"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.payment.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["paySystemXmlId","paySystemIsCash","accountNumber","id","orderId","paid","datePaid","empPaidId","paySystemId","psStatus","psStatusCode","psStatusDescription","psStatusMessage","psSum","psCurrency","psResponseDate","payVoucherNum","payVoucherDate","datePayBefore","dateBill","xmlId","sum","currency","paySystemName","companyId","payReturnNum","priceCod","payReturnDate","empReturnId","payReturnComment","responsibleId","empResponsibleId","dateResponsibleId","isReturn","comments","updated1c","id1c","version1c","externalPayment","psInvoiceId","marked","reasonMarked","dateMarked","empMarkedId"],"filter":{"<id":10,"@personTypeId":[3,4],"payed":"N"},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.payment.list
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type SalePaymentListResult = {
          payments: {
            accountNumber: string
            comments: string
            companyId: number | null
            currency: string
            dateBill: ISODate | null
            dateMarked: ISODate | null
            datePaid: ISODate | null
            datePayBefore: ISODate | null
            dateResponsibleId: ISODate | null
            empMarkedId: number | null
            empPaidId: number | null
            empResponsibleId: number
            empReturnId: number | null
            externalPayment: string
            id: number
            id1c: string
            isReturn: string
            marked: string
            orderId: number
            paid: string
            payReturnComment: string
            payReturnDate: ISODate | null
            payReturnNum: string
            paySystemId: number
            paySystemIsCash: string
            paySystemName: string
            paySystemXmlId: string
            payVoucherDate: ISODate | null
            payVoucherNum: string
            priceCod: string
            psCurrency: string
            psInvoiceId: number | null
            psResponseDate: ISODate | null
            psStatus: string
            psStatusCode: string
            psStatusDescription: string
            psStatusMessage: string
            psSum: number | null
            reasonMarked: string
            responsibleId: number
            sum: number
            updated1c: string
            version1c: string
            xmlId: string
          }[]
        }
        
        try {
          // sale.payment.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<SalePaymentListResult>({
            method: 'sale.payment.list',
            params: {
              select: [
                'paySystemXmlId',
                'paySystemIsCash',
                'accountNumber',
                'id',
                'orderId',
                'paid',
                'datePaid',
                'empPaidId',
                'paySystemId',
                'psStatus',
                'psStatusCode',
                'psStatusDescription',
                'psStatusMessage',
                'psSum',
                'psCurrency',
                'psResponseDate',
                'payVoucherNum',
                'payVoucherDate',
                'datePayBefore',
                'dateBill',
                'xmlId',
                'sum',
                'currency',
                'paySystemName',
                'companyId',
                'payReturnNum',
                'priceCod',
                'payReturnDate',
                'empReturnId',
                'payReturnComment',
                'responsibleId',
                'empResponsibleId',
                'dateResponsibleId',
                'isReturn',
                'comments',
                'updated1c',
                'id1c',
                'version1c',
                'externalPayment',
                'psInvoiceId',
                'marked',
                'reasonMarked',
                'dateMarked',
                'empMarkedId',
              ],
              filter: {
                '<id': 10,
                '@personTypeId': [3, 4],
                payed: 'N',
              },
              order: {
                id: 'desc',
              },
              start: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Payments on this page:', result.payments.length, result.payments)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function fetchPaymentList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // sale.payment.list returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'sale.payment.list',
                params: {
                  select: [
                    'paySystemXmlId',
                    'paySystemIsCash',
                    'accountNumber',
                    'id',
                    'orderId',
                    'paid',
                    'datePaid',
                    'empPaidId',
                    'paySystemId',
                    'psStatus',
                    'psStatusCode',
                    'psStatusDescription',
                    'psStatusMessage',
                    'psSum',
                    'psCurrency',
                    'psResponseDate',
                    'payVoucherNum',
                    'payVoucherDate',
                    'datePayBefore',
                    'dateBill',
                    'xmlId',
                    'sum',
                    'currency',
                    'paySystemName',
                    'companyId',
                    'payReturnNum',
                    'priceCod',
                    'payReturnDate',
                    'empReturnId',
                    'payReturnComment',
                    'responsibleId',
                    'empResponsibleId',
                    'dateResponsibleId',
                    'isReturn',
                    'comments',
                    'updated1c',
                    'id1c',
                    'version1c',
                    'externalPayment',
                    'psInvoiceId',
                    'marked',
                    'reasonMarked',
                    'dateMarked',
                    'empMarkedId',
                  ],
                  filter: {
                    '<id': 10,
                    '@personTypeId': [3, 4],
                    payed: 'N',
                  },
                  order: {
                    id: 'desc',
                  },
                  start: 0,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Payments on this page:', result.payments.length, result.payments)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', fetchPaymentList)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.sale.payment.list(
                select=[
                    "paySystemXmlId",
                    "paySystemIsCash",
                    "accountNumber",
                    "id",
                    "orderId",
                    "paid",
                    "datePaid",
                    "empPaidId",
                    "paySystemId",
                    "psStatus",
                    "psStatusCode",
                    "psStatusDescription",
                    "psStatusMessage",
                    "psSum",
                    "psCurrency",
                    "psResponseDate",
                    "payVoucherNum",
                    "payVoucherDate",
                    "datePayBefore",
                    "dateBill",
                    "xmlId",
                    "sum",
                    "currency",
                    "paySystemName",
                    "companyId",
                    "payReturnNum",
                    "priceCod",
                    "payReturnDate",
                    "empReturnId",
                    "payReturnComment",
                    "responsibleId",
                    "empResponsibleId",
                    "dateResponsibleId",
                    "isReturn",
                    "comments",
                    "updated1c",
                    "id1c",
                    "version1c",
                    "externalPayment",
                    "psInvoiceId",
                    "marked",
                    "reasonMarked",
                    "dateMarked",
                    "empMarkedId",
                ],
                filter={
                    "<id": 10,
                    "@personTypeId": [
                        3,
                        4,
                    ],
                    "payed": "N",
                },
                order={
                    "id": "desc",
                },
                start='1713451909.778956',
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.payment.list',
                    [
                        'select' => [
                            'paySystemXmlId',
                            'paySystemIsCash',
                            'accountNumber',
                            'id',
                            'orderId',
                            'paid',
                            'datePaid',
                            'empPaidId',
                            'paySystemId',
                            'psStatus',
                            'psStatusCode',
                            'psStatusDescription',
                            'psStatusMessage',
                            'psSum',
                            'psCurrency',
                            'psResponseDate',
                            'payVoucherNum',
                            'payVoucherDate',
                            'datePayBefore',
                            'dateBill',
                            'xmlId',
                            'sum',
                            'currency',
                            'paySystemName',
                            'companyId',
                            'payReturnNum',
                            'priceCod',
                            'payReturnDate',
                            'empReturnId',
                            'payReturnComment',
                            'responsibleId',
                            'empResponsibleId',
                            'dateResponsibleId',
                            'isReturn',
                            'comments',
                            'updated1c',
                            'id1c',
                            'version1c',
                            'externalPayment',
                            'psInvoiceId',
                            'marked',
                            'reasonMarked',
                            'dateMarked',
                            'empMarkedId',
                        ],
                        'filter' => [
                            '<id'           => 10,
                            '@personTypeId' => [3, 4],
                            'payed'         => 'N',
                        ],
                        'order' => [
                            'id' => 'desc',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching payment list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "sale.payment.list",
            {
                "select": [
                    "paySystemXmlId",
                    "paySystemIsCash",
                    "accountNumber",
                    "id",
                    "orderId",
                    "paid",
                    "datePaid",
                    "empPaidId",
                    "paySystemId",
                    "psStatus",
                    "psStatusCode",
                    "psStatusDescription",
                    "psStatusMessage",
                    "psSum",
                    "psCurrency",
                    "psResponseDate",
                    "payVoucherNum",
                    "payVoucherDate",
                    "datePayBefore",
                    "dateBill",
                    "xmlId",
                    "sum",
                    "currency",
                    "paySystemName",
                    "companyId",
                    "payReturnNum",
                    "priceCod",
                    "payReturnDate",
                    "empReturnId",
                    "payReturnComment",
                    "responsibleId",
                    "empResponsibleId",
                    "dateResponsibleId",
                    "isReturn",
                    "comments",
                    "updated1c",
                    "id1c",
                    "version1c",
                    "externalPayment",
                    "psInvoiceId",
                    "marked",
                    "reasonMarked",
                    "dateMarked",
                    "empMarkedId",
                ],
                "filter": {
                    "<id": 10,
                    "@personTypeId": [3, 4],
                    "payed": "N",
                },
                "order": {
                    "id": "desc",
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.payment.list',
            [
                'select' => [
                    "paySystemXmlId",
                    "paySystemIsCash",
                    "accountNumber",
                    "id",
                    "orderId",
                    "paid",
                    "datePaid",
                    "empPaidId",
                    "paySystemId",
                    "psStatus",
                    "psStatusCode",
                    "psStatusDescription",
                    "psStatusMessage",
                    "psSum",
                    "psCurrency",
                    "psResponseDate",
                    "payVoucherNum",
                    "payVoucherDate",
                    "datePayBefore",
                    "dateBill",
                    "xmlId",
                    "sum",
                    "currency",
                    "paySystemName",
                    "companyId",
                    "payReturnNum",
                    "priceCod",
                    "payReturnDate",
                    "empReturnId",
                    "payReturnComment",
                    "responsibleId",
                    "empResponsibleId",
                    "dateResponsibleId",
                    "isReturn",
                    "comments",
                    "updated1c",
                    "id1c",
                    "version1c",
                    "externalPayment",
                    "psInvoiceId",
                    "marked",
                    "reasonMarked",
                    "dateMarked",
                    "empMarkedId",
                ],
                'filter' => [
                    "<id" => 10,
                    "@personTypeId" => [3, 4],
                    "payed" => "N",
                ],
                'order' => [
                    "id" => "desc",
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sale.payment.list", b24.Params{
        	"select": []string{"paySystemXmlId", "paySystemIsCash", "accountNumber", "id", "orderId", "paid", "datePaid", "empPaidId", "paySystemId", "psStatus", "psStatusCode", "psStatusDescription", "psStatusMessage", "psSum", "psCurrency", "psResponseDate", "payVoucherNum", "payVoucherDate", "datePayBefore", "dateBill", "xmlId", "sum", "currency", "paySystemName", "companyId", "payReturnNum", "priceCod", "payReturnDate", "empReturnId", "payReturnComment", "responsibleId", "empResponsibleId", "dateResponsibleId", "isReturn", "comments", "updated1c", "id1c", "version1c", "externalPayment", "psInvoiceId", "marked", "reasonMarked", "dateMarked", "empMarkedId"},
        	"filter": b24.Params{
        		"<id":           10,
        		"@personTypeId": []int{3, 4},
        		"payed":         "N",
        	},
        	"order": b24.Params{
        		"id": "desc",
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("sale.payment.list: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)

Response Handling

HTTP status: 200

{
            "result": {
                "payments": [
                    {
                        "accountNumber": "163\/1",
                        "comments": "",
                        "companyId": null,
                        "currency": "USD",
                        "dateBill": "2022-10-14T17:10:00+02:00",
                        "dateMarked": null,
                        "datePaid": null,
                        "datePayBefore": null,
                        "dateResponsibleId": "2022-10-14T17:10:00+02:00",
                        "empMarkedId": null,
                        "empPaidId": null,
                        "empResponsibleId": 1,
                        "empReturnId": null,
                        "externalPayment": "N",
                        "id": 9,
                        "id1c": "",
                        "isReturn": "N",
                        "marked": "N",
                        "orderId": 7,
                        "paid": "N",
                        "payReturnComment": "",
                        "payReturnDate": null,
                        "payReturnNum": "",
                        "paySystemId": 6,
                        "paySystemIsCash": "Y",
                        "paySystemName": "Cash",
                        "paySystemXmlId": "bx_64134ba550ffa",
                        "payVoucherDate": null,
                        "payVoucherNum": "",
                        "priceCod": "0.000000",
                        "psCurrency": "",
                        "psInvoiceId": null,
                        "psResponseDate": null,
                        "psStatus": "",
                        "psStatusCode": "",
                        "psStatusDescription": "",
                        "psStatusMessage": "",
                        "psSum": null,
                        "reasonMarked": "",
                        "responsibleId": 1,
                        "sum": 1176,
                        "updated1c": "N",
                        "version1c": "",
                        "xmlId": "bx_634989d809dc8"
                    },
                ]
            },
            "total": 1,
            "time": {
                "start": 1713451909.778956,
                "finish": 1713451910.23781,
                "duration": 0.45885396003723145,
                "processing": 0.09081101417541504,
                "date_start": "2024-04-18T17:51:49+02:00",
                "date_finish": "2024-04-18T17:51:50+02:00"
            }
        }

Returned Data

Name
type

Description

result
object

The root element of the response

payments
sale_order_payment[]

An array of objects containing information about the selected payments

total
integer

The total number of records found

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error":0,
            "error_description":"error"
        }

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

200040300010

Insufficient permissions to read payments

0

Other errors (e.g., fatal errors)

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Previous
Get Payment by Id
Next
Delete Payment