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(來自模塊的錯誤)
• 路由號碼為必填項
• 帳號為必填項
• 銀行賬戶存儲需要網關