PHP WHMCS AddPayMethod用法及代码示例

向给定客户添加付款方式。支持创建信用卡和银行账户支付方式。请注意，某些代币化支付网关无法通过 API 使用。有关支持的函数的详细信息，请参阅各个支付网关文档。

请求参数

参数	类型	说明	必需的
action	string	“AddPayMethod”	Required
clientid	int	添加支付方式的客户ID	Required
type	string	要添加的付款方式的类型。 “BankAccount”、“CreditCard”或“RemoteCreditCard”之一。默认为“信用卡”	Optional
description	string	新支付方式的说明	Optional
gateway_module_name	string	与令牌化支付网关一起使用时需要，例如： authorizecim、sagepaytokens 等……	Optional
card_number	string	信用卡号码。 CreditCard 和 RemoteCreditCard 类型需要	Optional
card_expiry	string	卡的到期日。 cc 类型是必需的。格式“MMYY”，例如 0122	Optional
card_start	string	卡的开始日期。不需要。格式“MMYY”，例如 0122	Optional
card_issue_number	int	卡的issue_number。不需要	Optional
bank_name	string	银行名称。不需要	Optional
bank_account_type	string	银行账户的类型(支票、信用等)。不需要	Optional
bank_code	string	银行代码。也称为排序代码或路由编号。 BankAccount 类型需要	Optional
bank_account	string	帐号。 BankAccount 类型需要	Optional
set_as_default	bool	新的付款方式是否应为客户默认设置	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
clientid	int	付款方式已添加到的客户 ID
paymethodid	int	新创建的 Pay Method 的 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' => 'AddPayMethod',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'clientid' => '1',
            'type' => 'CreditCard',
            'description' => 'New Card',
            'card_number' => '4242424242424242',
            'card_expiry' => '0423',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'AddPayMethod';
$postData = array(
    'clientid' => '1',
    'type' => 'CreditCard',
    'description' => 'New Card',
    'card_number' => '4242424242424242',
    'card_expiry' => '0423',
);
$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
• 支付方式类型无效。类型应为“BankAccount”、“CreditCard”或“RemoteCreditCard”之一
• RemoteCreditCard 类型需要网关
• 未启用本地信用卡支付网关
• “CreditCard”或“RemoteCreditCard”类型需要卡号
• “CreditCard”或“RemoteCreditCard”类型需要到期日期
• 到期日无效
• 开始日期无效
• 发行号无效
• 网关模块名称无效。必须是以下之一：xxx(活动网关列表)
• 不支持的存储网关类型
• 创建远程令牌时出错：xxx(来自模块的错误)
• 路由号码为必填项
• 帐号为必填项
• 银行账户存储需要网关