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
• 沒有提供數量
• 數量必須為十進製格式：### 或 ###.##
• 日期格式無效