管理后台

供派娜(PayAny)聚合支付SaaS平台用户的员工进行管理合同、商户、终端、订单、退款、争议、运单、提现、报表等。

{platform}manager

coffee with coding...

风控

通常租户可以设置自己的交易规则,如订单交易,来源设置,交易国家等等


创建数据源分类

创建一个风控的数据源分类。

请求地址:/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
merchantJson字符串商户信息
terminalJson字符串终端信息
orderJson字符串订单基础信息
productsJson字符串商品信息
billingJson字符串账单地址信息
shippingJson字符串收货地址信息
cardJson字符串卡信息
customerJson字符串顾客参数
clientJson字符串客户端信息
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文本来源
email文本邮箱
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}