PHP WHMCS GetTransactions用法及代碼示例

獲取符合通過條件的交易

請求參數

參數	類型	說明	必需的
action	string	“GetTransactions”	Required
invoiceid	int	獲取特定發票 ID 的交易	Optional
clientid	int	查找特定客戶 ID 的交易	Optional
transid	string	查找特定交易 ID 的交易	Optional

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤
totalresults	int	可用結果總數
startnumber	int	返回結果的起始編號
numreturned	int	返回的結果數
transactions	array	與傳遞的條件匹配的事務數組

示例請求 (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' => 'GetTransactions',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'clientid' => '1',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'GetTransactions';
$postData = array(
    'clientid' => '1',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例響應 JSON

{
    "result": "success",
    "totalresults": 1,
    "startnumber": 0,
    "numreturned": 1,
    "transactions": {
        "transaction": [
            {
                "id": "10",
                "userid": "1",
                "currency": "0",
                "gateway": "paypal",
                "date": "2016-01-01 06:41:11",
                "description": "Invoice Payment",
                "amountin": "45.90",
                "fees": "0.00",
                "amountout": "0.00",
                "rate": "1.00000",
                "transid": "1479732071aad259f3513ec",
                "invoiceid": "59",
                "refundid": "0"
            }
        ]
    }
}