Update Bank Details crm.requisite.bankdetail.update

Scope: crm

Who can execute the method: any user

This method updates an existing bank detail.

Method Parameters

Required parameters are marked with *

Parameter

Description

id*
integer

Identifier of the bank detail.

Bank detail identifiers can be obtained using the crm.requisite.bankdetail.list method.

fields*
object

Set of bank detail fields — an object of the form {"field": "value"[, ...]}, the values of which need to be changed.

Parameter fields

Name `type`	Description
NAME `string`	Name of the bank detail.
CODE `string`	Symbolic code of the detail.
XML_ID `string`	External key. Used for exchange operations. Identifier of the external information base object. 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 status. Values `Y` or `N` are used. Currently, this field does not 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`	Code Banque (for country FR).
RQ_CODEG `string`	Code Guichet (for country FR).
RQ_RIB `string`	Clé RIB (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`	Tipo da conta (for country BR).
RQ_AGENCY_NAME `string`	Agência (for country BR).
RQ_IIK `string`	IIK.
RQ_ACC_CURRENCY `string`	Account Currency.
RQ_COR_ACC_NUM `string`	Correspondent Account Number.
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.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":357,"fields":{"NAME":"Superbank Ltd. (do not use)","COMMENTS":"Outdated","SORT":10000,"ACTIVE":"N"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.bankdetail.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":357,"fields":{"NAME":"Superbank Ltd. (do not use)","COMMENTS":"Outdated","SORT":10000,"ACTIVE":"N"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.bankdetail.update

try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.bankdetail.update",
        		{
        			id: 357,
        			fields:
        			{
        				"NAME": "Superbank Ltd. (do not use)",
        				"COMMENTS": "Outdated",
        				"SORT" : 10000,
        				"ACTIVE": "N"
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.bankdetail.update',
                    [
                        'id'     => 357,
                        'fields' => [
                            'NAME'     => 'Superbank Ltd. (do not use)',
                            'COMMENTS' => 'Outdated',
                            'SORT'     => 10000,
                            'ACTIVE'   => 'N',
                        ],
                    ]
                );
        
            $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 updating bank detail: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.requisite.bankdetail.update",
            {
                id: 357,
                fields:
                {
                    "NAME": "Superbank Ltd. (do not use)",
                    "COMMENTS": "Outdated",
                    "SORT" : 10000,
                    "ACTIVE": "N"
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.bankdetail.update',
            [
                'id' => 357,
                'fields' => [
                    'NAME' => 'Superbank Ltd. (do not use)',
                    'COMMENTS' => 'Outdated',
                    'SORT' => 10000,
                    'ACTIVE' => 'N'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1717509116.239588,
                "finish": 1717509116.78087,
                "duration": 0.5412819385528564,
                "processing": 0.173170804977417,
                "date_start": "2024-06-04T15:51:56+02:00",
                "date_finish": "2024-06-04T15:51:56+02:00",
                "operating": 0.17314410209655762
            }
        }

Returned Data

Name
type

Description

result
boolean

Result of updating the bank detail:

true — updated
false — not updated

time
time

Information about the request execution time.

Error Handling

HTTP status: 40x, 50x

{
            "error": "",
            "error_description": "The RequisiteBankDetail with ID '357' is not found."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Errors

Error Text	Description
`ID is not defined or invalid`	The identifier of the bank detail is not specified or has an invalid value.
`The Requisite with ID '357' is not found`	The bank detail with the specified identifier was not found.
`Access denied`	Insufficient access permissions to update the bank detail.

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Create New Bank Detail

Get Bank Detail by ID

Update Bank Details crm.requisite.bankdetail.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible ErrorsPossible Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning