当前位置: 首页>>代码示例 >>用法及示例精选 >>正文


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 必须是唯一的

相关用法


注:本文由纯净天空筛选整理自whmcs.com大神的英文原创作品 AddTransaction。非经特殊声明,原始代码版权归原作者所有,本译文未经允许或授权,请勿转载或复制。