PHP WHMCS AddTransaction用法及代碼示例

向係統添加交易

請求參數

參數	類型	說明	必需的
action	string	“AddTransaction”	Required
paymentmethod	string	係統格式交易的支付方式	Required
userid	int	應用交易的用戶ID	Optional
invoiceid	int	交易的發票 ID	Optional
transid	string	此付款的唯一交易 ID	Optional
date	string	本地化格式的交易日期(例如 DD/MM/YYYY)	Optional
currencyid	int	交易的貨幣 ID(如果未與用戶關聯)	Optional
description	string	交易說明	Optional
amountin	float	付款收到的數量	Optional
fees	float	商家對交易收取的費用數量 - 這可以是負數	Optional
amountout	float	通過付款支付的數量	Optional
rate	float	基於默認貨幣的付款匯率	Optional
credit	bool	是否應將付款用於客戶帳戶的貸方。不得提供發票 ID。	Optional
allowduplicatetransid	bool	是否應該允許已經存在的事務 ID。默認為假。	Optional

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤

示例請求 (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' => 'AddTransaction',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'paymentmethod' => 'paypal',
            'userid' => '1',
            'transid' => 'FJWEK32DWO329JFW',
            'date' => '01/01/2016',
            'description' => 'A sample API payment',
            'amountin' => '10.00',
            'fees' => '0.89',
            'rate' => '1.00000',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'AddTransaction';
$postData = array(
    'paymentmethod' => 'paypal',
    'userid' => '1',
    'transid' => 'FJWEK32DWO329JFW',
    'date' => '01/01/2016',
    'description' => 'A sample API payment',
    'amountin' => '10.00',
    'fees' => '0.89',
    'rate' => '1.00000',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例響應 JSON

{
    "result": "success"
}

錯誤響應

可能的錯誤條件響應包括：

• 未找到客戶端 ID
• 未找到發票 ID
• 用戶 ID 不擁有給定的發票 ID
• 未找到貨幣 ID
• 貨幣 ID 與客戶貨幣不匹配
• 非客戶相關交易需要貨幣 ID
• 付款方式為必填項
• 交易 ID 必須是唯一的