Updated on 2025-12-08 GMT+08:00

Transferring Assets to Other Users

Function

Transfers assets to other users.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v1/{project_id}/digital-assets-action/transfers

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

You can obtain the token by calling the IAM API used to obtain a user token.

Value of X-Subject-Token in the response header.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

The format is YYYYMMDD'T'HHMMSS'Z'.

X-App-UserId

No

String

Third-party user ID, which does not allow Chinese characters.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

transfer_type

No

String

Definition

Transfer type. The default value is TRANSFER_OUT.

Constraints

  • Only administrators or tenants whitelisted for asset transfer have the permission to transfer assets.

  • Common tenants have the permission to transfer received assets to the transfer initiator.

Range

  • TRANSFER_OUT: transferring an asset

  • TRANSFER_BACK: transferring an asset back

asset_ids

Yes

Array of strings

Asset ID list

dest_project_id

Yes

String

Target user ID

memo

No

String

Remarks

auto_accept

No

Boolean

Whether to automatically receive an asset. The administrator can use this function.

Default value:

false

auto_active

No

Boolean

Whether to automatically activate an asset. The administrator can use this function.

Default value:

false

is_need_billing

No

Boolean

Whether to deduct resources from the recipient during asset transfer (generating charging CDRs)

Default value:

false

transfer_job_id

No

String

Transfer task ID. This parameter is mandatory only when transfer_type is set to TRANSFER_BACK.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

Asset transfer task ID

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

POST https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/digital-assets/transfers

{
  "asset_ids" : [ "7a6a1f8354f64dd9b9a614def7b59d86", "8a6a1f8354f64dd9b9a614def7b59d80" ],
  "dest_project_id" : "6a6a1f8354f64dd9b9a614def7b59d83",
  "memo" : "Professional service xxxx, which provides assets."
}

Example Responses

Status code: 200

Succeeded

{
  "job_id" : "6a6a1f8354f64dd9b9a614def7b59d83"
}

Status code: 400

Parameters error, including the error code and its description.

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status Codes

Status Code

Description

200

Succeeded

400

Parameters error, including the error code and its description.

Error Codes

See Error Codes.