Get Description of Bank Details Fields crm.requisite.bankdetail.fields

{% note tip "" %}

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.

{% endnote %}

Scope: crm

Who can execute the method: any user

The method returns a formal description of the bank details fields.

No parameters.

Code Examples

{% include Note on examples %}

{% list tabs %}

cURL (Webhook)

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.bankdetail.fields

cURL (OAuth)

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.bankdetail.fields

JS (TS)

// 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 } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type FieldAttributes = {
  type: string
  isRequired: boolean
  isReadOnly: boolean
  isImmutable: boolean
  isMultiple: boolean
  isDynamic: boolean
  title: string
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type BankDetailFieldsResult = Record<string, FieldAttributes>

try {
  const response = await $b24.actions.v2.call.make<BankDetailFieldsResult>({
    method: 'crm.requisite.bankdetail.fields',
    params: {},
    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('Bank detail fields:', Object.keys(result))
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

JS (UMD)

<!-- 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 getBankDetailFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.requisite.bankdetail.fields',
        params: {},
        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('Bank detail fields:', Object.keys(result))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getBankDetailFields)
</script>

Python

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.requisite.bankdetail.fields().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}")

PHP

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.requisite.bankdetail.fields',
            []
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error fetching bank detail fields: ' . $e->getMessage();
}

BX24.js

BX24.callMethod(
    "crm.requisite.bankdetail.fields",
    {},
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

PHP CRest

require_once('crest.php');

$result = CRest::call(
    'crm.requisite.bankdetail.fields',
    []
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.requisite.bankdetail.fields", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.requisite.bankdetail.fields: %w", err)
}

keys, ok := b24.Keys(res.Result)
if !ok {
	return fmt.Errorf("expected an object in the response")
}
fmt.Println("fields in response:", len(keys))

{% endlist %}

Response Handling

HTTP status: 200

{
    "result": {
        "ID": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "ID"
        },
        "ENTITY_ID": {
            "type": "integer",
            "isRequired": true,
            "isReadOnly": false,
            "isImmutable": true,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Object ID"
        },
        "COUNTRY_ID": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Country ID"
        },
        "DATE_CREATE": {
            "type": "datetime",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Creation Date"
        },
        "DATE_MODIFY": {
            "type": "datetime",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Modification Date"
        },
        "CREATED_BY_ID": {
            "type": "user",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Created By"
        },
        "MODIFY_BY_ID": {
            "type": "user",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Modified By"
        },
        "NAME": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Name"
        },
        "CODE": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Code"
        },
        "XML_ID": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "External Code"
        },
        "ACTIVE": {
            "type": "char",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Active"
        },
        "SORT": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Sort Order"
        },
        "RQ_BANK_NAME": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Bank Name"
        },
        "RQ_BANK_ADDR": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Bank Address"
        },
        "RQ_BANK_CODE": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RQ_BANK_CODE"
        },
        "RQ_AGENCY_NAME": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RQ_AGENCY_NAME"
        },
        "RQ_BANK_ROUTE_NUM": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RQ_BANK_ROUTE_NUM"
        },
        "RQ_BIK": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Routing Number"
        },
        "RQ_MFO": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RQ_MFO"
        },
        "RQ_ACC_NAME": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RQ_ACC_NAME"
        },
        "RQ_ACC_NUM": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Account Number"
        },
        "RQ_ACC_TYPE": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RQ_ACC_TYPE"
        },
        "RQ_IIK": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RQ_IIK"
        },
        "RQ_ACC_CURRENCY": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Account Currency"
        },
        "RQ_COR_ACC_NUM": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Correspondent Account"
        },
        "RQ_IBAN": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RQ_IBAN"
        },
        "RQ_SWIFT": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "SWIFT"
        },
        "RQ_BIC": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RQ_BIC"
        },
        "RQ_CODEB": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RQ_CODEB"
        },
        "RQ_CODEG": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RQ_CODEG"
        },
        "RQ_RIB": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RQ_RIB"
        },
        "COMMENTS": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Comment"
        },
        "ORIGINATOR_ID": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "External Source"
        }
    },
    "time": {
        "start": 1717409814.796487,
        "finish": 1717409815.225673,
        "duration": 0.4291858673095703,
        "processing": 0.013273000717163086,
        "date_start": "2024-06-03T12:16:54+02:00",
        "date_finish": "2024-06-03T12:16:55+02:00",
        "operating": 0
    }
}

