tencent cloud

Feedback

AllocateCustomerCredit

Last updated: 2022-09-01 17:26:58

1. API Description

Domain name for API request: ip.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 sets 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 increase to the current available credit and cannot exceed the remaining allocable credit. Setting the credit to a negative value indicates to repossess it. The available credit can be set to 0 at the minimum.

A maximum of 20 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: 2021-04-09.
Region No String Common Params. This parameter is not required for this API.
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: ip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateCustomerCredit
<Common request parameters>

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

Output Example

{
    "Response": {
        "RemainingCredit": 0.0,
        "RequestId": "xx",
        "TotalCredit": 0.0
    }
}

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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support