PHP WHMCS AddCredit用法及代码示例

为给定的客户增加信用。

请求参数

参数	类型	说明	必需的
action	string	“AddCredit”	Required
clientid	int		Required
description	string	仅用于信用证明的管理员注释	Required
amount	float	添加或删除的信用额度。必须是正值。	Required
date	string	添加信用的日期。 YYYY-mm-dd 格式。	Optional
adminid	int	与信用记录关联的活动管理员 ID。默认为当前管理员。	Optional
type	string	是否添加或删除信用。 ‘add’ or ‘remove’ 之一	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
newbalance	float	新的总贷方余额

示例请求 (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'AddCredit',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'clientid' => '1',
            'description' => 'Adding funds via api',
            'amount' => '12.34',
            'adminid' => '1',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'AddCredit';
$postData = array(
    'clientid' => '1',
    'description' => 'Adding funds via api',
    'amount' => '12.34',
    'adminid' => '1',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

示例响应 JSON

{
    "result": "success",
    "newbalance": "123.45"
}

错误响应

可能的错误条件响应包括：

• 类型只能添加或删除
• 未找到客户端 ID
• 未找到管理员 ID
• 没有提供数量
• 数量必须为十进制格式：### 或 ###.##
• 日期格式无效