管理后台
供派娜(PayAny)聚合支付SaaS平台用户的员工进行管理合同、商户、终端、订单、退款、争议、运单、提现、报表等。
{platform}为manager。
风控
通常租户可以设置自己的交易规则,如订单交易,来源设置,交易国家等等
创建数据源分类
创建一个风控的数据源分类。
请求地址:/riskdatacategory/create
请求谓词:POST
请求主体:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
name | 文本 | 50 | 是 | 名称 一般为数据源分类名称 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
数值 | 是 | 当前数据源分类的编号 |
响应示例:
{ "status":200, "message":"ok", "data":12345678, "timestamp":1218154088000}
查询数据源分类
以分页形式提供数据源分类的列表或查询结果。
请求地址:/riskdatacategory/list/{pageIndex}-{pageSize}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
pageIndex | 数值 | >=1 | 是 | 分页页码 为URL路径的一部分,非GET参数 |
pageSize | 数值 | 1~100 | 是 | 分页容量,建议20 为URL路径的一部分,非GET参数 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
pageIndex | 数值 | 是 | 分页页码 |
pageSize | 数值 | 是 | 分页容量 |
totalPageCount | 数值 | 是 | 总页数 |
totalItemCount | 数值 | 是 | 总记录数 |
items | 集合 | 是 | 对象集合,可以为空 |
items[].id | 数值 | 是 | 编号 |
items[].name | 文本 | 是 | 名称 |
items[].dateCreated | 时间 | 是 | 创建时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "pageIndex":1, "pageSize":20, "totalPageCount":123, "totalItemCount":2450, "items":[ { "id":12345678, "name":"杭州垚锋信息技术有限公司", "dateCreated":"2008-08-08T18:18:18" }, { "id":12345678, "name":"杭州垚锋信息技术有限公司", "dateCreated":"2008-08-08T18:18:18" }, .... ] }, "timestamp":1218154088000}
创建数据
以相应的数据分类为主体信息新增数据源。
请求地址:/riskdata/create
请求谓词:POST
请求主体:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
categoryId | 数值 | 是 | 分类编号 一般对应分类编号 | |
content | 文本 | 150 | 是 | 名称 一般为数据源内容 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
数值 | 是 | 当前创建数据源的编号 |
响应示例:
{ "status":200, "message":"ok", "data":12345678, "timestamp":1218154088000}
查询数据
以分页形式提供数据源的列表或查询结果。
请求地址:/riskdata/list/{pageIndex}-{pageSize}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
pageIndex | 数值 | >=1 | 是 | 分页页码 为URL路径的一部分,非GET参数 |
pageSize | 数值 | 1~100 | 是 | 分页容量,建议20 为URL路径的一部分,非GET参数 |
categoryId | 数值 | 否 | 分类编号 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
pageIndex | 数值 | 是 | 分页页码 |
pageSize | 数值 | 是 | 分页容量 |
totalPageCount | 数值 | 是 | 总页数 |
totalItemCount | 数值 | 是 | 总记录数 |
items | 集合 | 是 | 对象集合,可以为空 |
items[].id | 数值 | 是 | 编号 |
items[].categoryId | 数值 | 是 | 分类编号 |
items[].categoryName | 文本 | 是 | 分类名称 |
items[].content | 文本 | 是 | 内容 |
items[].dateCreated | 时间 | 是 | 创建时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "pageIndex":1, "pageSize":20, "totalPageCount":123, "totalItemCount":2450, "items":[ { "tenantId":123456, "id":12345678, "categoryId":2, "categoryName":"test", "content":"test", "dateCreated":"2008-08-08T18:18:18" }, { "tenantId":123456, "id":12345678, "categoryId":2, "categoryName":"test", "content":"test", "dateCreated":"2008-08-08T18:18:18" }, .... ] }, "timestamp":1218154088000}
创建分类
创建一个风控规则分类。
请求地址:/riskrulecategory/create
请求谓词:POST
请求主体:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
name | 文本 | 50 | 是 | 名称 一般为规则分类名称 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
数值 | 是 | 当前规则分类的编号 |
响应示例:
{ "status":200, "message":"ok", "data":12345678, "timestamp":1218154088000}
规则创建
以相应的规则分类为主体信息新增数据源。
请求地址:/riskrule/create
请求谓词:POST
请求主体:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
model | 对象集合 | 是 | 创建规则的对象 参考model对象说明 |
model对象说明:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
rule | 规则对象 | 是 | 参照rule对象说明 | |
conditions | 条件集合 | 是 | 参照conditions说明 | |
frequency | 频率 | 是 | 参照频率说明 |
rule对象说明:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
name | 文本 | 50 | 是 | 名称 |
priority | 数值 | 否 | 优先级 | |
categoryId | 数值 | 否 | 分类 | |
type | 数值 | 否 | 类型:(0:条件,1:频率) | |
isPre | 布尔 | 是 | 授权前 | |
isPost | 布尔 | 是 | 授权后 | |
relation | 数值 | 否 | 关系依据:(0:所有条件,1:条件的其中之一) | |
result | 数值 | 否 | 风控结果:(0:已通过/已批准,1:需要人工审核,2:需要提供身份证明文件,3:已拒绝) |
conditions说明(当rule的type值为0时 需要传入此对象或集合):
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
source | 文本 | 是 | 匹配源 | |
negation | 布尔 | 是 | 否定、反转 | |
compare | 数值 | 否 | 匹配符号:(0:等于,1:大于,2:大于等于,3:小于,4:小于等于,5:以…开头,6:以…结尾, 7:包含,8:在列表中,9:与正则表达式匹配) | |
from | 数值 | 否 | 来源 | |
target | 文本 | 是 | 匹配目标值:(0:固定值,1:其他字段,2:列表) |
frequency说明(当rule的type值为1时 需要传入此对象或集合):
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
interval | 数值 | 是 | 时间间隔(分钟) | |
source[] | 布尔 | 是 | 匹配源 | |
threshold | 数值 | 否 | 阈值 | |
negation | 布尔 | 是 | 相同:true,不同:false | |
target[] | 文本 | 是 | 目标源 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
数值 | 是 | 当前的风控编号 |
响应示例:
{ "status":200, "message":"ok", "data":12345678, "timestamp":1218154088000}
编辑规则
修改某一规则内容。
请求地址:/riskrule/update/{id}
请求谓词:POST
请求主体:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
id | 数值 | 是 | 规则编号 为URL路径的一部分,非GET参数 | |
model | 对象集合 | 是 | 修改规则的对象 参考model对象说明 |
model对象说明:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
rule | 规则对象 | 是 | 参照rule对象说明 | |
conditions | 条件集合 | 是 | 参照conditions说明 | |
frequency | 频率 | 是 | 参照频率说明 |
rule对象说明:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
name | 文本 | 50 | 是 | 名称 |
priority | 数值 | 否 | 优先级 | |
categoryId | 数值 | 否 | 分类 | |
type | 数值 | 否 | 类型:(0:条件,1:频率) | |
isPre | 布尔 | 是 | 授权前 | |
isPost | 布尔 | 是 | 授权后 | |
relation | 数值 | 否 | 关系依据 同规则创建创建 | |
result | 数值 | 否 | 风控结果 同规则创建创建 |
conditions说明(当rule的type值为0时 需要传入此对象或集合):
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
source | 文本 | 是 | 匹配源 | |
negation | 布尔 | 是 | 否定、反转 | |
compare | 数值 | 否 | 同规则创建创建 | |
from | 数值 | 否 | 来源 | |
target | 文本 | 是 | 匹配目标值 同规则创建创建 |
frequency说明(当rule的type值为1时 需要传入此对象或集合):
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
interval | 数值 | 是 | 时间间隔(分钟) | |
source[] | 布尔 | 是 | 匹配源 | |
threshold | 数值 | 否 | 阈值 | |
negation | 布尔 | 是 | 相同:true,不同:false | |
target[] | 文本 | 是 | 目标源 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
布尔 | 是 | true:编辑成功,false:编辑失败 |
响应示例:
{ "status":200, "message":"ok", "data":ture, "timestamp":1218154088000}
规则详情
以相应的规则分类为主体信息新增数据源。
请求地址:/riskrule/get{id}
请求谓词:GET
请求主体:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
id | 数值 | 是 | 规则编号 为URL路径的一部分,非GET参数 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
rule | 对象 | 是 | 规则对象 请参考返回rule对象说明 |
conditions | 对象集合 | 否 | 条件对象集合 请参考返回conditions对象集合说明 |
frequencies | 对象集合 | 否 | 频率对象集合 请参考返回frequencies对象集合说明 |
返回rule对象说明:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
id | 数值 | 是 | 商户编号 |
tenantId | 数值 | 是 | 租户编号 |
categoryId | 数值 | 是 | 分类编号 |
categoryName | 文本 | 是 | 分类名称 |
type | 数值 | 是 | 类型 同创建类型 |
name | 文本 | 是 | 名称 |
priority | 数值 | 是 | 优先级 |
relation | 数值 | 是 | 关系依据 参考创建处声明 |
result | 文本 | 是 | 风控结果 参考编辑处声明 |
dateCreated | 时间 | 是 | 创建时间 |
isPre | 布尔 | 是 | 授权前 |
isPost | 布尔 | 是 | 授权后 |
enabled | 布尔 | 是 | 是否启用 |
dateUpdated | 时间 | 否 | 最后变更时间 |
返回conditions对象集合说明:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
id | 数值 | 是 | 商户编号 |
source | 文本 | 是 | 匹配源 |
target | 文本 | 是 | 匹配目标值 |
from | 文本 | 是 | 来源 |
negation | 布尔 | 是 | 否定/反转 同创建 |
compare | 文本 | 是 | 匹配符号 同创建 |
dateCreated | 时间 | 是 | 创建时间 |
返回frequencies对象集合说明:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
id | 数值 | 是 | 商户编号 |
source | 文本 | 是 | 匹配源 |
target | 文本 | 是 | 匹配目标值 |
negation | 布尔 | 是 | 否定/反转 同创建 |
interval | 数值 | 是 | 时间间隔 |
threshold | 数值 | 是 | 阈值 |
dateCreated | 时间 | 是 | 创建时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "rule":{ "id":123345678, "tenantId":12345678, "categoryId":12345678, "categoryName":"test", "type":0, "name":"测试", "priority":1, "relation":2, "result":"Reject", "isPre":"true", "isPost":"false", "enabled":"true", "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null }, "conditions":[{ "id":12345678, "source":"test", "target":"test", "from":"test", "negation":"false", "compare":"1", "dateCreated":"2008-08-08T18:18:18" }, {...}], "frequencies":[{ "id":12345678, "source":"test", "target":"test", "interval":5, "negation":"false", "threshold":2000, "dateCreated":"2008-08-08T18:18:18" }, {...}] }, "timestamp":1218154088000}
规则查询
以分页形式提供规则分类的列表或查询结果。
请求地址:/riskrule/list/{pageIndex}-{pageSize}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
pageIndex | 数值 | >=1 | 是 | 分页页码 为URL路径的一部分,非GET参数 |
pageSize | 数值 | 1~100 | 是 | 分页容量,建议20 为URL路径的一部分,非GET参数 |
categoryId | 数值 | 否 | 分类编号 | |
name | 文本 | 否 | 名称 | |
isPre | 布尔 | 否 | 授权前 | |
isPost | 布尔 | 否 | 授权后 | |
result | 数值 | 否 | 结果 同创建 | |
enabled | 布尔 | 否 | 是否启用 | |
dateStart | 时间 yyyy-mm-dd hh:mm:ss | 否 | 起始时间,包含 如:2008-08-08 08:08:08 | |
dateEnd | 时间 yyyy-mm-dd hh:mm:ss | 否 | 截止时间,包含 如:2018-10-18 18:18:18 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
pageIndex | 数值 | 是 | 分页页码 |
pageSize | 数值 | 是 | 分页容量 |
totalPageCount | 数值 | 是 | 总页数 |
totalItemCount | 数值 | 是 | 总记录数 |
items | 集合 | 是 | 对象集合,可以为空 |
items[].id | 数值 | 是 | 商户编号 |
items[].tenantId | 数值 | 是 | 租户编号 |
items[].categoryId | 数值 | 是 | 分类编号 |
items[].categoryName | 文本 | 是 | 分类名称 |
items[].Type | 数值 | 是 | 类型 同创建 |
items[].name | 文本 | 是 | 名称 |
items[].priority | 数值 | 是 | 优先级 |
items[].relation | 数值 | 是 | 关系依据 参考创建处声明 |
items[].isPre | 布尔 | 是 | 授权前 |
items[].isPost | 布尔 | 是 | 授权后 |
items[].enabled | 布尔 | 是 | 是否启用 |
items[].dateCreated | 时间 | 是 | 创建时间 |
items[].dateUpdated | 时间 | 否 | 最后变更时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "pageIndex":1, "pageSize":20, "totalPageCount":100, "totalItemCount":1998, "items":[ { "id":123345678, "tenantId":12345678, "categoryId":12345678, "categoryName":"test", "type":0, "name":"测试", "priority":1, "relation":2, "result":"Reject", "isPre":"true", "isPost":"false", "enabled":"true", "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null }, //.... ] }, "timestamp":1218154088000}
详情
获取指定的风控订单详细信息。
请求地址:/riskorder/info/{id}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
id | 数值 | 是 | 风控订单Id 为URL路径的一部分,非GET参数 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
riskId | 数值 | 是 | 风控订单Id |
merchant | Json字符串 | 是 | 商户信息 |
terminal | Json字符串 | 是 | 终端信息 |
order | Json字符串 | 是 | 订单基础信息 |
products | Json字符串 | 是 | 商品信息 |
billing | Json字符串 | 否 | 账单地址信息 |
shipping | Json字符串 | 否 | 收货地址信息 |
card | Json字符串 | 否 | 卡信息 |
customer | Json字符串 | 否 | 顾客参数 |
client | Json字符串 | 否 | 客户端信息 |
notifyUrl | 文本 | 否 | 风控异步通知地址 |
响应示例:
{ "status":200, "message":"ok", "data":{ "riskId":123456, "merchant":Json字符串, "terminal":Json字符串, "order":Json字符串, "products":Json字符串, "billing":Json字符串, "shipping":Json字符串, "card":Json字符串, "customer":Json字符串, "client":Json字符串, "notifyUrl":"http://www.example.com/notify", }, "timestamp":1218154088000}
查询
以分页形式提供风控订单的列表或查询结果。
请求地址:/riskorder/list/{pageIndex}-{pageSize}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
pageIndex | 数值 | >=1 | 是 | 分页页码 为URL路径的一部分,非GET参数 |
pageSize | 数值 | 1~100 | 是 | 分页容量,建议20 为URL路径的一部分,非GET参数 |
riskId | 数值 | 否 | 风控订单Id | |
txnId | 数值 | 否 | 交易号 | |
source | 文本 | 否 | 来源 | |
文本 | 否 | 邮箱 | ||
cardNumber | 文本 | 否 | 卡号 | |
ipAddress | 文本 | 否 | IP地址 | |
dateStart | 时间 yyyy-mm-dd hh:mm:ss | 否 | 起始时间,包含 如:2008-08-08 08:08:08 | |
dateEnd | 时间 yyyy-mm-dd hh:mm:ss | 否 | 截止时间,包含 如:2018-10-18 18:18:18 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
pageIndex | 数值 | 是 | 分页页码 |
pageSize | 数值 | 是 | 分页容量 |
totalPageCount | 数值 | 是 | 总页数 |
totalItemCount | 数值 | 是 | 总记录数 |
items | 集合 | 是 | 对象集合,可以为空 |
items[].tenantId | 数值 | 是 | 同开发者帐号 |
items[].id | 数值 | 是 | 编号 |
items[].mode | 文本 | 是 | 模式:(1:普通,2:严格,98:关闭,99:禁用且不收录数据) |
items[].txnId | 数值 | 是 | 交易号 |
items[].email | 文本 | 是 | 邮箱 |
items[].iPAddress | 文本 | 是 | IP地址 |
items[].number | 文本 | 是 | 卡号 |
items[].source | 文本 | 是 | 来源 |
items[].analyzeRating | 数值 | 否 | 分析评分 |
items[].analyzeResult | 数值 | 是 | 分析结果:(0:已通过/已批准,1:需要人工审核,2:需要提供身份证明文件,3:已拒绝) |
items[].reviewRating | 数值 | 否 | 审核评分 |
items[].reviewResult | 数值 | 是 | 审核结果:(0:已通过/已批准,1:需要人工审核,2:需要提供身份证明文件,3:已拒绝) |
items[].isComplete | 布尔 | 是 | 是否完成 |
items[].dateCreated | 时间 | 是 | 创建时间 |
items[].dateUpdated | 时间 | 否 | 最后变更时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "pageIndex":1, "pageSize":20, "totalPageCount":123, "totalItemCount":2450, "items":[ { "tenantId":123456, "id":12345678, "mode":2, "txnId":2021041614352001, "email":"1566@qq.com", "iPAddress":"127.0.0.1", "number":"4111111111111111", "source":"example.com", "analyzeRating":5.0, "analyzeResult":1, "reviewRating":7.7, "reviewResult":0, "isComplete":1, "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null }, { "tenantId":123456, "id":12345678, "mode":2, "txnId":2021041614352001, "email":"1566@qq.com", "iPAddress":"127.0.0.1", "number":"4111111111111111", "source":"example.com", "analyzeRating":5.0, "analyzeResult":1, "reviewRating":7.7, "reviewResult":0, "isComplete":1, "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null }, .... ] }, "timestamp":1218154088000}