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
• 无法向已取消的发票添加付款