PHP WHMCS DeletePayMethod用法及代码示例

删除付款方式。

请求参数

参数	类型	说明	必需的
action	string	“DeletePayMethod”	Required
clientid	int	匹配支付方式的客户id	Required
paymethodid	int	要删除的付款方式的 ID	Required
failonremotefailure	bool	如果远程令牌删除失败，则传递为 true 以返回错误	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
paymethodid	int	付款方式的id已删除

示例请求 (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' => 'DeletePayMethod',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'paymethodid' => '1',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'DeletePayMethod';
$postData = array(
    'paymethodid' => '1',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例响应 JSON

{
    "result": "success",
    "paymethodid": "1"
}

错误响应

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

• 客户 ID 为必填项
• 付款方式 ID 为必填项
• 付款方式 ID 无效
• 支付方式不属于传递的客户ID
• 删除远程支付方法时出错：xxx(来自模块的响应)