Returned Data

#| || Name type | Description || || result object | An object in the format {"field_1": "value_1", ... "field_N": "value_N"}, where field is the field identifier and value is the object with field attributes || || time time | Information about the request execution time || |#

Description of Bank Details Fields

#| || Name type | Description || || ID integer | Identifier of the bank details. Automatically created and unique within the account || || ENTITY_ID integer | Identifier of the parent object. Currently can only be the identifier of the requisite.

Identifiers of requisites can be obtained using the method crm.requisite.list || || COUNTRY_ID integer | Identifier of the country corresponding to the set of bank details fields (see method crm.requisite.preset.countries for available values).

The country code of the bank details matches the country code in the linked requisite template, the identifier of which is specified in the ENTITY_ID field || || DATE_CREATE datetime | Create date || || DATE_MODIFY datetime | Modification date || || CREATED_BY_ID user | Identifier of the user who created the requisite || || MODIFY_BY_ID user | Identifier of the user who modified the requisite || || NAME string | Name of the bank details || || CODE string | Symbolic code of the requisite || || XML_ID string | External key. Used for exchange operations. Identifier of the object in the external information base.

The purpose of the field may change by the final developer. Each application ensures the uniqueness of values in this field.

It is recommended to use a unique prefix to avoid collisions with other applications || || ACTIVE char | Activity indicator. Uses values Y or N.

Currently, the field does not actually affect anything || || SORT integer | Sorting || || RQ_BANK_NAME string | Name of the bank || || RQ_BANK_ADDR string | Address of the bank || || RQ_BANK_CODE string | Bank Code (for country BR) || || RQ_BANK_ROUTE_NUM string | Bank Routing Number || || RQ_BIK string | BIK || || RQ_CODEB string | Bank Code (for country FR) || || RQ_CODEG string | Branch Code (for country FR) || || RQ_RIB string | RIB Key (for country FR) || || RQ_MFO string | MFO || || RQ_ACC_NAME string | Bank Account Holder Name || || RQ_ACC_NUM string | Bank Account Number || || RQ_ACC_TYPE string | Account Type (for country BR) || || RQ_AGENCY_NAME string | Agency (for country BR) || || RQ_IIK string | IIK || || RQ_ACC_CURRENCY string | Currency of the account || || RQ_COR_ACC_NUM string | Correspondent account || || RQ_IBAN string | IBAN || || RQ_SWIFT string | SWIFT || || RQ_BIC string | BIC || || COMMENTS string | Comment || || ORIGINATOR_ID string | Identifier of the external information base. The purpose of the field may change by the final developer || |#

Description of Attributes {#attributes}

#| || Name type | Description || || type string | Field type || || isRequired boolean | "Required" attribute. Possible values:

true — yes
false — no || || isReadOnly boolean | "Read-only" attribute. Possible values:
true — yes
false — no || || isImmutable boolean | "Immutable" attribute. Possible values:
true — yes
false — no || || isMultiple boolean | "Multiple" attribute. Possible values:
true — yes
false — no || || isDynamic boolean | "Custom" attribute. Possible values:
true — yes
false — no || || title string | Field identifier || |#

Error Handling

{% include System errors %}

Navigation Menu

Uh oh!

Get Description of Bank Details Fields crm.requisite.bankdetail.fields

Code Examples

Response Handling

Returned Data

Description of Bank Details Fields

Description of Attributes {#attributes}

Error Handling

Continue Learning

Uh oh!

FilesExpand file tree

crm-requisite-bank-detail-fields.md

Latest commit

History

crm-requisite-bank-detail-fields.md

File metadata and controls

Get Description of Bank Details Fields crm.requisite.bankdetail.fields

Code Examples

Response Handling

Returned Data

Description of Bank Details Fields

Description of Attributes {#attributes}

Error Handling

Continue Learning