PHP WHMCS UpdatePayMethod用法及代码示例

更新信用卡支付方式。

请求参数

参数	类型	说明	必需的
action	string	“UpdatePayMethod”	Required
clientid	int	匹配支付方式的客户id	Required
paymethodid	int	要更新的付款方式的 ID	Required
card_number	string	信用卡号码。为CreditCard 或RemoteCreditCard 支付方式更新的卡号。可选的。仅在您希望进行更新时提供	Optional
card_expiry	string	CreditCard 或 RemoteCreditCard 付款方式的更新到期日期。格式“MMYY”，例如 0122。可选。仅在您希望进行更新时提供	Optional
card_start	string	CreditCard 或 RemoteCreditCard 付款方式的更新开始日期。格式“MMYY”‘eg’0122。可选。仅在您希望进行更新时提供	Optional
card_issue_number	int	issue_number 更新为 CreditCard 或 RemoteCreditCard 支付方式。可选的。仅在您希望进行更新时提供	Optional
bank_name	string	银行名称。可选的。仅在您希望进行更新时提供	Optional
bank_account_type	string	银行账户的类型(支票、信用等)。可选的。仅在您希望进行更新时提供	Optional
bank_code	string	银行代码。也称为排序代码或路由编号。可选的。仅在您希望进行更新时提供	Optional
bank_account	string	帐号。 BankAccount 类型是必需的。可选的。仅在您希望进行更新时提供	Optional
set_as_default	bool	新的付款方式是否应为客户默认设置	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
paymethodid	int	更新后的支付方式的 id
clientid	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' => 'UpdatePayMethod',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'paymethodid' => '1',
            'clientid' => '1',
            'card_expiry' => '1025',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

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

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

示例响应 JSON

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

错误响应

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

• 付款方式 ID 为必填项
• 客户 ID 为必填项
• 付款方式 ID 无效
• 支付方式不属于传递的客户ID
• 不支持更新的网关类型
• 没有提供更新的详细信息
• 无法更新辅助网关的卡号
• 到期日无效
• 开始日期无效
• 发行号无效
• 更新远程支付方式时出错：xxx(来自网关的消息)