API 文档 - 佣金分润、订单、支付、会员卡

佣金分润

获取居间协议合同模板

/**
 * 获取居间协议合同模板
 */
public function getBrokerageContractTemplate($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/brokerage-contract/template';
    return $this->request($data);
}

下载佣金分润报表

/**
 * 下载佣金分润报表
 */
public function downloadBrokerageReport($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/brokerage-report';
    return $this->request($data, true);
}

获取佣金分润报表

/**
 * 获取佣金分润报表
 */
public function getBrokerageReport($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/brokerage-report/query';
    return $this->request($data);
}

佣金分润报表审核失败重新审核

/**
 * 佣金分润报表审核失败重新审核
 */
public function reAuditBrokerageReport($data)
{
    $data['method'] = 'POST';
    $data['url'] = '/v3/openapi/brokerage-report/re-audit';
    return $this->request($data);
}

获取佣金分润报表汇总信息

/**
 * 获取佣金分润报表汇总信息
 */
public function getBrokerageReportSummary($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/brokerage-report/summary';
    return $this->request($data);
}

订单

订单详情查询

/**
 * 订单详情查询
 */
public function getOrder($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/order';
    return $this->request($data);
}

订单列表查询

/**
 * 订单列表查询
 */
public function getOrderList($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/order/list';
    return $this->request($data);
}

支付

获取支付通知

/**
 * 获取支付通知
 */
public function getPayNotify($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/pay-notify';
    return $this->request($data);
}

获取支付通知列表

/**
 * 获取支付通知列表
 */
public function getPayNotifyList($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/pay-notify/list';
    return $this->request($data);
}

确认支付通知

/**
 * 确认支付通知
 */
public function confirmPayNotify($data)
{
    $data['method'] = 'POST';
    $data['url'] = '/v3/openapi/pay-notify/confirm';
    return $this->request($data);
}

退款

/**
 * 退款
 */
public function refund($data)
{
    $data['method'] = 'POST';
    $data['url'] = '/v3/openapi/refund';
    return $this->request($data);
}

发起支付

/**
 * 发起支付
 */
public function pay($data)
{
    $data['method'] = 'POST';
    $data['url'] = '/v3/openapi/pay';
    return $this->request($data);
}

支付订单查询

/**
 * 支付订单查询
 */
public function getPayOrder($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/pay/order';
    return $this->request($data);
}

支付订单列表查询

/**
 * 支付订单列表查询
 */
public function getPayOrderList($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/pay/order/list';
    return $this->request($data);
}

支付订单汇总查询

/**
 * 支付订单汇总查询
 */
public function getPayOrderSummary($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/pay/order/summary';
    return $this->request($data);
}

会员卡

会员卡开卡

/**
 * 会员卡开卡
 */
public function activateCard($data)
{
    $data['method'] = 'POST';
    $data['url'] = '/v3/openapi/card/activate';
    return $this->request($data);
}

会员卡更新

/**
 * 会员卡更新
 */
public function updateCard($data)
{
    $data['method'] = 'POST';
    $data['url'] = '/v3/openapi/card/update';
    return $this->request($data);
}

会员卡查询

/**
 * 会员卡查询
 */
public function getCard($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/card';
    return $this->request($data);
}

会员卡列表查询

/**
 * 会员卡列表查询
 */
public function getCardList($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/card/list';
    return $this->request($data);
}

会员卡挂失

/**
 * 会员卡挂失
 */
public function reportLossCard($data)
{
    $data['method'] = 'POST';
    $data['url'] = '/v3/openapi/card/report-loss';
    return $this->request($data);
}

会员卡解挂

/**
 * 会员卡解挂
 */
public function unReportLossCard($data)
{
    $data['method'] = 'POST';
    $data['url'] = '/v3/openapi/card/un-report-loss';
    return $this->request($data);
}

会员卡销卡

/**
 * 会员卡销卡
 */
public function destroyCard($data)
{
    $data['method'] = 'POST';
    $data['url'] = '/v3/openapi/card/destroy';
    return $this->request($data);
}

会员卡请求校验码

/**
 * 会员卡请求校验码
 */
public function requestCardVerifyCode($data)
{
    $data['method'] = 'POST';
    $data['url'] = '/v3/openapi/card/request-verify-code';
    return $this->request($data);
}

会员卡校验码验证

/**
 * 会员卡校验码验证
 */
public function verifyCardVerifyCode($data)
{
    $data['method'] = 'POST';
    $data['url'] = '/v3/openapi/card/verify-verify-code';
    return $this->request($data);
}

会员卡余额查询

/**
 * 会员卡余额查询
 */
public function getCardBalance($data)
{
    $data['method'] = 'GET';
    $data['url'] = '/v3/openapi/card/balance';
    return $this->request($data);
}

通用

所有接口请求参数均使用 POST 请求方式，并以 JSON 格式发送。

请求参数

参数名 | 类型 | 描述 ---|---|--- method | String | 请求方式，固定为 GET 或 POST url | String | 请求地址，根据具体接口定义 data | Object | 请求数据，根据具体接口定义

返回值

所有接口返回值均为 JSON 格式，包含以下字段：

字段名 | 类型 | 描述 ---|---|--- code | Integer | 状态码，0 表示成功，其他值表示失败 message | String | 错误信息 data | Object | 接口返回数据

使用示例

获取佣金分润报表

$data = [
    'method' => 'GET',
    'url' => '/v3/openapi/brokerage-report/query',
    'data' => [
        'start_date' => '2023-01-01',
        'end_date' => '2023-01-31',
    ],
];

$response = $this->request($data);

// 处理返回结果
$code = $response['code'];
$message = $response['message'];
$data = $response['data'];

发起支付

$data = [
    'method' => 'POST',
    'url' => '/v3/openapi/pay',
    'data' => [
        'order_id' => '202301010000000001',
        'amount' => 100,
        'pay_type' => '微信支付',
    ],
];

$response = $this->request($data);

// 处理返回结果
$code = $response['code'];
$message = $response['message'];
$data = $response['data'];

注意事项

1. 所有接口均需进行身份验证，请在请求头中添加 Authorization 字段，并使用 Bearer 认证方式。
2. 详细参数说明请参考具体接口定义文档。
3. 接口调用频率限制，请合理控制调用频率，避免影响系统稳定性。
4. 如遇问题，请及时联系技术支持。