tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AllocateCustomerCredit

Last updated: 2024-02-18 11:09:57

    1. API Description

    Domain name for API request: intlpartnersmgt.tencentcloudapi.com.

    This API is used for a partner to set credit for a customer, such as increasing or lowering the credit and setting it to 0.

    1. The credit is valid permanently and will not be zeroed regularly.
    2. The customer's service will be suspended when its available credit is set to 0, so caution should be exercised with this operation.
    3. To prevent the customer from making new purchases without affecting their use of previously purchased products, the partner can set their available credit to 0 after obtaining the non-stop feature privilege from the channel manager.
    4. The set credit is an increment of the current available credit and cannot exceed the remaining allocable credit. Setting the credit to a negative value indicates that it will be repossessed. The available credit can be set to 0 at the minimum.

    A maximum of 5 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: AllocateCustomerCredit.
    Version Yes String Common Params. The value used for this API: 2022-09-28.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    AddedCredit Yes Float Specific value of the credit allocated to the customer
    ClientUin Yes Integer Customer UIN

    3. Output Parameters

    Parameter Name Type Description
    TotalCredit Float The updated total credit
    RemainingCredit Float The updated available credit
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Setting a customer's credit

    Input Example

    POST / HTTP/1.1
Host: intlpartnersmgt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateCustomerCredit
<Common request parameters>

{
    "ClientUin": 1,
    "AddedCredit": 10
}

    Output Example

    {
    "Response": {
        "RemainingCredit": 100,
        "RequestId": "2b7c676e-bb4b-449d-89e6-4866132036c5",
        "TotalCredit": 100
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    InvalidParameterValue.CreditAmountOutOfRange The credit quota has exceeded the limit with the newly allocated quota.
    UnauthorizedOperation.UinNoAuth The current user doesn’t have permission for the operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy