PHP WHMCS AddInvoicePayment用法及代碼示例

將付款添加到給定的發票。

請求參數

參數	類型	說明	必需的
action	string	“AddInvoicePayment”	Required
invoiceid	int		Required
transid	string	應應用於付款的唯一交易 ID。	Required
gateway	string	使用的網關，采用係統名稱格式(例如，paypal 或 authorize)。	Required
date	string	付款應指定的日期。格式：YYYY-MM-DD HH:mm:ss	Required
amount	float	支付的數量。您可以保留此未定義以獲取發票的全部數量。	Optional
fees	float	網關收取的費用數量。	Optional
noemail	bool	將此設置為 true 以防止發送發票付款電子郵件。	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' => 'AddInvoicePayment',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'invoiceid' => '1',
            'transid' => 'D28DJIDJW393JDWQKQI332',
            'gateway' => 'mailin',
            'date' => '2016-01-01 12:33:12',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'AddInvoicePayment';
$postData = array(
    'invoiceid' => '1',
    'transid' => 'D28DJIDJW393JDWQKQI332',
    'gateway' => 'mailin',
    'date' => '2016-01-01 12:33:12',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例響應 JSON

{
    "result": "success"
}

錯誤響應

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

• 未找到發票 ID
• 無法向已取消的發票添加付款